TIMS3 DBSync - Synchronize Documents

This section shows you how to synchronize document records and physical disk files.

Run DBSYNC on a file server and click on the document tab to see the following dialog:

DBSync Dialog

DBSync Input

A List of the required input parameters:

Log File

By default, a log file for the DBSYNC process is generated in the same directory where DBSYNC is stored, called DBSync.log. You may modify this to specify a different filename.

Search Project

You may specify a single project to work on, or accept the default to process All Projects. To specify a specific project, either key in the name of the project if you know it, or click on the pulldown list button at the right of the field and a list of all valid TIMS3 projects will be generated for your selection. You MUST NOT set this to the same name as the Dump Project (see below) since the DBSYNC utility will perform searches for the project(s) identified EXCLUDING the project as identified as the Dump Project. Therefore, if you specify the same name for both the Search Project and Dump Project no records will be found.

Search File Name

You may limit the action to only process a specific file name, or accept the default(blank) to process All Files. To use a specific file name, key in the name of the file (excluding the dot ‘.’ character). Also, use the * when you want to find the file name like files.

Search File Extension

You may limit the action to only process a specific file extension, or accept the default to process All Files. To use a specific file extension, either key in the name of the extension name (excluding the dot ‘.’ character) or click on the pulldown list button at the right of the field and a list of all file extension entries in the TIMS3 database will be generated for your selection.

Revision Specific Attributes

Revision Prefix/Suffix - Specify these parameters to exclude the revision files when searching.

Other Attributes

Include Sub Projects - Apply action for all sub projects.

Limit to one Document Record - Check this option when you want to limit one document record per file. In this case, all projects that are referred to the same directory are taken into consideration. For example, ProjectA and ProjectB are referred the same directory and a document record for FileA is in ProjectA but not in ProjectB. Search for documents in ProjectB will skip FileA when this option is checked.

Dump Project

The project that you specify in this field MUST NOT be the same project as entered in the Search Project item. You may specify an active production project name that you know all orphaned records found from the search project should be moved into. Alternatively, you may select a dummy scratch project, created before running DBSYNC, to be used for storing all orphan database records. By doing so, you can later use the TIMS3 Project Navigator to move the record to a properly identified project, or you may choose to delete the record when you have determined that it is not a valid record.

DBSync Dialog

Owner User Name

Use this field to specify a user name that will be the owner of any newly generated document records. Either key in the user name, if you know it, or click on the pulldown list button at the right of the field and a list of all documented TIMS3 users will be generated for your selection. The list of documented TIMS3 users can be modified by running the TIMS3 Data Manager and accessing the data in the ‘User Privilege Level’ option under the Security Menu .

Owner Group Name

Use this field to specify a group name that will be the group owner of any newly generated document records. Either key in the group name, if you know it, or click on the pulldown list button at the right of the field and a list of all document TIMS3 groups will be generated for your selection. The list of documented TIMS3 groups can be modified by running the TIMS3 Data Manager and accessing the Groups data in the ‘Table Maintenance’ option under the Administration Menu.

DBSync Operating Modes

A List of the various methods of using DBSync.

Log Errors Only

If you choose to log errors only for the search criteria specified, then the dialog items in the When Moving DB Records and When Adding Missing Records sections are disabled. Pressing the Begin button instructs the utility to create a report log file. Press the View Log when it becomes enabled to examine the log file.

Log Errors and Move Orphan DB Records

When you click to select this action the Dump Project item (in the When Moving DB Records group) becomes enabled and allows you to move orphaned database records to a specified project. An orphaned database record means a document record exists but the associated physical diskfile can not be located on the file server.

Log Errors and Add Missing Records

When you click to select this action the Owner User Name and Owner Group Name items in the 'When Adding Missing Records' group become enabled.

When a physical diskfile is found with no associated document record DBSYNC will automatically generate one. Most of the document record fields will be set to the default values related to the diskfile. However, the User and Group ownership of the document record must be set by specifying them in these two items on the dialog.

Log Errors, Move Orphan DB Records and Add Missing Records

When you click to select this action the Owner User Name and Owner Group Name items (in the 'When Adding Missing Records' group become enabled.
Also, the Dump Project dropdown becomes enabled and must be specified so that the orphan DB records can be moved the project specified.

When a physical diskfile is found with no associated document record DBSYNC will automatically generate one. Most of the document record fields will be set to default values related to the diskfile. However, the User and Group ownership of the document record must be set by specifying them in these two items on the dialog. Currently, the entries in these two items only relate to ownership of the document record, and not the actual existing diskfile, although this may be a future enhancement of the DBSYNC utility.