opencart vtiger integration

OpenCart VtigerCRM Installation Guide Version 1.0

OpenCart

Installation

Guide

Version 1.0By

Lim Tee Chert

26 February 2012(last updated on: 27 September 2012)

Powered By @anterp.com 2012 Email:[email protected]

mailto:[email protected]


Purpose :

This is A Release for OpenCart Vtiger Integration.

The purpose of this OpenCart Vtiger Integration is to provide data synchronization between Customers, Contacts, Product Categories, Manufacturer Categories, Products, Stock Status, Sales Order/Invoice.

Compatible:

No Software Version

1. Opencart 1.5.1.x / 1.5.2.x / 1.5.3.x / 1.5.4.x

2. Vtiger 5.2.1 / 5.3.0 / 5.4.0

DISCLAIMER:

USE AT YOUR OWN RISK. WE DO NOT ISSUED ANY WARRANTY FOR THIS PLUGIN. THE LICENSE IS GRANTED FOR SINGLE DOMAIN ONLY. IF YOU NEED TO DEPLOYED IN

SECOND DOMAIN, YOU NEED TO BUY ANOTHER LICENSE FROM US.

Please follow the step below for your installation. We assume that you already have existing OpenCart and Vtiger, please follow the step below for your installation process.

Installation Notes: 1. Please make a backup before executing this step.2. Extract OpenCart Vtiger Integration package.3. You are safe to deploy our Data Sync Suites WITHOUT overwritten any files. We are using

VQMod for Opencart 1.5.1.x and above. Please follow the step below to install VQMod and VQMod Manager.

1) VQModhttp://code.google.com/p/vqmod/wiki/Install_OpenCart

2) VQMod Managerhttp://www.opencart.com/index.php?route=extension/extension/info&extension_id=2969



http://www.opencart.com/index.php?route=extension/extension/info&extension_id=2969

http://code.google.com/p/vqmod/wiki/Install_OpenCart


OpenCart Data Sync Suites Setting

1) Setting for PHP System TimeZone (Example: Malaysia TimeZone)

vi /etc/php.ini ---------------------------------------------------------------------- ;Added by tclim date.timezone=Asia/Kuala_Lumpur ----------------------------------------------------------------------

2) Setting for Start Up TimeZone

vi system/startup.php ----------------------------------------------------------------------

if (!ini_get('date.timezone')) { date_default_timezone_set('Asia/Kuala_Lumpur');

}----------------------------------------------------------------------

3) Execute the database script patches/sync_opencart_vtiger.sql

Pr-requisite

Before we perform data synchronization, we need to configure the Currency and MUST be the same format. For example, the currency as below:

1) Login to OpenCart using admin2) Click the System -> Setting -> Local

3) Click “Save” button to save the setting




Opencart Vtiger Manual Configuration Settings

1) Tax Calculations

Our Data Sync Suites does not directly support Taxation. You need to manually configure your Opencart and Vtiger Tax Calculations.

In Opencart - System -> Localisation -> Tax Class

In Vtiger – Setting -> Tax Calculations

Note: Shipping & Handling Taxes need to be configure with according to Product & Service Taxes.




2) Product Usage Unit

In Opencart - System -> Localisation -> Weight Class

In Vtiger - Settings -> Picklist Editor -> Products -> Usage Unit




How to Setup Default Custom Fields Setting In Vtiger

Sales Invoice Custom Fields are supported in Vtiger. Please follow the step below to defined vtiger custom fields for Product Attributes

- Login to vtiger- Goto “Settings” -> “Module Manager” -> “Invoice”

– Click on the “hammer” icon

– Click on “Layout Editor”– Under the Product Details, click on “Add Custom Field”

– In “Create Custom Field”, scroll down under you see the “Text Area”.– Label: Product Attributes and click “Save” button.




Please follow the step below to defined vtiger Accounts / Organization custom fields for Opencart Customer ID

- Login to vtiger- Goto “Settings” -> “Module Manager” -> “Accounts / Organization”


– Click on “Layout Editor”– Under the Account Information, click on “Add Custom Field”

– In “Create Custom Field”, scroll down under you see the “Text”.– Label: Opencart Customer ID.– Length: 11 and click “Save” button.




Please follow the step below to defined vtiger Contacts custom fields for Opencart Contact ID

- Login to vtiger- Goto “Settings” -> “Module Manager” -> “Contact”


– Click on “Layout Editor”– Under the Contact Information, click on “Add Custom Field”

– In “Create Custom Field”, scroll down under you see the “Text”.– Label: Opencart Contact ID.– Length: 11 and click “Save” button.




Please follow the step below to defined vtiger Products custom fields for Opencart Product ID

- Login to vtiger- Goto “Settings” -> “Module Manager” -> “Product”


– Click on “Layout Editor”– Under the Product Information, click on “Add Custom Field”

– In “Create Custom Field”, scroll down under you see the “Text”.– Label: Opencart Product ID.– Length: 11 and click “Save” button.




How to Configure Vtiger In OpenCart

1) Login to OpenCart using admin2) Click the Extensions -> Modules

3) Click “Install” to setup “Vtiger Data Sync Suites”4) Click “Edit” to configure Vtiger Data Sync Suites

Fill in all requires fields marked as *. Make sure you activate this modules.

Title Value DescriptionEnabled Sync Status 1 = Enabled Sync Process

0 = Disabled Sync Process (Turn Off)Always set to 1 to enabled the sync process

Is Debugging Mode 1 = Yes0 = No

set to 1 for Debugging Modeset to 0 for Production Mode

Auto Assigned User 1 = Yes0 = No

Always set to 1 to assign the sync transaction under the User ID

Vtiger URL http://www.example.com/vtiger/webservice.php Vtiger URL.For security, please use https://All URL must be ended with webservice.php

User ID admin User ID must be exist in Vtiger

Access Key vtiger access key Vtiger Access Key

Sync SalesOrder/Invoice when status is

1 = Pending2 = Processing3 = Delivered4 = PayPal [Transaction]

Ticked the Status to be Sync into Vtiger for Invoice transaction.

Please choose your Delivered/Completed status

1 = Pending2 = Processing3 = Delivered4 = PayPal [Transaction]

Choose the Status to be Sync back to Opencart for Delivered/Completed transaction.(Not Implemented Yet)

NOTE: Goto System -> Localisation -> Orders Statuses

Sync Process are highly depended on Orders Status. Please defined your Orders Status before configure Data Sync Suites Settings.




How to configure Vtiger Data Sync Suites In Opencart




Note: After click on “Load Parameters Data”, you need to “Refresh” the page again to populate all the combobox value for your selection.




Go back to “How to configure Vtiger Data Sync Suites In Opencart”

Click on “Load Parameters Data” again to refresh the new changes. You can now configure Default Settings for Vtiger Custom Fields Setting.




How to configure Cronjob

1) Setting for Batch Process. Change the user path to your own path

1.1) First, change it to executable file chmod +x batch.sh

Using Linux SSH

Add this line to crontab to Sync Data from OpenCart To Vtiger for every 5 minutes

vi batch.sh ------------------------------------------------------------------------------------------------- #!/bin/sh umask 002 cd /home/userid/public_html/opencart /usr/bin/php -q sync-opencart-vtiger.php -------------------------------------------------------------------------------------------------

su - crontab -e ------------------------------------------------------------------------------------------------- */5 * * * * /home/userid/public_html/opencart/batch.sh /dev/null 2>&1 -------------------------------------------------------------------------------------------------




1.2) Second, change the path according to your directory structure Using cPanel

-------------------------------------------------------------------------------------------------------------- /usr/bin/php -q /home/userid/public_html/opencart/sync-opencart-vtiger.php /dev/null 2>&1--------------------------------------------------------------------------------------------------------------




How to Sync Currency to Vtiger

In Opencart, click on any Currency from the list, you need to update each of the currency and it will automatically sync to Vtiger.

In Opencart – Currency

In Vtiger – Settings -> Currencies




How to Sync Manufacturer Categories to Vtiger

In Opencart, click on any manufacturer category from the list, you need to update each of the category and it will automatically sync to Vtiger.

In Opencart – Manufacturer Category

In Vtiger – Settings -> Picklist Editor -> Product




How to Sync Category to Vtiger

In Opencart, click on any category from the list, you need to update each of the category and it will automatically sync to Vtiger.

In Opencart - Category

In Vtiger – Settings -> Picklist Editor -> Product -> Category




How to Sync Products to Vtiger as Product

In Opencart, click on any product from the list, you need to update each of the product and it will automatically sync to Vtiger.

In Opencart – Products

In Vtiger – Inventory -> Products




How to Sync Customer to Vtiger as Accounts

In Opencart, when the customer sign up or edit their profile, it will automatically sync to Vtiger.

In Opencart – Customer




In Vtiger – Accounts




How to Sync Vtiger Stock Status

In Opencart – Stock Status




In Vtiger -> Inventory -> Products




How to Sync Sales Order/Invoice to Vtiger as Sales Invoice

In Opencart, when the customer checkout, the Sales Order/Invoice will be created. The Cronjob will executed every 5 minutes (Depending on your setting). The Sales Order/Invoice will automatically sync to Vtiger.

The customer can checkout in any currency and it will automatically converted into Home Currency in Vtiger. For example, customer order in item no 10 are using GBP when checkout. The total sales amount (£578.79) will be reflected in Vtiger as ($915.522) in USD.

In Opencart – Sales Order

In Vtiger – Sales Invoice




Sync Opencart Coupon as Discount in VtigerSync Opencart Gift as Adjustment in VtigerSync Opencart Product Attribute as Product Attribute in Vtiger

In Opencart

In Vtiger




Support

Support for installation and troubleshooting is available via support email at [email protected]




opencart vtiger integration

Documents