User Manual: Synchronization setup
Contents
1. P gina 14 17 5 Background Process After installing the synchronization module the background process responsible for executing the synchronization and the definition of the alert that notices the error in the process is created with the load of the module for the organization This load process must be executed from the window General Setup Enterprise Enterprise module management o 4 S General Setup Enterprise Enterprise module management Enterprise module management i openbravo Professional Enterprise module management O Organization Reference data Select All None 18 Web Services Synchronization 1 1 000000 English USA Update available im Chart of accounts PGC 2007 PYMEs 1 0 3 Spanish Spain iam Chart of accounts PGC 2007 General 1 0 4 Spanish Spain iam Spain AEAT Modelo 347 1 1 5 English USA Web Services Synchronization 1 1 000000 Synchronization Alerts and Synchronization Process Request With this module you can synchronize with external applications using Web services You can select the application tables data etc Actually is tested with SugarCRM You can synchronice FROM Sugar TO Openbravo FROM o M came The background process will be created deprogrammed To set the frequency and range with which we want to run go to General Setup Process Scheduling Process Request and find the2. s Synchronization point Terceros Contactos w Active Identifier 10380030 f6be 0967 64ac 4cae5246eb09 Insert or update Delete O The tab displays the following fields Synchronization point synchronization point to which belongs the record Identifier record identifier in external application Insert or update indicates if the record synchronization has failed in a insert update process Delete indicates if the record synchronization has failed in a delete process When the record is saved or deleted succesfully in Openbravo it will disappear from pending records table Pagina 13 17 4 Synchronization passwords This window is in the menu in General Setup Application This is the place where you set the username and password from the external application that will allow the synchronization process to connect via web services to obtain the necessary information Notice For SugarCRM the informed user must have administrator permissions to access all records that need to synchronize dm S General Setup Application Synchronization passwords Synchronization passwords v Bl epenbravo FEES Y 70 66968 i tems fig Synchronization passwords Synchronization passwords Client REDK Software Engineering S L Organization Execution order 10 Active Name Tablas maestras user password
3. synchronized Let s review the meaning of each field Active This field indicates whether the relationship exists or if the records were removed from both systems Each time a record that has been previously synchronized removed this field is unchecked Synchronization point indicates the synchronization point to which they belong synchronized records Table of Openbravo Openbravo table that has been synchronized Openbravo identifier record identifier that has been synchronized Table of external application External application table that has been synchronized External appl identifier record of the external application that has been synchronized and which corresponds the record Openbravo identifier Last Sync indicates the last date and time in that were synchronized both records the hour is visible in the grid view 3 3 LOG error This tab also read only errors will be recorded as they occur during the synchronization process Each record in the window represents the errors occurred in a sync point throughout the day The tab displays the following fields Pagina 12 17 o 4 S General Setup Application Synchronization settings Synchronization gt gt Synchronization points gt gt LOG error openbravo Professional O 6698 Synchronization Synchronization settings Synchronization points _ O Data synchronization Sy a Client REDK Software Engineering S L Organiza
4. be synchronized Module of external application in the case of SugarCRM this field indicates the module name associated with the table we have indicated in the External application table Sometimes it can match the name of the table but it must be typed with capital letters for example the form on the contacts table is Contacts Where clause external application this field will be informed if you want to sync only certain records in the table is selected in Ext application table For example if you only need to synchronize the Accounts that are Customer may have to write the following condition accounts account type Customer In this case we use as an alias the name of the table you re working and the field name of the database Order by external application this field will be informed in case you want to get the results sorted by a particular field of the external application table we are synchronizing Max number records Maximum number of records that can be obtained from the web service of the external application Execute synchronization this button can manually sync the this synchronization point This button should not be used while the synchronization process is scheduled to run because that could cause duplications of data in one of the two systems 3 1 Data synchronization this tab you configure the mapping of fields that you want to synchronize Openbravo and external application The field
5. password in the Password synchronization window Execute synchronization this button can manually sync all the items contained in this synchronization This button should not be used while the synchronization process is scheduled to run because that could cause duplications of data in one of the two systems Pagina 5 17 3 Creating synchronization points After creating the synchronization as explained in the previous section the next step is to create different synchronization points Each synchronization point will correspond to a table to be synchronized To create a new point click the New button in tab Synchronization points in General Setup Application Synchronization settings It provides the following form uv General Setup Application Synchronization settings Synchronization gt gt Synchronization points i openbravo E BEER D SCE ees Professional Synchronization settings O Data synchronization Sync Records LOG error Client REDK Software Engineering S L Organization Synchronizaton Terceros Execution order 10 dE Active V Name Cuentas no JEE KET Last Run Date 28 09 2010 19 29 30 Last execution user Openbravo Last execution External 03 09 2010 14 37 54 Last execution 28 09 2010 13 24 34 application gt Openbravo Openbravo gt External appl
6. sync process called Synchronization Process See next image o 4 S General Setup Process Scheduling Process Request Process Request i 2 openbravo Professional Ta ES Process Request Client REDK Software Engineering S L Organization Process Synchronization Process Active Y Timing Schedule Security Based on Role v em e eEi L StartDate BB Start Time Frequency O TS Finishes C AP Reschedule Process Once you have specified the desired interval frequency and save the process is Pagina 15 17 programmed by clicking Reschedule Process Thereafter the periodic run of the process will appear on the monitor processes with other processes running on the application See General Setup Process Scheduling Process Monitor window for more information P gina 16 17 6 Alerts In the module loading process that has been explained in the previous section an alert named Synchronization ERROR is created It ll be neccesary to define the receptors and to activate it General Setup Application Alert Alert Rule openbravo Professional Pesos MS a Client REDK Software Engineering S L Organization Name SYNCHRONIZATION ERROR Active Sql SELECT wss_syncloatable id AS reference
7. REDE NET Software Engineering User Manual Synchronization setup File User Manual Synchronization Versi n 1 0 Sevilla October 5 2010 History Miguel M rquez Romero 04 10 10 Creation Table of contents TE INTO UICN 0 AAA O Ea SSI O ao 4 2 Creating a new SYNCHFONIZAtION cece nena nena nana eee 5 3 Creating synchronization POINKS cece ce EEE EEE EEE EEE EE EEE EEE Ed 6 3 1 Data synchroniz tion is eg Aba ee alee a amanda nda dias 8 3 2 SYNE RECOKA Sirag tia dica A dia eat AR dea sia chine A A A CIDA TEA A eat eyes 11 3 3 LOG EITO ea A dates A de E dod aun ead DE deena E ETA dW nda SR SM Tan 12 3 4 Pending record Sennaa e A tev sara Laos a Dar adia ads Sees E a A A dt ed RSS atadas DA alee tian 13 4 SyNchronization passwords evita foie AG Aad oda GeV A ead A ded vende EN Sea Tea eds 14 5 Background PROCESS di nnda ea nik camera atts 15 GAIN TR A O BONE ES RE BIG REDES POTE RE ENE CR UR ES dorna 17 P gina 3 17 1 Introduction This document is intended as a guide when creating a new parameter for the synchronization of Openbravo and external application SugarCRM The minimum versions needed to install the synchronization module are e Openbravo 2 50 MP16 SugarCRM 5 2 0k Pagina 4 17 2 Creating a new synchronization The first step is to create a new synchronization setup For it from General Setup Application Synchronization settings click the New button It pro
8. e where the information we will synchronize External application The choices are Column if the information is going to synchronize is a column of External application No correspondence in the external appl select this option when the field you want to synchronize Openbravo has no corresponding field in the external application but we can get this value from Openbravo s own tables If you select this value there are fields that are hidden External appl column Is Id external appl Foregin key external appl And other fields are shown Foreign key Openbravo this field should check if the value that we get is foreign key of another table in Openbravo Foreign key table table from which the field is foreign key Default value if not found in the table Foreign key table the value of the Openbravo column is assigned the value that has been designated as the default in this field Fixed value if you select this option will show a field named Fixed value external appl where should indicate what value is always assign to the corresponding field in Openbravo Data type external appl in this dropdown list will indicate the type of information we want to synchronize External application There are several options Boolean Date Decimal Numeric Text Time Undefined Notice is very important to correctly indicate what type each field you want to sync to avoid format errors in the process of insert or update da
9. executed when its direction is Openbravo gt External application and is ignored if the direction is the opposite This is because the column of the external application would not correspond to any column in Openbravo To obtain a field of the record we re synchronizing it s neccesary to use the expression actual_table_id in the WHERE clause and the process will replace it by the ID of the record that is synchronizing now For example we re synchronizing the c_bpartner table and in a field of the external application you want to save the name of the bussines partner concatenated with de TaxId So to get in Openbravo would create a SQL like this SELECT C_BPARTNER NAME I i C BPARTNER TAXID FROM C BPARTNER WHERE C BPARTNER C BPARTNER ID factual table id Fixed value if you select this option will show a field named Fixed value Openbravo in which states that value is to always assign the corresponding field in the external application Data type Openbravo in this dropdown list will indicate the type of information we want to synchronize Openbravo There are several options Boolean Date Decimal Numeric P gina 9 17 Text Time Undefined Openbravo Column this dropdown list displays all fields Openbravo table we have selected in the sync point This field is displayed if you have selected the option Column in the Data source Openbravo Data source external appl by this drop down list indicat
10. have synchronized The Openbravo user should be performing the synchronization process Last execution External application gt Openbravo this field will store the modification time of the last record of the external application from the External application gt Openbravo synchronization In this way the next time you run synchronization seek records that have changed after this date time Last execution Openbravo gt External application this field will store the modification time of the last record of Openbravo from the Openbravo gt External application synchronization In this way the next time you run synchronization seek records that have changed after this date time Notice for synchronization executed in both directions must be taken into account to prevent the records you synchronize just one way to do so also in the opposite direction by the update date to be no need there is a restriction that only synchronized In Openbravo records that have been modified by a user other than Openbravo which is what makes the synchronization process except when the record does not yet exist in the external application That is you can create a user record with Openbravo and synchronized but can not be updated with that user This is useful for data migration in which the user can be assigned Openbravo In the external application SugarCRM records that have been modified by a user other than the admin user fo
11. ication Last deleted Direction Openbravo lt gt External application Priority External application Category Error Log table Write in LOG table E Table of Openbravo C_BPartner Where dause Openbravo gb customer true and ob acdEmpresa true and Order by dause Openbravo id lt gt 81B6C2297B4640E58D 1D7210449E9C40 External application settings Table of external accounts application Module of external Accounts application Where dause external accounts accqunt_type Customer Order by external application application Max number records o dE 5 execute synchronization You ll see the following fields Execution order this field is intended to indicate the background process in what order to execute each points for the synchronization in question Obviously it s recommended that you first run the points corresponding to the master tables and then the points that make use of these datas Active if not mark this field this synchronization point will not run Name name to identify the synchronization point Description General description of synchronization point Last Run Date this field is read only and is updated after each execution of the synchronization process to indicate when was the last time you synchronized the table Pagina 6 17 Last execution user read only field that will indicate which users
12. key id a cama Inter pl wss_syndogtable wss_syncpaint id es ES AS record id Error in synchronization ad column identifier wss_syncpoint wss syndogtable wss syncaoint id es ES I II TO_CHAR wss_syndoatable error_datetime DD MM YYYY AS description A Filter Clause Tab LOG error Synchronization settings E The alert will generate a warning for each synchronization point which of the error By clicking on the Record LOG Error tab is displayed on which you can see the full error message 4m S General Setup Application Alert Management Alert Management 9 9 openbravo Professional Alert Management Alert Rule SYNCHRONIZATION ERROR Active 7 Fixed y Search SYNCHRONIZATION ERROR P gina 17 17
13. must belong to the table indicated in the synchronization point P gina 8 17 o General Setup Application Synchronization settings Synchronization gt gt Synchronization points gt gt Data synchronization i 2 openbravo Professional ES q w y re Ze 2 B 8 Linked Items E Synchronization Synchronization settings o Data synchronization Sync Records LOG error Organization Active Y TClent REDK Software Engineering S L afa Synchronization point Terceros Cuentas Data name Nombre Description Data source Openbravo Column Data type Openbravo Text Openbravo column Name 3 Data source external appl Column Data type external appl Text e External appl column name Is Id external appl E Foregin key external appl C You ll see the following fields Data name field name you want to synchronize It s not neccesary it matches with the name of the database Description description of the field we re going to synchronize Data source Openbravo by this drop down list indicate where the information we will synchronize Openbravo The choices are Column if the information is going to synchronize is a column of Openbravo SQL statement if the information is obtained by querying the database Openbravo This synchronization will only be
14. r the same reason as above The difference is that in this case neither synchronized records created by the admin user as in the external application there is no log synchronization Last deleted Date time of last execution in which a record was deleted in the external application Keep in mind that MySQL does not store milliseconds datetime fields therefore can be the case in which several users to delete or update records at the same time This should take into account that in the next sync will get the records with date greater than or equal to the last date of deletion ie we must adapt the value of the field Maximum number of records to the volume of records deleted or updated have the same date of update this is important for mass updates or deletes to make sure we get all the records Direction is the direction in which to run the synchronization There are 3 possible values Openbravo External application the data are synchronized from Openbravo to the external application External application Openbravo the data are synchronized from the external application to Openbravo Openbravo External application if you select this option another drop down list will be shown in which we indicate which of the two applications have priority ie how this will be synchronized first Category Error Log table this dropdown list has the next values Write in LOG table errors are written to the log table W
15. rite in file and LOG table errors are written to the LOG table and in the Openbravo log file located in folder Tomcat logs usually called openbravo log Table of Openbravo indicate which table of Openbravo to be synchronized Where clause Openbravo this field will be informed if you want to sync only Pagina 7 17 certain records in the table is selected in Openbravo table For example if you only need to synchronize the Business Partner that are Customer may have to write the following condition ob iscustomer true Note that you must use the alias ob to refer to the table we are synchronizing And for the field name not be used the field name in database but the name that takes the field in the java class PROPERTY nombre campo constant value The sentence is written in this field will use the synchronization process as part of the where clause so it is important that the syntax is correct Notice To facilitate this task we recommend installing the module HQL Query Tool in which you can create and run HQL statements and see the result We can also see all the properties of a particular class You can see more about this module at http forge openbravo com projects hglquerytool In Order by clause Openbravo this field must be informed in case you want to get the results sorted by any field in a particular Openbravo table we are synchronizing Table of external application indicate which table of Ext application to
16. ta External appl column in this field indicate the field name of the external Pagina 10 17 application you want to synchronize Is Id external appl if you mark this field it indicates that fields that are synchronized with the corresponding table s primary key of the external application Foregin key external appl If this is checked it indicates that the field we are synchronizing the external application is foreign key in another table If marked are two new fields External appl module here indicating which module is the foreign key field in the external application In case of SugarCRM you have to be careful with upper and lower case and take into account that sometimes the name of the table differs from the name of the module For example in the case indicated that contacts as module name the Web service would not recognize this name as a module name Would indicate Contacts to make everything right In this case there isn t to indicate column which external application relates Openbravo column as the key point is outside and tell the form on the web service foreign key relates the two records Display related field this field only be marked in the case of the field we are synchronizing the external application is a foreign key in another table but has not defined a relationship between two tables For example in the case of SugarCRM in the Contacts module is the field Country that refers to the mod
17. tion Synchronization point Terceros Alumnos Date time 15 09 2010 17 35 52 Error message 0423626d gt Error deleting record in Openbravo ERROR update or delete on table c_bpartner violates foreign key a constraint acd bpartner controlasist on table acd_controlasistencia E Detail Key c_bpartner_id 3C8BA9A5B1724F94A8EA046EF6092022 is still referenced from table acd controlasistencia Synchronization point synchronization point to which belong the errors shown Date time date on which errors occurred The time corresponds to the last time the process failed in the day in question Each record in the LOG error corresponds to one day Error menssage in this field will concatenating the errors as they occur in the synchronization point throughout the day For each error log entry will generate an alert in Openbravo indicating at what point the error occurred 3 4 Pending records This tab will be stored records which for some reason have not been able to sync from the external application to Openbravo 4m D Synchronization points Pending records Q 2 openbravo Professional 2 e ab le da S e Linked Items Ei Synchronization Synchronization settings O Synchronization points nization Sync Records LOG error client REDK Software Engineering S L v Organization Formaci n Ocupacional S L v
18. ule where the countries are but there is not a relationship created between these two modules so you must specify the field which is related for example id paises So if you mark this field shows the field External appl column to indicate the related field External appl module in this field indicates the name of the module from the external application of which is foreign key field that are synchronized 3 2 Sync Records This tab is stored for each sync point identifier identifies the partners of Openbravo External Application ID These pairs represent the relationships between Openbravo records and records of the external application P gina 11 17 o 4 S General Setup Application Synchronization settings Synchronization gt gt Synchronization points gt gt Sync Records 0 openbravo Professional CES wena Synchronization Synchronization settings application LastSync 13 09 2010 12 36 06 Data synchronization LOG error 7 Client REDK Software Engineering S L V Organization Active Y Synchronization point Terceros Cuentas Table of Openbravo C_BPartner Openbravo identifier B13CFD4DF46A41948206EA1FF027AA2B Table of external Accounts External appl identifier 73dbe7c3 7387 f4da 4896 4c8dfe850f58 This window is read only and will be updated automatically with new records that will be
19. vides the following form ES ME Tar Linked Items E Synchronization settings 7 Client REDK Software Engineering S L Organization E Execution order 10 NE Active Y Name Tablas maestras Description External application SugarCRM y Version 5 2 0j hh Endpoint http ec2 46 51 142 107 eu west 1 compute amazona Web Service Version 0 1 User connection admin 7 You ll see the following fields Execution order this field will indicate in what order the background process should run the different synchronizations if there is more than one By default Openbravo assigned an autocalculated value Name name of the synchronization For example Master Data Description General description of synchronization Active if not mark this field this synchronization will not run External application application that we synchronize Openbravo with in our case is SugarCRM Version is the external application version we will use Endpoint web services url Usually has the following format http url SugarCRM soap php Web Service Version version of the web service of SugarCRM User connection SugarCRM s username to use web services and obtain and enter information This user must have permission to access all the information you are querying or inserting In this window is read only You can edit the user and
Download Pdf Manuals
Related Search