Perfex CRM

https://help.perfexcrm.com
Admin
Perfex CRM is a customer relationship management and project management software designed to help...
Tokens:108,130
Snippets:1,077
Trust Score:9.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Setup cPanel Cron Job for Perfex CRM

Source: https://help.perfexcrm.com/category/setup-and-configuration/page/3

Instructions for setting up a cron job in cPanel to automate tasks in Perfex CRM. This involves using a wget command with the CRM's cron index URL. Ensure the URL is updated to your specific domain.

```bash
wget -q -O- http://yourdomain.com/crm/cron/index
```

--------------------------------

### Install php5-cli on Debian/Ubuntu

Source: https://help.perfexcrm.com/setup-cpanel-cron-job

This command installs the php5-cli package on Debian or Ubuntu systems, which may be required for executing PHP cron jobs if the server does not support wget.

```bash
sudo apt-get install php5-cli
```

--------------------------------

### Perfex CRM .htaccess for 1&1 Installation

Source: https://help.perfexcrm.com/404-not-found-after-installation

This .htaccess configuration is specifically designed for Perfex CRM installations on 1&1 hosting. It includes adjustments for the RewriteBase and conditions to handle static assets correctly.

```apache
RewriteEngine on
RewriteBase /
RewriteCond $1 !^(index\.php|resources|robots\.txt|static) [NC]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/?$1 [L,QSA]
```

--------------------------------

### Perfex CRM .htaccess for Subdomain Installation

Source: https://help.perfexcrm.com/404-not-found-after-installation

This .htaccess configuration is suitable for Perfex CRM installations on a subdomain. It directs all relevant requests to the main index.php file, ensuring proper application functionality.

```apache
RewriteEngine on
RewriteBase /
RewriteCond $1 !^(index\.php|resources|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?/$1 [L,QSA]
AddDefaultCharset utf-8
```

--------------------------------

### Implement Example Payment Gateway in PHP

Source: https://help.perfexcrm.com/create-custom-payment-gateway

This PHP class defines a custom payment gateway named 'Example' for the Perfex CRM. It extends the App_gateway class and sets up essential configurations such as the gateway ID, name, and API credentials. The class also includes a placeholder for payment processing logic.

```php
<?php

defined('BASEPATH') or exit('No direct script access allowed');

class Example_gateway extends App_gateway
{
    public function __construct()
    {
        /**
        * Call App_gateway __construct function
        */
        parent::__construct();

        /**
         * Gateway unique id - REQUIRED
         *
         * * The ID must be alphanumeric
         * * The filename (Example_gateway.php) and the class name must contain the id as ID_gateway
         * * In this case our id is "example"
         * * Filename will be Example_gateway.php (first letter is uppercase)
         * * Class name will be Example_gateway (first letter is uppercase)
         */
        $this->setId('example');

        /**
         * REQUIRED
         * Gateway name
         */
        $this->setName('Example');

        /**
         * Add gateway settings
         * You can add other settings here to fit for your gateway requirements
         *
         * Currently only 2 field types are accepted for gateway
         *
         * 'type'=>'yes_no'
         * 'type'=>'input'
         */
        $this->setSettings(array(
            array(
                'name' => 'api_secret_key',
                'encrypted' => true,
                'label' => 'API KEY',
                'type'=>'input',
            ),
            array(
                'name' => 'api_publishable_key',
                'label' => 'SECRET KEY',
                'type'=>'input'
            ),
            array(
                'name' => 'currencies',
                'label' => 'settings_paymentmethod_currencies',
                'default_value' => 'USD,CAD'
            ),
        ));

        /**
         * REQUIRED
         * Hook gateway with other online payment modes
         */
        hooks()->add_filter('app_payment_gateways', [ $this, 'initMode' ]);
    }

    /**
     * Each time a customer click PAY NOW button on the invoice HTML area, the script will process the payment via this function.
     * You can show forms here, redirect to gateway website, redirect to Codeigniter controller etc..
     * @param  array $data - Contains the total amount to pay and the invoice information
     * @return mixed
     */
    public function process_payment($data)
    {
        var_dump($data);
        die;
    }
}
```

--------------------------------

### IIS Web.config for Perfex CRM Installation

Source: https://help.perfexcrm.com/category/general-informations/page/2

This snippet provides the web.config file content for installing Perfex CRM on an IIS server. It includes rewrite rules to handle routing for the application. Ensure this file is placed in the Perfex CRM installation directory.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="Imported Rule 1" stopProcessing="true">
                    <match url="^(.*)$" ignoreCase="false" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php/{R:1}" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>
```

--------------------------------

### Using Database Prefix with db_prefix() (PHP)

Source: https://help.perfexcrm.com/module-basics

Illustrates the use of the `db_prefix()` function to dynamically retrieve the database table prefix in Perfex CRM. This ensures module compatibility even if the default 'tbl' prefix is changed by the user. The example shows creating a table with a dynamic prefix.

```php
<?php

defined('BASEPATH') or exit('No direct script access allowed');

if (!$CI->db->table_exists(db_prefix() . 'goals')) {
    $CI->db->query('CREATE TABLE `' . db_prefix() . "goals` (
  `id` int(11) NOT NULL,
  `subject` varchar(191) NOT NULL,
  `description` text NOT NULL,
  `start_date` date NOT NULL,
  `end_date` date NOT NULL,
  `goal_type` int(11) NOT NULL,
  `contract_type` int(11) NOT NULL DEFAULT '0',
  `achievement` int(11) NOT NULL,
  `notify_when_fail` tinyint(1) NOT NULL DEFAULT '1',
  `notify_when_achieve` tinyint(1) NOT NULL DEFAULT '1',
  `notified` int(11) NOT NULL DEFAULT '0',
  `staff_id` int(11) NOT NULL DEFAULT '0'
) ENGINE=InnoDB DEFAULT CHARSET=" . $CI->db->char_set . ';');
}
```

--------------------------------

### Perfex CRM IIS Installation web.config (Subfolder/Subdomain)

Source: https://help.perfexcrm.com/installing-on-iis-windows-server

This web.config file is designed for Perfex CRM installations within a subfolder or on a subdomain of an IIS server. It uses wildcard pattern syntax for URL matching to ensure proper routing.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <system.webServer>
    <rewrite>
      <rules>
	  		<clear />
				<rule name="MainFolder" patternSyntax="Wildcard">
					<match url="*"/>
						<conditions>
							<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true"/>
								<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true"/>
						</conditions>
						<action type="Rewrite" url="index.php"/>
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																											
```

--------------------------------

### Perfex CRM IIS Installation web.config (Root with Debug)

Source: https://help.perfexcrm.com/installing-on-iis-windows-server

An alternative web.config file for Perfex CRM installations on IIS. This version includes settings for detailed error reporting and debugging, suitable for development environments.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<system.webServer>
		<asp scriptErrorSentToBrowser="true" />
		<httpErrors existingResponse="PassThrough" errorMode="Detailed"></httpErrors>
		<rewrite>
			<rules>
				<rule name="Imported Rule 1" stopProcessing="true">
					<match url="^(.*)$" ignoreCase="false" />
					<conditions logicalGrouping="MatchAll">
						<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
						<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
					</conditions>
					<action type="Rewrite" url="index.php?url={R:1}" appendQueryString="true" />
				</rule>
			</rules>
		</rewrite>
	</system.webServer>
	<system.web>
		<customErrors mode="Off"/>
		<compilation debug="true"/>
	</system.web>
</configuration>
```

--------------------------------

### Perfex CRM .htaccess for Subfolder Installation

Source: https://help.perfexcrm.com/404-not-found-after-installation

This .htaccess configuration is for Perfex CRM installations within a subfolder, especially when coexisting with other web applications like WordPress. It ensures correct routing of requests to the Perfex CRM index.php file.

```apache
RewriteEngine on
RewriteBase /foldername/
RewriteCond $1 !^(index\.php|resources|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?/$1 [L,QSA]
AddDefaultCharset utf-8
```

--------------------------------

### NGINX Configuration for Perfex CRM

Source: https://help.perfexcrm.com/category/general-informations/installation

This configuration is for installing Perfex CRM on an NGINX server. Remember to manually adjust variables like server_name and root based on your server setup. Ensure the location blocks correctly point to your Perfex CRM installation directory.

```nginx
server {
    listen 80;
    server_name your_domain.com;
    root /path/to/your/perfexcrm/installation;

    index index.php index.html index.htm;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ ".+\.php$" {
        try_files $uri =404;
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/var/run/php/php7.4-fpm.sock; # Adjust to your PHP-FPM socket
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~ /\.ht {
        deny all;
    }
}
```

--------------------------------

### IIS Web.config for Perfex CRM

Source: https://help.perfexcrm.com/category/general-informations/installation

This web.config file is used for installing Perfex CRM on an IIS server. Place this file in the root directory of your Perfex CRM installation. It handles URL rewriting to ensure the application functions correctly.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="Imported Rule 1" stopProcessing="true">
                    <match url="^(.*)$" ignoreCase="false" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php?/$1" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>
```

--------------------------------

### Perfex CRM Module Init File Header Example (PHP)

Source: https://help.perfexcrm.com/module-file-headers

This PHP code snippet demonstrates the standard header format for a Perfex CRM module's init file. It includes essential meta-information like Module Name, Description, Version, and required Perfex CRM version. This structure is crucial for the CRM to recognize and manage modules correctly.

```php
<?php

defined('BASEPATH') or exit('No direct script access allowed');

/*
Module Name: Menu Setup
Description: Default module to apply changes to the menus
Version: 2.3.0
Requires at least: 2.3.*
*/

```

--------------------------------

### PHP: Perfex CRM Payment Gateway Library Example

Source: https://help.perfexcrm.com/module-as-payment-gateway

This PHP code defines a sample payment gateway library for Perfex CRM, extending the App_gateway class. It includes constructor logic for setting the gateway ID, name, and configuration settings like API keys and supported currencies. The process_payment method is a placeholder for handling payment transactions.

```php
<?php

defined('BASEPATH') or exit('No direct script access allowed');

class Example_gateway extends App_gateway
{
    public function __construct()
    {
        /**
         * Call App_gateway __construct function
         */
        parent::__construct();

        /**
         * Gateway unique id - REQUIRED
         *
         * * The ID must be alphanumeric
         * * The filename (Example_gateway.php) and the class name must contain the id as ID_gateway
         * * In this case our id is "example"
         * * Filename will be Example_gateway.php (first letter is uppercase)
         * * Class name will be Example_gateway (first letter is uppercase)
         */
        $this->setId('example');

        /**
         * REQUIRED
         * Gateway name
         */
        $this->setName('Example');

        /**
         * Add gateway settings
         * You can add other settings here 
         * to fit for your gateway requirements
         *
         * Currently only 3 field types are accepted for gateway
         *
         * 'type'=>'yes_no'
         * 'type'=>'input'
         * 'type'=>'textarea'
         *
         */
        $this->setSettings(array(
            array(
                'name' => 'api_secret_key',
                'encrypted' => true,
                'label' => 'API KEY',
                'type'=>'input',
            ),
            array(
                'name' => 'api_publishable_key',
                'label' => 'SECRET KEY',
                'type'=>'input'
            ),
            array(
                'name' => 'currencies',
                'label' => 'settings_paymentmethod_currencies',
                'default_value' => 'USD,CAD'
            ),
        ));

    }

    /**
     * Each time a customer click PAY NOW button on the invoice HTML area, the script will process the payment via this function.
     * You can show forms here, redirect to gateway website, redirect to Codeigniter controller etc..
     * @param  array $data - Contains the total amount to pay and the invoice information
     * @return mixed
     */
    public function process_payment($data)
    {
        var_dump($data);
        die;
    }
}

```

--------------------------------

### Access CodeIgniter Instance in Module Files (PHP)

Source: https://help.perfexcrm.com/module-basics

Demonstrates how to obtain and use the CodeIgniter framework instance within module files that do not extend base classes. This allows access to CodeIgniter's functionalities like loading helpers and libraries.

```php
$CI = &get_instance();

$CI->load->helper('module_name/helper_name');
$CI->load->library('module_name/library_name');
```

--------------------------------

### Perfex CRM Date Format Options

Source: https://help.perfexcrm.com/category/setup-and-configuration/page/3

Lists the available date format options for configuring the system's date display in Perfex CRM. These formats are used throughout the application, including the customer area.

```text
d-m-Y
d/m/Y
m-d-Y
m.d.Y
m/d/Y
Y-m-d
d.m.Y
```

--------------------------------

### Customize PDF Text and Content with TCPDF Library

Source: https://help.perfexcrm.com/pdf-customization

Perfex CRM uses the TCPDF library to generate PDF documents. This snippet highlights the library's role and provides links to its documentation and examples. Customization requires PHP knowledge.

```php
// Example of using TCPDF (actual implementation depends on context)
// require_once('tcpdf/tcpdf.php');
// $pdf = new TCPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
// ... PDF generation code ...
```

--------------------------------

### Add Image to Ticket Form - PHP

Source: https://help.perfexcrm.com/setup-ticket-form

This snippet demonstrates how to add a custom image to the start of the ticket form in Perfex CRM. It utilizes the `ticket_form_start` action hook and requires a PHP environment. Ensure the image URL is correctly set.

```php
<?php
hooks()->add_action('ticket_form_start','my_ticket_form_start');

function my_ticket_form_start(){
    echo '<img src="https://yourwebsite.com/logo.jpg">';
}
```

--------------------------------

### PHP Language File Structure and Translation Example

Source: https://help.perfexcrm.com/system-language

Demonstrates the structure of a PHP language file in Perfex CRM and how to translate strings, including handling single quotes.

```php
$lang['language_text_key'] = 'Text with \'quotes';
```
Tokens:
Raw