B2B CRM Application Deployment
To deploy the B2B CRM application, complete the following steps:
- Install the B2B CRM application.
- (optional) Deploy the demodata.
To install the B2B CRM application for the first time, use the full version pack. To update the application from the previous versions, use the update packages.
Note that different B2B CRM versions are compatible with different platform versions. If required, update the platform version, otherwise the B2B CRM application will not work correctly.
Deploy full version
Role required: admin.
To install the B2B CRM application to your instance from scratch, complete the following steps:
- Versions 1.0.0, 1.1.0, 1.2.0
- Further versions
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_0_0_full.sop package.
- Import the JSON file with the demo data and master data [CRM]_1_0_0_demo_data.json.
- (optional) Install the package with the demo data [CRM]_1_0_0_demo_data.sop.
The numbers in the file titles may be different from the ones mentioned in the instruction depending on the installed version.
Required platform version
| B2B CRM version | Compatible platform versions |
|---|---|
| 1.2.1, 1.2.2, 1.3.0, 1.3.1, 1.3.2 | 1.18.1 – 1.22.3 (inclusively) |
| 1.4.0, 1.4.1, 1.5.0, 1.5.1, 1.5.2 | 1.18.1 – 1.23.3 (inclusively) |
| 1.5.3, 1.5.4 | 1.24.2 and above |
| 1.5.5, 1.6.0 | 1.25.0 and above |
| 1.6.2, 1.6.3 | 1.28.0 |
| 1.6.4, 1.7.0, 1.7.1, 1.8.0, 1.9.0 | 1.28.2 and above |
Starting from the 1.2.1 version, the master data and demo data are included in separate files.
- Install the [CRM]_1_2_1_full.sop package.
- Import the JSON file with the master data [CRM]_1_2_1_master_data.json.
- (optional) Import the JSON file with the demo data [CRM]_1_2_1_demo_data.json.
- (optional) Install the package with the demo data [CRM]_1_2_1_demo_data.sop.
The numbers in the file titles may be different from the ones mentioned in the instruction depending on the installed version.
Install updates
Role required: admin.
Install all versions and patches in their release order.
Example:
To update the application from version 1.1.0 to 1.5.5, sequentially install the update packages in the following order: 1.2.0, 1.2.1, 1.2.2, 1.3.0, 1.3.1 and so on until 1.5.5. Always follow the version deployment instructions.
Demonstration data features:
- the demo data pack installed remains on your instance even after the application update.
- install new demo data packs over the existing demo records. The records will be updated.
- 1.9.0
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.0
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.1
- 1.4.0
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.0
Update version 1.8.0 to version 1.9.0
Required platform version: 1.28.2 and above.
- Install the [CRM]_1_9_0.sop package.
- Navigate to System Settings → Server Scripts and open the Change partner to agreement in lead script located at the
{your instance URL}/record/sys_script/176493369113213667address and click Run. The script completes the Partnership application field on the forms of Leads (crm_leads) in the New, Assigned, and Qualified states if Partner is specified, according to the following logic: - If the partner company has only one partnership agreement, it is used as the value.
- If the partner company has more than one partnership agreement, the system selects the agreement whose Partnership program includes the Service/Product specified in the lead.
- If there is more than one such agreement, an agreement for the Partner level with higher Level weight is selected.
- If there is more than one such agreement for levels with identical weight, the latest created agreement is selected.
If the script fails to complete the Partnership application field in some records, you will see a toast message with their list.
-
(optional) If you use the DaData integration, navigate to System Settings → Server Scripts. Open the forms of the server scripts described below and Run them in the same order as in the table:
Order Name Record ID Description 1 Update customer companies by TIN 175948892401699909 The script finds records of the Customer Company (crm_customer_company) table with the completed TIN field. A DaData request is triggered for each such record. After that, empty fields of the External Data tab on the Customer Company form are completed with the data received if they are present in the DaData. 2 Update customer company if inn is empty 175930707205723828 The script finds records of the Customer Company (crm_customer_company) table with the empty TIN field. If the Main contact is specified for a record, the Email of this contact is used for search in DaData. If the main contact is not specified or has no email specified, the emails of other contacts in which the current company is specified are used for search. - If a company with such an email is found, its TIN is specified on the company form on your instance, and the script moves to the next company.
- If no company with such an email is found, the script proceeds to check the email address of the next contact in which this company is specified. It continues until a match is found in DaData or all the contacts are checked.
3 Update customer contact if empty company 175947498701784863 The script finds records of the Customer Contact (crm_customer_contact) table with the empty Company field. For each such record, a request to DaData is sent using their Email. If a company with matching email is found, and there is a record in the Customer Company (crm_customer_company) table or its child table on your instance that has the same TIN as the company found by the script, the Company field of the contact is completed with this record. If such a company is not found in DaData or on your instance, the contact remains unchanged. -
(optional) If you use the Ainergy integration for adding widgets to the Lead (crm_leads) form, open the server script record Add Ain Call and Smart Filling to Leads located at the
{your instance URL}/record/sys_script/175429644308553855address and click Run. This script adds Ainergy widgets to the Lead form. -
(optional) If you use the Ainergy integration for content generation, install the [CRM]_CRM_1_9_0_AIN_1_12_0.sop package with the prompts required for the work of the integration.
Update version 1.7.1 to version 1.8.0
Required platform version: 1.28.2 and above.
- Install the [CRM]_1_8_0.sop package.
In this version, we updated the demo data. Its installation is optional. If you already have the demo data from the previous version installed, skip step 1. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_8_0_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
If you use the Ainergy application on your instance, after the installation of the new B2B CRM version you can activate the integration between the applications.
Ainergy integration: widgets for Leads
Required Ainergy version: 1.11.1. If the integration is used with the versions in which the state of the AIN Call and Smart Filling widgets is different from the one in this version, errors might occur.
You can add the AIN Call and Smart Filling widgets to the Lead (crm_lead) form. To do so, open the server script record Add Ain Call and Smart Filling to Leads located at the {your instance URL}/record/sys_script/175429644308553855 address and click Run.
Ainergy integration: automatic generation of content
Required Ainergy version: 1.12.0 and above.
In this version, we added the ability to generate values for the application form fields automatically using AI according to prompts. To configure the automatic generation on your instance, complete the following steps:
- Install the [CRM]_CRM_1_8_0_AIN_1_12_0.sop package with the prompts required for the work of the integration.
- In the Admin preferences, switch to the CRM application.
- Navigate to CRM → Settings → CRM Property.
- Find the crm.ain.ai_enable system property and set its value to true to display the UI actions for data generation on the application forms.
- (optional) Configure other properties of the B2B CRM-Ainergy integration:
- crm.record_processing.ttl – specify the maximum time in seconds to expect a response from Ainergy when the integration is used. When this period is exceeded, the process is completed with an error.
- crm.record_processing.polling_timeout – specify a period between requests to the event expecting the completion of the record processing when the B2B CRM-Ainergy integration is used. The value is set in seconds.
Update version 1.7.0 to version 1.7.1
Required platform version: 1.28.2 and above.
- Install the [CRM]_1_7_1.sop package.
- Import the JSON file with the master data [CRM]_1_7_1_master_data.json.
- (optional) In this version, we implemented the B2B CRM-Ainergy integration. If you have Ainergy installed on your instance, after the installation of the new B2B CRM version open the server script record Add Ain Call and Smart Filling to Leads located at the
\{your instance URL}/record/sys_script/175429644308553855address and click Run. This script adds Ainergy widgets to the Lead form.
The integration has been developed based on the Ainergy 1.11.1 version. If the integration is used with the versions in which the state of the AIN Call and Smart Filling widgets is different from the one in this version, errors might occur.
Update version 1.6.4 to version 1.7.0
Required platform version: 1.28.2 and above.
- Install the [CRM]_1_7_0.sop package.
- Import the JSON file with the master data [CRM]_1_7_0_master_data.json.
In this version, we updated the demo data. Its installation is optional. If you already have the demo data from the previous version installed, skip step 1. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_7_0_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
Update version 1.6.3 to version 1.6.4
Required platform version: 1.28.2 and above.
- Install the [CRM]_1_6_4_migration.sop package that contains the data migration script.
- Run the Migration for crm_partner_supervisor script located at the
{your instance URL}/record/sys_script/174530590118661660address. This is required due to the deletion of the crm_partner_supervisor role: the script selects the new Show all opportunities of the partner checkbox in the contacts related to the employee accounts that have the crm_partner_supervisor role. - Install the [CRM]_1_6_4.sop package.
In this version, we updated the demo data. Its installation is optional. If you already have the demo data from the previous version installed, skip step 1. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_6_4_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
Update version 1.6.2 to version 1.6.3
Required platform version: 1.28.0.
- Install the [CRM]_1_6_3.sop package.
Update version 1.6.0 to version 1.6.2
Required platform version: 1.28.0.
- Install the [CRM]_1_6_2.sop package.
In this version, we updated the demo data. Its installation is optional. If you already have the demo data from the previous version installed, skip step 1. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_6_1_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
Update version 1.5.5 to version 1.6.0
Required platform version: 1.25.0 and above.
- Install the [CRM]_1_6_0.sop package.
- Import the JSON file with the master data [CRM]_1_6_0_master_data.json.
In this version, we updated the demo data. Its installation is optional. If you already have the demo data from the previous version installed, skip step 1. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_6_0_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
Update version 1.5.4 to version 1.5.5
Required platform version: 1.25.0 and above. The compatibility is motivated by the exclusion of ability to use JSON injections in the ACL.
- Install the [CRM]_1_5_5.sop package.
In this version, we updated the demo data. The installation of the demo data is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_5_5_demo_data.json.
- Import the package with the demo data [CRM]_1_5_5_demo_data.sop.
Update version 1.5.3 to version 1.5.4
Required platform version: 1.24.2 and above.
- Install the [CRM]_1_5_4.sop package.
- Import the JSON file with the master data [CRM]_1_5_3_master_data.json.
In this version, we updated the demo data. Its installation is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_5_4_demo_data.json.
- Import the package with the demo data [CRM]_1_5_4_demo_data.sop.
Update version 1.5.2 to version 1.5.3
Required platform version: 1.24.2 and above. The compatibility is motivated by the appearance of the new WYSIWYG field type.
- Install the [CRM]_1_5_3.sop package.
- Import the JSON file with the master data [CRM]_1_5_3_master_data.json.
In this version, we updated the demo data. Its installation is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_5_3_demo_data.json.
- Import the package with the demo data [CRM]_1_5_3_demo_data.sop.
Update version 1.5.1 to version 1.5.2
Required platform version: 1.18.1 – 1.23.3 (inclusively).
- Install the [CRM]_1_5_2.sop package.
Update version 1.5.0 to version 1.5.1
Required platform version: 1.18.1 – 1.23.3 (inclusively).
- Install the [CRM]_1_5_1.sop package.
Update version 1.4.1 to version 1.5.0
Required platform version: 1.18.1 – 1.23.3 (inclusively).
- Install the [CRM]_1_5_0.sop package.
In this version, we updated the demo data. Its installation is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_5_0_demo_data.json.
- Import the package with the demo data [CRM]_1_5_0_demo_data.sop.
Update version 1.4.0 to version 1.4.1
Required platform version: 1.18.1 – 1.23.3 (inclusively).
- Install the [CRM]_1_4_1.sop package.
Update version 1.3.2 to version 1.4.0
Required platform version: 1.18.1 – 1.23.3 (inclusively). The compatibility with the 1.23.3 version is motivated by making the widgets work independent from requesting the s_form context from the parent form to the child form.
- Install the [CRM]_1_4_0.sop package.
Update version 1.3.1 to version 1.3.2
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_3_2.sop package.
Update version 1.3.0 to version 1.3.1
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_3_1.sop package.
Update version 1.2.2 to version 1.3.0
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_3_0.sop package.
In this version, we updated the demo data. Its installation is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_3_0_demo_data.json.
- Import the package with the demo data [CRM]_1_3_0_demo_data.sop.
Update version 1.2.1 to version 1.2.2
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_2_2.sop package.
Update version 1.2.0 to version 1.2.1
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_2_1.sop package.
- Import the JSON file with the master data [CRM]_1_2_1_master_data.json.
In this version, we split the demo data with the master data into separate files. The installation of the demo data is optional. To install the demo data, complete the following steps:
- Import the JSON file with the demo data [CRM]_1_2_1_demo_data.json.
- Import the package with the demo data [CRM]_1_2_1_demo_data.sop.
Update version 1.1.0 to version 1.2.0
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_2_0.sop package.
Update version 1.0.0 to version 1.1.0
Required platform version: 1.18.1 – 1.22.3 (inclusively).
- Install the [CRM]_1_1_0.sop package.