InSync Service User Guide

Transcription

1 InSync Service User Guide Matrix Logic Corporation 1

2 Published by Matrix Logic Corporation Copyright 2011 by Matrix Logic Corporation All rights reserved. No part of the content of this manual may be reproduced or transmitted in any form or by any means without the written permission of the author. Hummingbird DM, DOCS Open, DOCS Fusion, edocs, and LiveLink edocs DM are registered trademarks of OpenText Corporation. Version: Date: January 2012 Contacting Matrix Logic How to Contact Matrix Logic Corporation: Matrix Logic Corporation 1354 East Ave Suite R #240 Chico, CA Phone : +1 (415) Fax: +1 (415) Sales : sales@matrix-logic.com Technical Support : support@matrix-logic.com Try our online support at our web site. Matrix Logic Corporation 2

3 Table Of Contents Contacting Matrix Logic... 2 Welcome... 5 Installing the InSync Service... 6 Software Requirements... 6 Supported Operating Systems... 6 Supported Databases... 6 Prerequisites... 6 ODBC Connections... 6 Access and Login Accounts... 6 Microsoft.NET Framework installation... 7 InSync Service Installation... 8 Post Installation Configuration Matrix Logic InSync Service Configuration Removing the Matrix Logic InSync Service from a Computer Removing the Matrix Logic InSync Service Getting Started Matrix Logic InSync Service Configuration Entering the license key InSync Manager Application The InSync Manager Toolbar The Status Bar Monitoring the Service General Tab Mail Notification Tab File Fetch Tab Matrix Logic Corporation 3

4 Connections and Mappings Tab Connection Properties Dialog Mapping Properties Dialog Technical Information Using the Matrix Logic InSync Service as a Scheduled Task Location of the Matrix Logic InSync Service Settings and Log How the InSync Service Works Dealing With ODBC Known Issues with the InSync Service Matrix Logic Corporation 4

5 Welcome Thank you for choosing Matrix Logic s InSync Service. This product is designed to synchronize an OpenText edocs DM database with validation data from another data source outside the edocs system. This is done using the Open Database Connectivity (ODBC) standards, so the data source can be anything from a text file to another relational database. Installation Getting Started Matrix Logic Corporation 5

6 Installing the InSync Service This document describes how to install the Matrix Logic InSyncService on your computer. Software Requirements Supported Operating Systems The Matrix Logic InSync Service works with the OpenText LiveLink edocs DM Server 5.x or up under the following operating systems: Windows 2008 (32 bit or in 32 bit compatibility mode) Windows 7 (32 bit or in 32 bit compatibility mode) Windows 2003 Windows XP Supported Databases The Matrix Logic InSync Service supports edocs DM Libraries created on the following SQL engines: MS SQL Oracle 9 Oracle 10.1 Prerequisites Before the installation, make sure the following actions have been completed: ODBC Connections ODBC DSNs (Data Source Names) have been created for the source system and the edocs DM database. If edocs DM is using an Oracle database, the Oracle Client will need to be installed on the PC running the Matrix Logic InSync Service. Access and Login Accounts If a datafile is the source data store and needs to be fetched from a remote location, the Matrix Logic InSync Service will need the proper account information to access the remote location. If it is to transfer the datafile to a network location, then the Matrix Logic InSync Service will need to be configured to run under a Windows Domain account that can access that target location after the transfer. If notifications are to be used, the Matrix Logic InSync Service will need the proper account information to access a SMTP server for your environment. Matrix Logic Corporation 6

7 Microsoft.NET Framework installation This product uses the Microsoft.NET framework version 2.0, which must be installed prior to running the Matrix Logic InSync Service installation. You may obtain and install Microsoft.NET Framework using Windows Update. Matrix Logic Corporation 7

8 InSync Service Installation NOTE: The user who installs the Matrix Logic InSync Service should be a member of the Local Administrators group on the server. NOTE: Make sure that any previous versions of the Matrix Logic InSync Service have been un-installed from the server you are about to install on. Run Setup.EXE. This will launch the InSync Setup program. The InSync Service Welcome dialog is displayed. Click Next. The Select Installation Folder dialog is displayed. Matrix Logic Corporation 8

9 The default installation path is C:\Program Files\Matrix Logic\InSync. Click Next in the Choose Destination Location window. The Start Installation window is displayed. Matrix Logic Corporation 9

10 Click the Next button. The Setup program begins copying the necessary files. After Setup has finished, the Installation Complete window is displayed. Matrix Logic Corporation 10

11 If the installation did not replace any system files a reboot will not be required. Matrix Logic Corporation 11

12 Post Installation Configuration Matrix Logic InSync Service Configuration The InSync Manager is used to setup the Matrix Logic InSync Service, add license keys, and set preferences. If the Matrix Logic InSync Service will be configured to fetch a source datafile from a remote location and place it in location that is NOT local to the PC running the service, the Matrix Logic InSync Service will need to be configured to run as a Windows domain account. This account will need read/write permissions to the destination directory of the source datafile. To configure the Matrix Logic InSync Service to run as a Windows Domain account instead of the default LocalSystem account, simply right click on the Matrix Logic InSync Service from Windows Services, and select the Log On tab. Click on the This Account radio button, and enter the credentials for the appropriate Windows Domain Account. Click on the Apply or OK button. Matrix Logic Corporation 12

13 TIP: Once the Matrix Logic InSync Service is configured, we suggest configuring the Matrix Logic InSync Service to restart itself in case of stoppage. Simply right click on the Matrix Logic InSync Service from Windows Services, and select the Recovery tab. Now set all failure modes to Restart the Service as shown below: Matrix Logic Corporation 13

14 Removing the Matrix Logic InSync Service from a Computer This section describes how to remove the Matrix Logic InSync Service from the computer where the software was originally installed by running the setup program. Removing the Matrix Logic InSync Service Go to the Control Panel. Click on Add/Remove Programs to bring up the Add/Remove Programs dialog. Select InSync and click the Change/Remove button. The uninstall wizard will start and guide you through the uninstall process. Matrix Logic Corporation 14

15 Getting Started To get up and running quickly, follow these steps: Start the InSync Manager from Start Programs Matrix Logic InSync InSync Manager. Enter your license key (or select that the installation is an evaluation of the product). Start the Matrix Logic InSync Service by clicking Start on the toolbar. Matrix Logic Corporation 15

16 Matrix Logic InSync Service Configuration Entering the license key When the InSync Manager is first run, you will need to enter a valid license key for the application, or click on the Eval button to evaluate the software for 30 days. You can start an Evaluation by clicking on the Eval button. NOTE: Running the Matrix Logic InSync Service in Evaluation mode causes the software to run in a restricted manner. Evaluation mode allows the software to be tested and demonstrated to users. Only 20 records may be processed per cycle. In addition, the license is only valid for thirty calendar days from the date of activation. After the time limit expires, the Matrix Logic InSync Matrix Logic Corporation 16

17 Service will no longer process records. A license key for a full version can be obtained from Matrix Logic Corporation Sales. See Contacting Matrix Logic. Once you have a valid license key, select the Help About menu option in the InSync Manager, then click on the Unlock button on the Product Information dialog. The product registration dialog will be presented for you to enter the key: Matrix Logic Corporation 17

18 InSync Manager Application You can setup how you would like InSync Service to run using the InSync Manager application. This may be started from Start Programs Matrix Logic InSync Insync Manager. This tab shows you statistics and information on the InSync service progress. Press the F5 key to refresh this information at any time. The InSync Manager Toolbar The InSync Manager Toolbar allows you to start and stop the service, as well as initiate a few other functions. The buttons perform the following functions: Starts the InSync service. If the service is already running, this button will be grayed out. Stops the InSync service. If the service is already stopped, this button will be grayed out. Matrix Logic Corporation 18

19 Saves the current configuration settings. Displays the InSync Service log file in Microsoft Notepad. This button displays the help file. The Status Bar The status bar shows the current state of the InSync service (Started, Stopped, Paused, etc.) Monitoring the Service Once the InSync Service is running, you may view the Windows Application Event log to see messages from InSync related to processing. More detailed information appears in the text log, which can be viewed by clicking the Log button on the toolbar. Matrix Logic Corporation 19

20 General Tab The General tab contains other settings for the Matrix Logic InSync Service, specifying what system to process, how often, and how many records to process at a time. The settings are as follows: Logging Level dropdown box Sets the amount of detail that appears in the text log file (viewed via the Log button). NOTE: It is a good idea to start the Matrix Logic InSync Service with logging set initially to Verbose, and then change the logging level to Minimal with Warnings once you are satisfied that the installation is configured properly. Do NOT set the logging level to Debugging except by the instructions of Matrix Logic Support. At this level, the log can become very large very quickly, and the Matrix Logic InSync Service is not intended to be run at this logging level for any significant length of time. Run InSync This tells the Matrix Logic InSync Service to process every x minutes. The more Matrix Logic Corporation 20

21 process every x minutes Run InSync Process at x every day Process Incoming Data in Groups Number pickbox frequently the Matrix Logic InSync Service runs, the higher the utilization on the source and edocs Database Servers. If the Run InSync Process every radio button is selected, the corresponding Run InSync Process at radio button is not selected, and the corresponding time pickbox is disabled. If this option is selected, notifications are only sent out in the case of an error in connection or processing (if notifications are enabled- see the Notification Tab for more information). This tells the Matrix Logic InSync Service to start processing at a given time each day. If the Run InSync Process at radio button is selected, the corresponding Run InSync Process every radio button is not selected, and the corresponding interval number pickbox is disabled. If this option is selected, notifications will be sent out after processing (if notifications are enabled- see the Notification Tab for more information). This sets the number of incoming records that will be processed at any one time. This is to improve the performance of the Matrix Logic InSync Service by breaking the incoming data into manageable chunks for processing. It prevents all the memory of the system from being taken up by a large data set from the source system. Matrix Logic Corporation 21

22 Mail Notification Tab The Notification tab contains settings for the Matrix Logic InSync Service to use for notifying administrative personnel of its processing status. The settings are as follows: Mail Server Name text box User Account Name text box and the User Account Password text box Sending Address text box This is the name of the Mail server to be used to send any notifications. If this field is blank, then no notifications will be sent. These text boxes allow you to set and modify the credentials that the Matrix Logic InSync Service will use to log on to the designated mail server. This is the address that will be shown in the FROM field on any notifications sent by the Matrix Logic InSync Service. It does not have to be a real address, though it must contain sign and follow an address format. Matrix Logic Corporation 22

23 Notification Address text box This is the address that the Matrix Logic InSync Service will try to send an to. This field can contain multiple addresses, each separated by a semi-colon (;) with no spaces between them. If this field is blank, then no notifications will be sent (even if a Mail server name is in the Mail Server Name field). NOTE: The existence of data in ALL of these fields is validated before sending an notification. So, if you have an Mail Server Name and a Notification Address defined, the other fields should also be defined and correct for your environment. Errors will be written to the application log file. NOTE: Even if notifications are disabled or error for some reason, the application log file will record errors and warnings and other data depending on the Logging Level. See the General Tab for more information. Matrix Logic Corporation 23

24 File Fetch Tab The File Fetch tab contains settings for the Matrix Logic InSync Service to use to retrieve a data file that can be used as the source data store. The settings are as follows: Fetch File for Data Source checkbox Location to Fetch From text box This checkbox tells the Matrix Logic InSync Service to fetch a datafile from a given location to be used as the source data store. If this checkbox is unchecked the other fields on this tab will be disabled. This is the fully qualified path or URL (INCLUDING THE FILE NAME AND EXTENSION) for the Matrix Logic InSync Service to fetch. The Fetch will occur at the beginning of the next processing. The original file will be copied, not moved. NOTE: This path can be a mapped drive, a UNC (Universal Naming Convention) path, an URL using ftp (File Transfer Protocol), or an URL using http or https (HyperText Transfer Protocol Secure). Matrix Logic Corporation 24

25 Location to Fetch To text box This is the fully qualified path AND FILENAME WITH EXTENSION the fetched file will be copied to. If the file exists, it will be overwritten. This location can be a mapped drive or a UNC path, but should be fully accessible by the Windows account that the Matrix Logic InSync Service is running under. NOTE: This should be the same location and file that the Source DSN is using for the source data store. NOTE: If this path is not a local path to the Matrix Logic InSync Service, the Matrix Logic InSync Service will need to be configured to run as a Windows Domain account that has read/write access to this location. The default account used is LocalSystem, which usually does not have this type of access outside the PC running the Matrix Logic InSync Service. User Name for Fetch and Password for Fetch text boxes These text boxes allow you to set and modify the credentials that the Matrix Logic InSync Service will use to fetch the datafile. In the case of an FTP or HTTP location, these would be the user name and password for an account on the web server with the proper rights. For a UNC path that is not local to the PC running the Matrix Logic InSync Service, this would be a Windows domain user and password. NOTE: The Matrix Logic InSync Service uses exactly what is typed for the user name, so for UNC locations, both DOMAIN\USERNAME and USERNAME@DOMAIN formats are supported depending on your particular security environment. Matrix Logic Corporation 25

26 Connections and Mappings Tab The Connection and Mappings tab contains the ODBC (Open DataBase Connectivity) connection settings and the data mappings that will be used to access the source of the data and the edocs database. The settings are as follows: Default Source Connection textbox Default Destination Connection textbox Connection List listbox This specifies the connection that will be used for the information source if one is not specified through parameters given to the Command Line Interface. If the Matrix Logic InSync Service is polling, this is the connection used for the information source. This specifies the connection that will be used for the information destination if one is not specified through parameters given to the Command Line Interface. If the Matrix Logic InSync Service is polling, this is the connection used for the information destination. This is a list of the available defined connections. The highlighted connection is the one that will be acted upon by any of the corresponding action buttons. Matrix Logic Corporation 26

27 Add Connection button Update Connection button Delete Connection button Make Default Source button Make Default Destination button Default Source Mapping textbox Default Destination Mapping textbox Mapping List listbox Add Mapping button Update Mapping button Delete Mapping button Make Default Source button Make Default Destination button This button presents a Connection Properties dialog that will allow the user to define the parameters for a new connection. This button presents a Connection Properties dialog that allows the user to modify the parameters for the currently selected connection in the Connection List listbox. This button will delete the currently selected connection in the Connection List listbox. This button will make the currently selected connection in the Connection List listbox the Default Source Connection. This button will make the currently selected connection in the Connection List listbox the Default Destination Connection. This specifies the data mapping that will be used for the information source if one is not specified through parameters given to the Command Line Interface. If the Matrix Logic InSync Service is polling, this is the data mapping used for the information source. This specifies the data mapping that will be used for the information destination if one is not specified through parameters given to the Command Line Interface. If the Matrix Logic InSync Service is polling, this is the data mapping used for the information destination. This is a list of the available defined data mappings. The highlighted mapping is the one that will be acted upon by any of the corresponding action buttons. This button presents a Mapping Connection Properties dialog that will allow the user to define the parameters for a new mapping. This button presents a Mapping Connection Properties dialog that allows the user to modify the parameters for the currently selected mapping in the Mapping List listbox. This button will delete the currently selected mapping in the Mapping List listbox. This button will make the currently selected mapping in the Mapping List listbox the Default Source Mapping. This button will make the currently selected mapping in the Mapping List listbox the Default Destination Mapping. Matrix Logic Corporation 27

28 Connection Properties Dialog The Connection Properties dialog displays the information necessary to configure an ODBC connection to be used by the Matrix Logic InSync Service. NOTE: Destination Data Sources are assumed by the Matrix Logic InSync Service to be OpenText edocs Libraries. Connection Name textbox ODBC Data Source Name textbox Data Source User textbox This is the name used for referencing the connection properties used by the Matrix Logic InSync Service. It is NOT the actual Data Source Name configured by ODBC. This name can have spaces, but not ampersands (&), semi-colons (;), less than (<), or greater than (>) characters. This is the Data Source Name configured in the ODBC properties. This DSN needs to be a System or File DSN in the ODBC properties. This is the user name to be used by the DSN to log into the data source, if needed. If this is for an OpenText edocs library, this should be the database server DOCSADM Matrix Logic Corporation 28

29 user. If this is for a file DSN, then no user or password is needed. Data Source Password textbox Last Sync Time textbox Is File DSN checkbox Process Multiple Files checkbox Static File Path and Name for DSN textbox Location of Multiple Files for Processing textbox File Name Pattern textbox This is the password to be used by the DSN to log into the data source, if needed. If this is for an OpenText edocs library, this should be the database server DOCSADM account password. If this is for a file DSN, then no user or password is needed. This is the last time that the Matrix Logic InSync Service has used this datasource to process entries. This setting only has meaning for information sources. If the setting is 1/1/ :00:00 AM, then all entries will be processed. This checkbox tells the Matrix Logic InSync Service if this Data Source is based on a file. If not checked, the Matrix Logic InSync Service will assume that the connection refers to a database of some sort. This setting only has meaning for information sources. If this checkbox is checked, then the Process Multiple Files checkbox will enable. Otherwise the Process Multiple Files checkbox will be disabled. This checkbox tells the Matrix Logic InSync Service that this File Based Data Source will need to process more than one file in alphabetical sequence when using this DSN. This checkbox is only enabled if the Is File DSN checkbox is checked. Checking this checkbox will enable the Static File Path and Name for DSN textbox, the Location of Multiple Files for Processing textbox, and the File Name Pattern textbox. This setting only has meaning for information sources. This textbox contains the full, formal path and file name for the text file which is used for the DSN. The files found in the Location of Multiple Files for Processing directory that match the File Name Pattern will be copied to this file and path name in alphabetical order and the DSN opened and used for each file. This setting only has meaning for information sources. The corresponding Browse button will present a Common File dialog that will allow the user to select this file. This textbox contains the full, formal path to the directory that will contain the multiple files that will need to be processed for this connection. The files found in this location that match the File Name Pattern will be copied to the Static File Path and Name for DSN path and file name in alphabetical order, and the DSN opened and used for each file. This setting only has meaning for information sources. The corresponding Browse button will present a Folder Browser dialog that will allow the user to select this directory. This textbox contains the file name pattern that the connection will need to process. The files found in the Location of Multiple Files for Processing directory that match this pattern will be copied to the Static File Path and Name for DSN path and file name in alphabetical order and the DSN opened and used for each file. The Matrix Logic InSync Service will append the *.* wildcards to this value to do the file matching search. This setting only has meaning for information sources. NOTE: It is best if the file names for multiple files can be sorted alphabetically into a date order. This can be done with a date in the format of YYYYMMDD contained in the file name (e.g. MLC_FILE TXT). Matrix Logic Corporation 29

30 Mapping Properties Dialog The Connection Mapping Properties dialog displays the information necessary to configure a data mapping to be used by the Matrix Logic InSync Service. NOTE: Destination Data Mappings are assumed by the Matrix Logic InSync Service to be OpenText edocs Libraries. Mapping Name textbox This is the name used for referencing the data mapping properties used by the Matrix Logic InSync Service. It is NOT the actual Data Source Name configured by ODBC. This name can have spaces, but not ampersands (&), semi-colons (;), less Matrix Logic Corporation 30

31 than (<), or greater than (>) characters. Parent Table Name textbox Parent Table Key Column textbox Parent Table Key Column Default textbox Parent Table Last Modified Column textbox Parent Table Child Link Column textbox Parent Table Child Link Default textbox Child Table Name textbox Child Table Key Column textbox Child Key is Uniquely Constrained This textbox contains the name of the parent table. For mappings that only contain one table, this would contain the table name. This textbox contains the name of the key column for the parent table. The values in this column must be unique. If this value is blank, then the Matrix Logic InSync Service assumes that this value will be defaulted, and uses the value in the Parent Table Key Column Default textbox. If the Mapping Parent table Key column is to have a default value (say that you wanted all the children entries to be placed under one parent), then the value of that default should be placed in this text box. If this text box has a value, then the Parent Table Key Column textbox should contain an empty string ( ). This textbox contains the name of the parent table column holding the last modified date. This date will be compared with the last processing time to see if a given data row needs to be processed. This setting only has meaning for information source mappings. This is the name of the parent table column that links to the child table. It is often, but NOT NECESSARILY, the parent table key column (for example, in an edocs Client-Matter relationship, the Parent Table Key Column would be CLIENT_ID, but the Parent Table Child Link Column would be SYSTEM_ID). If all the children will be assigned to a default parent, then this value should be an empty string ( ), and the value placed in the Parent Table Key Column Default textbox. This textbox will be disabled if there is no value in the Child Table Name textbox. If all the children entries will be assigned to a single parent, then the value of the Source Parent table column for that parent needs to be placed in this textbox. This is NOT the name of the table column, this is the actual value to be used. If you are using a default value for the parent entry, then the Parent Table Child Link Column textbox should contain an empty string ( ). This textbox will be disabled if there is no value in the Child Table Name textbox. This contains the name of the Child table if used. If the DSN only has one table that contains both parent and child information, then this will be the same as the parent table name. If this value is an empty string ( ) then it is assumed that there is no child table in the information source, nor will there be any child table updates in the information destination. This contains the name of the key column for the child table. The values in this column must be unique. If this value is blank, then the Matrix Logic InSync Service assumes that this value will be defaulted, and uses the value in the Child Table Key Column Default textbox. This textbox will be disabled if there is no value in the Child Table Name textbox. If this value will be defaulted, insure that the Child Key is Uniquely Constrained checkbox is UNCHECKED. This tells the Matrix Logic InSync Service that the Child Key Column has a database constraint placed upon it forcing this to column to hold unique values for the child table. This setting only has meaning for Destination Data Sources. If this checkbox Matrix Logic Corporation 31

32 checkbox Child Table Key Column Default textbox Child Table Last Modified Column textbox Child Table Parent Link Column textbox Child Table Parent Link Default textbox Disabled Values textbox Enabled Value textbox Other Column Mappings textbox is checked, and an existing row is found in the destination child table with a link to a different parent than the one in the source data, the destination child row is updated with the link to the parent specified in the source data (the child will be moved to the new parent). If the Child Table Key Column is defaulted (see below), then the default child will be assigned to the last parent processed. If the Child table Key column is to have a default value, then the VALUE of that default should be placed here. If you are using a default value for the Child Table Key, then the Child Table Key Column value should be an empty string ( ) and the Child Key Is Uniquely Constrained checkbox should be UNCHECKED. This textbox will be disabled if there is no value in the Child Table Name textbox. If this This contains the name of the child table column that contains the last modified date. This date will be compared with the last processing time to see if a given data row needs to be processed. This textbox will be disabled if there is no value in the Child Table Name textbox. This setting only has meaning for information source mappings. This contains the name of the child table column that holds the link to the parent table in the data source. If all the children are to be assigned to a default parent, then this value should be an empty string ( ), and the value placed in the Child Table Parent Link Default textbox. This textbox will be disabled if there is no value in the Child Table Name textbox. If the value of the Child table link to the Parent table will be defaulted, then that value needs to be placed here. If this key is used, then the Child Table Parent Link Column value should be empty ( ). This textbox will be disabled if there is no value in the Child Table Name textbox. This textbox contains all the values that a source data mapping could be used to flag an entry as Disabled. Values should be separated by a semi-colon (;). This setting only has meaning for information source mappings. This textbox contains the value that a destination data mapping will use to flag an entry as Enabled. This value will be either an N or a 0, and can vary from table to table in an edocs Library. Contact your OpenText edocs Administrator for the proper value for this entry. This setting only has meaning for information destination mappings. This text box contains a variable number of mappings that allow further data from the source to be mapped to the destination. There should be one mapping on each line. To add a new line inside the text box, hold down the Control key (Ctrl) while hitting the Return or Enter key. These mappings should be in the format of DESTINATION_TABLE.TABLE_COLUMN=SOURCE_TABLE.TABLE_COLUMN. These settings only have meaning for information source mappings. Matrix Logic Corporation 32

33 Technical Information Using the Matrix Logic InSync Service as a Scheduled Task The Matrix Logic InSync Service also includes a command line interface that allows the Matrix Logic InSync Service engine to be run as a scheduled task. There is a separate executable in the installation directory called INSYNCCLI.EXE. This executable can be run as Console application or in a Batch File. It takes the following parameters:?- Show basic help information. This will also circumvent processing. DESTCONN- Use the specified connection name from the INSYNC.XML file as the destination connection. DESTMAP- Use the specified mapping name from the INSYNC.XML file as the destination mapping. SOURCECONN- Use the specified connection name from the INSYNC.XML file as the source connection. SOURCEMAP- Use the specified mapping name from the INSYNC.XML file as the source mapping. The Matrix Logic InSync Service engine will use the default values specified in the INSYNC.XML file for any of these sources or mapping that are not specified in the command line. If there are more than four parameters provided, the command line interface will present an error and exit. Location of the Matrix Logic InSync Service Settings and Log The Matrix Logic InSync Service stores the settings from the Matrix Logic InSync Service Manager in a file called INSYNC.XML, stored in the installation directory of the Matrix Logic InSync Service. The Matrix Logic InSync Service log is stored in a file called INSYNCENGINELOG.TXT, stored in the installation directory of the Matrix Logic InSync Service. The Matrix Logic InSync Service Command Line Interface log is stored in a file called INSYNCCLILOG.TXT, stored in the installation directory of the Matrix Logic InSync Service. How the InSync Service Works The Matrix Logic InSync Service first checks to see if it needs to fetch a datafile to be used as the source data store. If so, then it uses the supplied locations and credentials to retrieve the file and place it in the desired location. The Matrix Logic InSync Service then uses ODBC Data Source Names to connect to the source data store and to the edocs database. Since ODBC is used, the source data store can be anything that has an ODBC driver Matrix Logic Corporation 33

34 that Microsoft Windows will recognize, and allow a DSN to be created for. This ranges from ASCII text files all the way to enterprise level database systems. The Matrix Logic InSync Service then reads data from the source data store that has been modified since the last processing time. This includes data that may be in a Parent/Child table relationship. NOTE: The modification criteria for the source data store MUST be a date. Using data structure mappings, the data is then used to update or add information to tables in the edocs system, even if those tables have a parent/child table relationship. Data structure mappings for CMS and Elite systems to update edocs Client and Matter tables are included in the installation ( out of the box ). Data structure mappings for other source data stores or for other edocs tables can be provided by Matrix Logic engineers for your individual needs. Contact Matrix Logic for further details. Dealing With ODBC ODBC DSN s are used by the Matrix Logic InSync Service to connect to the source data store and to the edocs database. This allows a high level of flexibility about the types of data stores supported by the Matrix Logic InSync Service. However, this also means the particular details of setting up a DSN for one data store varies significantly from another. In the case of enterprise level database systems, your database administrator can probably provide the necessary instruction to set up the necessary DSN. For other cases, Matrix Logic engineers can set up the necessary connectivity to your data stores. Contact Matrix Logic for further details. Matrix Logic Corporation 34

35 Known Issues with the InSync Service Matrix Logic Corporation 35