Openbravo ERP Magento. Installation Guide

Transcription

1 Openbravo ERP Magento Installation Guide Version th of December 2010

2 Copyright 2010, Transitional Data Services, All Rights Reserved No part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical, for any purpose without the express written permission of Transitional Data Services. Information in this document is subject to change without prior notice. Certain names of program products and company names used in this document might be registered trademarks or trademarks owned by other entities. Openbravo ERP is trademark of Openbravo. Magento is a trademark of Irubin Consulting Inc. DBA Varien Transitional Data Services 92 South Street Hopkinton Massachusetts U.S.A. For Sales and Technical Support (US and Canada): Tel: +1 (877) (508) Fax: +1 (508) info@transitionaldata.com Online purchase:

3 Table of Contents Openbravo ERP Magento...1 Installation Guide Overview Installation of TDS Module Installation of TDS Magento Modules Create Role Create User Execute updateproductsyncset.sql script Set up of magento.properties file Running Synchronization Alert recipients Logging system...19

4 1 Overview This document describes step by step the installation process of the Openbravo ERP Magento integration system. The installation process requires to install two additional modules, one on the Openbravo ERP and the other one on the Magento side and to configure settings required by those modules. The integration system synchronizes customers, products and sales order from Magento into Openbravo ERP. Each synchronization process can be scheduled by time and frequency to be executed. It is assumed that Openbravo ERP 2.50 MP21 or above and Magento are already properly installed and the Openbravo ERP Magento instegration will be installed on the top of them.

5 2 Installation of TDS Module Note: if you have already installed the TDS module from Openbravo repository, you can go directly to the point 3 In this step TDS module will be installed on the top of Openbravo. Log in to Openbravo as a System Administrator Go to General Setup Application Module Management Add Modules Search for TDS Module and select to install Follow the installation process Select to rebuild the system The module is installed and this should look like:

6 3 Installation of TDS Magento Modules The TDS Magento modules are distributed within TDS module that was installed in the previous point. Go to the server directory where you installed Openbravo. The module can be found in <serverdirectory>/webapps/openbravo/web-inf/magento Execute the installer magento-linux-installer.bin and follow the instruction on the screen. The installer deploys the TDS Magento modules automatically and a user only needs to specify the path to the Magento directory Go to the admin panel of Magento and then to System Configuration Advanced Advanced and press on Disable modules output to roll out the data. If everything was correct in the previous steps the new installed modules Tds_Tdscatalog, Tds_Tdscustomer, Tds_Tdssales should be there as is on the image: Note: if you do not see the installed modules check if the modules were properly deployed in the Magento's directory: <magentodirectory>/app/code/local/tds and you should be able to see the new modules: Tdscatalog, Tdscustomer and Tdssales. If the modules are not present, you should repeat the installation process and specify the correct directory. If the modules are present, it is needed to flush the Magento cache memory. To do it, you should go to System Cache Management Flush Magento Cache in the admin panel. Then just refresh the main page of Magento

7 4 Create Role In Magento there is a need to specify a role that has access to web services. To create a new role follow the steps in the admin panel: Go to System Web Services Roles Click on Add new role and specify a name for a new role In the Role Resources select All Save it

8 5 Create User In Magento there is a need to specify a user that has access to web services. To create a new user follow the steps in the admin panel: Go to System Web Services Users Click on Add new user and specify data for a new user Note: Api Key is a password that will be used when accessing Magento' s web services from TDS module In the User Role select the role specified in the previous step Save it

9 6 Execute updateproductsyncset.sql script For Tdssales module there is an additional script required. It must be executed on all magento databases where the integration with Openbravo ERP is going to be performed. The script can be found in: Go to the server directory where you installed Openbravo. The updateproductsyncset.sql script can be found in <serverdirectory>/webapps/openbravo/web-inf/magento To execute it, it is possible to do it from a command line or from a MySql Query Browser: mysql -u nameoftheuser -p nameofthedatabase mysql> \. <pathtothefile>/updateproductsyncset.sql Doing that from MySql Query Browser you should open a context menu of the magento database and select Create Stored Routine. Specify the name updateproductsyncset and press create procedure. A new procedure is created and you should open it and paste in everything what it is inside updateproductsyncset.sql and press execute.

10 7 Set up of magento.properties file The magento.properties file is one that contains the data needed for the whole synchronization process. It is deployed when installing TDS module and can be found in: Go to the server directory where you installed Openbravo. The module can be found in <serverdirectory>/webapps/openbravo/web-inf/ Before running any synchronization each property must be defined. The all properties are explained below: Url url address to your magento, or domain>/magento/index.php/api/xmlrpc/ Username name of the user that have access to the web services of Magento. Look at point 5 above Password Api key of the user specified in the point 5 above Payment_term name of the payment term that will be inserted for all synchronized orders Organization name of the organization that all products will be added to

11 PriceList name of the sales price list where all synchronized products should refer to and contains the sales price list version specified below Price_list_version name of the price list version where all synchronized products refer to Uom name of unit of measure for all synchronized products

12 Tax_category name of the tax category where tax below refer to Tax name of the tax for all synchronized products

13 Product_category name of the product category where all synchronized products should refer to Bp_group name of the business partner category where all synchronized customers are assigned to Purchase_pricelist name of purchase price list version that all synchronized product refer to

14 No_of_entries_in_page number of entries for a synchronization process during one connection. If the connection is slow there could be an timeout error and the value should be smaller than it is. By default do not change it Costtype - value of cost type. There are two possible values: ST for Standard Costs and AV for Avarage Costs. Please refer to Openbravo documentation for details. threshold number of minutes that checks if an order is synchronizing during this synchronization and not before. By default do not change it payment_method = name of the payment method that should be used by default for all orders

15 with_freight_product if this property is set to true, a specified product below will be used to include freight amount as product in orders freight_product_name name of the product that should be used as a freight product tax_zero name of a tax that will be used for freight product. It can be the same like the Tax property or can be a different one. The tax category of this tax must be the same like for the freight product with_attributeset if this property is set to true, all synchronized products will have specified a below AttributeSet

16 attributeset name of the AttributeSet that will be applied for all synchronized products by default

17 8 Running Synchronization To run any synchronization process a user should: Go to General Setup Process Scheduling Process Request Choose the synchronization process that should be scheduled Edit the time Save it

18 9 Alert recipients In case there are any problems during the synchronization process an alert in being sent to an Openbravo's user. By default the only user that receives alerts is System Administrator. In case there is a need to add an additional user that will receive alert: Log in to Openbravo as a user that should receive alerts Go to General Setup Application Alert Search for a proper Alert Rule Customer Synchronization, Product Synchronization or Sales Order Synchronization and press on the tab Alert Recipient Add a new user Save it

19 10 Logging system In case there are any problems a log file is created containing information about errors occurred. The log can be found: Go to the server directory where you installed Openbravo. The logs can be found in <serverdirectory>/logs The name of the logs where any errors can be found are openbravo.log and catalina.out