oscommerce Vtiger Transmission Features & User guide

Transcription

1 oscommerce Vtiger Transmission Features & User guide Copyright CRM4Ecommerce.COM A member of MelonKat Pte. Ltd. Address: 34 lane 100 Cho Kham Thien street, Dong Da, Hanoi, Vietnam Phone: support@crm4ecommerce.com Version 1.0 oscommerce Vtiger Transmission Features & User guide v1.0 Page 1 of 15

2 Table of contents 1. INTRODUCTION FEATURES ALL OSCOMMERCE DATA WILL BE TRANSMITTED INTO VTIGER CRM A SMART PRODUCT A POWERFUL, EASILY TO USE AND EFFECTIVE PRODUCT COMPATIBILITY EDITIONS COMPARISON HOW TO INSTALL? INSTALL MODULE FOR VTIGER CRM SYSTEM INSTALL MODULE FOR OSCOMMERCE SITE HOW TO USE? REGISTER SERIAL KEY TO ACTIVATE MODULE CONNECT OSCOMMERCE SITE WITH VTIGER SYSTEM CONFIG CRON JOB TRANSMISSION AND RUN DATA TRANSMISSION ON AJAX CRON JOB CONFIG TRANSMIT DATA AS SOON AS DATA UPDATED CONFIG TRANSMISSION LOG VIEW REPORTS CHANGE REPORT CHART COLOR SETUP MAIL NOTIFICATION AFTER CRON TRANSMISSION COMPLETE HOW TO SEE ONLINE DEMO? oscommerce Vtiger Transmission Features & User guide v1.0 Page 2 of 15

3 1. Introduction Have you ever heard the saying that "The success of your business depends on the way you treat your customers"? This is one of the most important truths of business. But how do you treat your customers in the right way? That's what CRM solutions are in place for. Each customer is a different individual with different likes, dislikes and behavioral patterns. Then how to report each customer has purchased how much? Who are the potential customers? Who are the strategic customers?... As a business, these are extremely important issues that you keep a tag on all this to ensure that you treat each customer in the best possible way. A good CRM solution will not only bring a professionalism in the management of customer's activities and customer care, but also gives your business the utilities which help: Increase your sales with a professional marketing tool: Support the easy creation and professional management marketing campaigns. A good tool for analysis your business activities: Make more easily to analyze the strengths, weaknesses, opportunities and threats are brought from your vendors, products, services and customers. More easily to manage your spending, cost, profits and income. And more and more excellent utilities, but it is difficult to a normal online shopping store can controll all these. Therefore, you will need a good CRM solution for your business and your online shopping store. And to reduce costs, you will need a solution to synchronize data between your store with a free CRM solution. oscommerce Vtiger Transmission is a best add-on allows synchronizing and transmitting data from online shopping stores built on oscommerce platform into Customer Relationship Management system Vtiger (Vtiger CRM). Besides the advantage utilities that provided by Vtiger CRM, combined with the superior features compared with all the same type products, such as transmit all types of data, transmit data instantly, transmit data based on plan (cron job), transmit products images, statistics by charts and save the log of statuses of data transmission, surely this would be a powerful tool to enhance effectively the controlling your business and promoting your products to customers. oscommerce Vtiger Transmission Features & User guide v1.0 Page 3 of 15

4 2. Features 2.1. All oscommerce data will be transmitted into Vtiger CRM oscommerce Vtiger Transmission allows transmitting 6 data groups with 2 forms (transmit instantly and run in cron job on a popup window using ajax technique) from oscommerce site into Vtiger CRM system. This is an excellent issue. Here are six transmitted data groups: Customer Information (will be Vtiger Accounts). Product Categories. Product Manufaceturers. Product Information, specially transmit Product Images to Vtiger System. Order Statuses. Order Information (will be Vtiger Sales Orders and Vtiger Invoices). Each edition contains two packages, one package used to install in oscommerce site, and the remaining used to install in Vtiger CRM system. Depending on the configuration of the user that data will automatically be transmitted immediately from the oscommerce site into Vtiger CRM system as soon as the data is updated or data will be transmitted simultaneously from the oscommerce via cron job A smart product Allows transmitting all data or assign specific data with specific records from id x to id y are transmitted. oscommerce Vtiger Transmission Features & User guide v1.0 Page 4 of 15

5 Allows you to config the data transmission is instant (as soon as data is created new, updated or deleted in oscommerce site) or transmit simultaneously data through ajax cron job. Specific set how of data would be transmitted through cron and specific how of data in customers, categories, manufacturers, products, order statuses, or orders would be transmitted instantly. Transmits automatically the related items of transmitted records. For example: While the system needs to transmit a product entity, however category of this product record has not yet been transmitted, the system will come back and transmit automatically this category before product is transmitted. This helps ensure integrity data in Vtiger CRM. In case data is transmitted via ajax cron job, the data will be transmitted in order from group 1 to group 6. Saves the log of data transmission process: Statistics list of transmitted records, save the state and information of the data transmission phases (which are the transmitted records, the succeed records and the un-succeed records). Allows sending mail notification to selected administrators as soon as the data transmission based on the cron is completed. Ease turn off the transmission when we needn't A powerful, easily to use and effective product Suitable for large databases: allows the transmission of the hundred thousands of records with high speed in just a few hours through a popup window using ajax technique. In the process of the transmitting data, product allows display time of data transmission periods. This idea allows users to imagine the high speed of product when data were transmitted. Allow users to statistics performance of data transmission of each group (customers, categories, manufacturers, products, order statuses and orders) through rate charts or via the data sheets Compatibility oscommerce Platform: 2.2.x x Vtiger CRM: 5.1.x x x oscommerce Vtiger Transmission Features & User guide v1.0 Page 5 of 15

6 3. Editions comparison Three main differences between the oscommerce Vtiger Transmission Professional edition and Standard edition, are the possibility transmit data as soon as data is updated, transmit all images in product images gallery and sending mail notification after data transmision in ajax cron job is complete. STANDARD PROFESSIONAL Easy installation - Overwrite only 3 files but not affect anything on your oscommerce site. No overwrite any file in Vtiger! Ensure the transmission of the hundred thousands of records are successful in a short time (a few hours). Transmit Customers Transmit Product Categories, Manufacturers & Product Entities Transmit Product's Primary Image Transmit All Images in Product's Gallery Transmit Orders, Order Statues Transmit on a new popup window using ajax technique. Transmit data instantly as soon as data is updated. Save the log of data transmission process. Allow statistics/reporting state of transmitted data by data sheet. Allow statistics/reporting state of transmitted data by chart. Send notification mail to selected administrators as soon as all transmission are finished. Easily translated into your local language Provides free translation into English and Vietnamese Free support and fix bugs 3 months forever Free updates new versions 6 months forever 4. How to install? After purchasing, your downloadable files and serial key will be sent to your . The file that you download normally is a zip file. Unzip it to a folder and you will see two zip files: oscommerce-melonkat-vtigertransmission.zip (add-on for oscommerce site) and Vtiger-Melon- oscommerce Vtiger Transmission Features & User guide v1.0 Page 6 of 15

7 Kat-VtigerTransmission.zip (module for Vtiger system). Continue unzip file oscommerce-melon- Kat-VtigerTransmission.zip Install module for Vtiger CRM system Log in your Vtiger CRM system by administrator user account. Go to Settings > Module Manager. Select tab Customer Modules. Click Import New and import package Vtiger-MelonKat-VtigerTransmission.zip into Vtiger system. Afer select package and click import module, system will redirect you to comfirm import page. Please check I accept the license agreement to system start run install module. When installation is finish, please go back to tab Customer Modules on Module Manager page. If you see module MelonKat_osCommerceTransm, that mean you installed module oscommerce Vtiger Transmission successfully in Vtiger CRM system. Figure 1: Install module successfully for Vtiger system 4.2. Install module for oscommerce site Use FTP client (like Filezilla, WinSCP, cuteftp...) to upload (copy) all folders and files in oscommerce-melonkat-vtigertransmission.zip package to your oscommerce root folder. After uploading is done, please open your oscommerce folder and edit some files: If your oscommerce version is 2.2.x, please rename admin/vtigertransmission.osc2-.2.php to admin/vtigertransmission.php. If your oscommerce version is 2.3.x please rename admin/vtigertransmission.osc2.3.php to admin/vtigertransmission.php. oscommerce Vtiger Transmission Features & User guide v1.0 Page 7 of 15

8 Create backup 3 files includes/functions/database.php, admin/includes/functions/- database.php and admin/includes/column_left.php. Open file includes/functions/database.php, go to function tep_db_query, replace (common is line 37): $result = mysql_query($query, $$link) or tep_db_error($query, mysql_errno(), mysql_error()); to define('dir_fs_admin', '{{COPY_FROM_CONST_DIR_FS_ADMIN_IN_FILE _ admin/includes/configure.php }}'); require_once DIR_FS_ADMIN. 'melonkat/lib/melonkat.php'; MelonKat::dispatcherEventBefore($query); $result = mysql_query($query, $$link) or tep_db_error($query, mysql_errno(), mysql_error()); MelonKat::dispatcherEventAfter($query, $result); Open file admin/includes/functions/database.php, go to function tep_db_query, replace (common is line 37): $result = mysql_query($query, $$link) or tep_db_error($query, mysql_errno(), mysql_error()); to require_once DIR_FS_ADMIN. 'melonkat/lib/melonkat.php'; MelonKat::dispatcherEventBefore($query); $result = mysql_query($query, $$link) or tep_db_error($query, mysql_errno(), mysql_error()); MelonKat::dispatcherEventAfter($query, $result); Open file admin/includes/column_left.php, add vtiger transmission tool box in after line include(dir_ws_boxes. 'tools.php');. If your oscommerce version is 2.2.x, please add this line require_once DIR_FS_ADMIN. 'melonkat/vtigertransmission/includes/boxes/vtigertransmission.osc2.2.php';. If your oscommerce version is 2.3.x, please add this line require_once DIR_FS_ADMIN. 'melonkat/vtigertransmission/includes/boxes/vtigertransmission.osc2.3.php';. Log in your oscommerce administration, if you see tool box VtigerTransmission is appeared, this mean you installed successfully add-on on oscommerce site. oscommerce Vtiger Transmission Features & User guide v1.0 Page 8 of 15

9 5. How to use? Note that: The following instructions are given for Professional edition. Some tasks are without in Standard, so Standard edition will be not usable them. After logged in oscommerce administration page, you will see tool box of VtigerTransmission includes tasks: Settings: Register serial key to activate module, config action scripts for module and do run ajax cron job on a popup window. Report Customers, Categories, Manufacturers, Products and Orders: Show mapping transmitted data (customers, categories, manufacturers, products, and orders) with data in Vtiger system. Statistic number transmitted records in data sheet and by pie charts. Transmission Log: Save status of data transmission sessions and allows tracking reason of failure transmission Register serial key to activate module Open VtigerTransmission > Settings. Fill your purchased serial key into Serial key field and click update. Click Register Module. If your serial key is valid, a serial key information table (includes module status, registered serial key, serial information - serial edition and number usable domains, start date and expire date) will be shown and serial information will be filled in those fields (see below figure 2). Figure 2: Register serial key 5.2. Connect oscommerce site with Vtiger system Open VtigerTransmission > Settings. oscommerce Vtiger Transmission Features & User guide v1.0 Page 9 of 15

10 Fill your Vtiger site url, vtiger user account and access key of this account into corresponding fields. Note that: Vtiger user account may be an Administrator user or not. Access Key is not user password. We can find it in function My Preferences at the top bar of Vtiger site. Please view in the below figure. To check connection information, please click Check Vtiger Connection. Figure 3: Get Vtiger Account Access Key 5.3. Config cron job transmission and run data transmission on ajax cron job Open VtigerTransmission > Settings: Select language in oscomerce site that matches with Vtiger s language. Default value is default store view of default website in oscommerce site. Open fields Queue Transmit Customers, Queue Transmit Categories, Queue Transmit Manufacturers, Queue Transmit Products, Queue Transmit Order Statuses and Queue Transmit Orders to config data will be transmitted. Click button Run Cron Data Transmission in Queue to system open a popup window to run cron by ajax technique. Note that: Cron Transmit Status will show the Data Type that is being transmitted into Vtiger. Such as: Is Transmitting Customers, Is Transmitting Categories, Is oscommerce Vtiger Transmission Features & User guide v1.0 Page 10 of 15

11 Transmitting Manufacturers, Is Transmitting Products, Is Transmitting Order Statuses or Is Transmitting Orders. oscommerce Customers will be Vtier Marketing > Accounts (and Sales > Accounts & Support > Accounts). Note that: Vtiger Customer s Address is only oscommerce Customer s Primary Address. oscommerce Orders will be Vtiger Sales > Sales Order (and Inventory > Sales Order) not is Purchase Order. Note that: oscommerce Order TAX is Vtiger Order Adjustment. Vtiger Invoice and Vtiger Order are identical. oscommerce Products will be Vtiger Inventory > Products. Note that: oscommerce Product Model is Vtiger Product No. The Queue Transmit fields (Customers, Categories, Products, Order Statuses, Orders) allow text format {{idfrom}}-{{idto}},{{size}}. Example: You input Transmit Customers is 1-20,5. Then, Ajax Cron will execute transmit Customers have id from 1 to 20 with many sessions, each session system transmits 5 customers. We shouldn t set {{size}} too big, this task can do system run failure, because in a running session, system can be timeout. When we set {{idto}} is empty (1,5 or 1-,5), this mean system will transmit all data from id {{idfrom}} to record has the largest id. Figure 4: Config Queue Data If you want trasmit all product s images into Vtiger system, please set Transmit Product with Gallery Images is Yes. In Standard edition, product only transmit primary image of product into Vtiger system. oscommerce Vtiger Transmission Features & User guide v1.0 Page 11 of 15

12 After save Queue Data, to run transmission data in queue into Vtiger system by ajax cron job, please click button Run Cron Data Transmission in Queue. Then, a popup window will be popped up and it run transmission by ajax cron. Figure 5: Run transmission by ajax cron 5.4. Config transmit data as soon as data updated This function doesn t support in Standard edition. Open VtigerTransmission > Settings. If you want transmit any type data in Customers, Categories, Manufacturers, Products, Order Statuses or Orders instantly as each object of these types is updated, you set Transmit Instantly After Save of corresponding type is Yes. Otherwise, you set it is No. With Customers: When a customer is created (registered in front-end or admin user create it in administration), or customer information is updated such as modify name, , or edit primary address data of this customer will be transmitted automatically into Vtiger system. With Products: When admin user create or modify information of a product, data of this product will be transmitted automatically into Vtiger system. When an Order is processed that a product is updated inventory stock, data of this product will be transmitted, too. oscommerce Vtiger Transmission Features & User guide v1.0 Page 12 of 15

13 With Categories, Manufacturers, Order Statuses are the same above. With Orders: When an Order is created, order data will be transmitted automatically into Vtiger system. The corresponding invoice of that order is created in Vtiger system, too Config transmission log Open VtigerTransmission > Settings. Log Mode: There are 3 options Do not Save Log, Save Log Error Transmission, and Save Log Error & Success Transmission. If you select Save Log Error Transmission, system will save only information of records that transmitting of those records are error. If you select Save Log Error & Success Transmission, system will save information of records that transmitting of those records are error and success. To view transmission log, please click VtigerTransmission > Transmission Log. Figure 6: Transmission Log You can click Clear log to delete all transmission log data View reports Product allows reporting and showing mapping transmitted data (customers, categories, manufacturers, products, and orders) with data in Vtiger system. Statistic number transmitted records in data sheet and by pie charts. oscommerce Vtiger Transmission Features & User guide v1.0 Page 13 of 15

14 Open VtigerTransmission and click one of functions Report Customers, Report Categories, Report Manufacturers, Report Products or Report Orders. Example we click Report Orders: Figure 7: Report Products Chart 5.7. Change report chart color Open Vtiger Transmission > Transmission Settings. Change colors as you want in fields Report Chart Color Transmitted and Report Chart Color Not Transmitted. Note that: These colors are hecxa code. Please click here to get colors by hecxa code. Figure 8: Changed Transmission Log Status Color 5.8. Setup mail notification after cron transmission complete This function doesn t support in Standard edition. Open VtigerTransmission > Settings: Set field Send Mail Notification After Transmit Complete is Yes. oscommerce Vtiger Transmission Features & User guide v1.0 Page 14 of 15

15 Fill Notified Address. So, after all data in transmission queue was sent into Vtiger system, an notification will be sent to selected How to see online demo? oscommerce site: Front-end: Administration: o o User Name: vtiger Password: vtiger123 Vtiger CRM system: Login by User Account: o o User Name: demo Password: demo123 Show Customers: Marketing Sales Support > Accounts Show Products: Inventory > Products Show Order: Sales Inventory > Orders Show Invoices: Sales Inventory > Invoices Show Customer Gender, Product Categories, Manufacturers, Order Statuses and Invoice Statuses: Settings > Picklist Editor THE END oscommerce Vtiger Transmission Features & User guide v1.0 Page 15 of 15