Configuration

Set up Vtiger account

Go to https://www.vtiger.com/log-in/ to login ( if you had an existing Vtiger account) or register new one.

Getting Vtiger Access Key

Scroll to bottom of the page, you can see the Access Key in User Advanced Options

Back End 

Go to the Vtiger CRM tab, then the Vtiger CRM menu will be shown. 

There are 4 sub-tabs that admins need to consider:

 Configuration

To start using the extension, admins need to set some configurations by navigating to  Vtiger CRM > Configuration.

Expand the VtigerCRM Information section, there are three fields will be shown.

 Username: Your Vtiger username.

 URL: Please follow the format of your_vtiger_site/webservice.php

 Access Key: Used the access key which saved in the previous step to enter this field. 

 Check Connect VtigerCRM: After filling in some information mentioned above, please click on the Save Config and Check Connect VtigerCRM button to make sure that these information entered is correctly. 

Expand the Synchronization Settings section, there are seven sub-sections will be shown:

Expand the sub-section named Sync Account, there are two fileds (in the first time).

 Enable: Yes/No.

 Sync Mode: There are two options to choose:

• Immediately: The extension will sync all of account from the Magento 2 site to the Vtiger CRM account immediately. 
  
  

• Cron Job: Admin will set a period of time to sync data.

Example: When admin set 5 times at the Time field, that means the data of account will be synced from the Magento 2 site to the Vitger CRM account after 5 minutes automatically.

It is the same to other sub-sections, include:

  Contact.

 Subscriber.

 Lead.

 Products.

 Orders.

 Invoices.

 Setting Up Field Mapping

In order to synchronize data fields from Magento 2 store to your Vtiger CRM account correctly, you need to create the mapping for these fields first.  

Go to Vtiger Integration > Field Mapping

The module enables a grid table to manage mapping fields between Magento 2 and Vtiger CRM. You can choose which data fields you want to sync from Magento 2 to Vtiger CRM account. 

From the manage mapping, you can export, change the status with enable and disable options, edit or delete a mapping. 

In order to create a new mapping, please click on the Add New Mapping button

Fill in mapping information: 

• Type: select data type: Leads, Contacts, Accounts, SalesOrders, Invoices, Products, Campaigns.

• Description: describe data information 

• Magento field: select Magento data field from dropdown list which you want to synchronize.  

• Vtiger field: select Vtiger field from dropdown list which you want to store data in.  

• Status: select Enabled/Disabled.

Remember to click Save Mapping to store information. 

Process Synchronization  

If the App mode is Cron Job, Queue page is the place which the created, updated data is stored in and are waiting to be synced. If you wish to sync data right away, you can press Sync Now button. 

When the process is done, go to Vtiger Integration > View Report to check what is synced in the grid.

• If the data is synced right, the Status will be success and the Message will be "OK"
• If there's a problem during syncing process, the Status will be error and the Message tab will show the error message like the record below. 

Moreover, admin can easily check the synchronization with View Request Daily button and View On Vtiger button. 

Navigate to Vtiger Integration > Request Daily Report, admins can easily follow their synchronization status.  

Data Integration Settings

Click on VtigerIntegration > Field Mapping.You can define field mappings between Magento and VtigerCRM easily.

To add a new mapping, click on Add button, Add New Mapping page will show up

• Type: Choose table you want to map

• Vtiger Field: Choose Vtiger Field

• Magento Field: Choose corresponding Magento Field

• Status: Inactive or active

• Description: Describe your mapping

Hit Save when done, your mapping is ready for the next sync.

Main Functions

• When a new account is registered in Magento 2, Vtiger will automatically add a new record of this account in Leads, Organizations, Contacts.

• When a customer adds items to cart then check out, Sales Orders in Vtiger will be auto synced.

• When an invoice is made by admin in Magento 2, Invoice in Vtiger will be synced.

• When admin add a new product in Magento 2, Vtiger will auto sync data about that product.

•  When admin edits a customer account/product in Magento 2, that customer/product will also be changed from Leads, Organizations and Contacts, products in Vtiger.