There are three tabs available Sync Configuration, Sync Job Status, and Content Sync Settings.
In the panel for Create Sync Configuration, the created Data Sync configurations are listed. Users can sync from any source system or external system for a new sync, and for delta sync.
You can configure various filters here. Set any filter as required and click the Search button. The following filter options are available.
You can also create a Data Sync job from this panel. Click the Create Config button to add a data sync job. Click the refresh icon to manually update and refresh the page information.
The list of information displays in the following columns:
Column Name | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
System | Displays the selected system | ||||||||||||||
Repository |
Displays the selected data sync repository |
||||||||||||||
Database |
Displays the selected database |
||||||||||||||
Sync Status |
Displays the sync status set for the configured job.
|
||||||||||||||
Deleted | Displays Yes if the job is deleted. | ||||||||||||||
Stopped | Displays Yes if the data sync is stopped. | ||||||||||||||
Interval | Displays the data sync schedule | ||||||||||||||
Document Content | Displays if the documents are selected for sync from the repository | ||||||||||||||
Audit | Displays if the document audit (document history) is selected for sync from the repository | ||||||||||||||
Created On | Displays the configuration date for data sync job | ||||||||||||||
Details |
Click View Details to view complete details of data synced to CAM. The sync status can also be viewed in the Sync Job Status tab. The Sync Jobs dialog displays complete details of the sync job with the start and end time. It also displays the count of the workspaces and documents synced with the completion percentage of the sync job. The Full Sync tab displays the completion status of the data sync job scheduled to run once. The Incremental Sync tab displays the completion status of the scheduled sync jobs. |
||||||||||||||
Actions |
|
Note: Data Sync maintains a backup of the deleted NetDocuments user/group information to help map user details with any document audit or folder audit details.
This tab displayed status of data sync - Full Sync, Incremental Sync and Recent Documents sync (for iManage system).
Note: Incremental syncs will run job steps (security, audits, folder metadata, document metadata, parent objects and document content in parallel now. In prior versions, each step was run sequentially. This will improve sync times for incremental syncs.
You can configure various filters here. Set any filter as required and click the Search button. The following filter options are available.
The Full Sync tab displays the completion status of the data sync job scheduled to run once.
The Incremental (Delta) Sync tab displays the completion status of the scheduled sync jobs.
The Recent Documents Sync tab displays the completion status of the scheduled Recent document sync jobs. It only checks for content changes to get recent documents periodically at configured intervals. It also allows to schedule Recent documents sync job for existing incremental sync which are active.
Click the refresh icon to manually update and refresh the page information.
The list of information displays in the following columns:
Column Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
System | Displays the selected system | ||||||||||
Repository |
Displays the selected data sync respository |
||||||||||
Database |
Displays the selected database |
||||||||||
Status |
Displays the progress status of the data sync job. Active: Initial run executed and active. Error : Execution failed. New : Created and yet to initial run. |
||||||||||
Deleted | Displays Yes if the job is deleted. | ||||||||||
Stopped | Displays Yes if the data sync is stopped. | ||||||||||
Start From Days | Only displayed in the Recent Sync tab. Displays n number of days in Past. | ||||||||||
Content Change | Only displayed in the Recent Sync tab.Yes, if content of documents change. | ||||||||||
Last Sync Time | Only displayed in the Incremental and Recent Sync tab. Displays the last sync date and time | ||||||||||
Next Sync Time | Only displayed in the Incremental and Recent Sync tab. Displays the next sync date and time | ||||||||||
Job Type & Interval | Displays the configured data sync type and the sync schedule | ||||||||||
Documents (Count & Size) | Displays the count & size of the document synced from the repository to CAM | ||||||||||
Workspaces | Displays the count of the workspaces synced from the repository to CAM | ||||||||||
Start Time | Displays the start date and time of the data sync job | ||||||||||
End Time |
Displays the completion date and end time of the sync job |
||||||||||
Details | Click View Details to view Full Sync Job Details. The dialog displays complete details of the data synced. | ||||||||||
(Displayed only for Incremental and Recent Sync) |
|
In this tab you can select the sync storage options. On successful validation, click Save.
Field Name | Description |
---|---|
Choose Cloud Provider |
Select the cloud provider option. Currently its disabled and default to AWS. |
Choose Storage |
Currently its disabled and default to S3. |
Choose Storage | Select the storage option, if you want to sync content to the Prosperoware Encrypted Storage or to your Private Cloud. |
Bucket Name |
Based on the storage option selected above the bucket name is available for selection. Select the bucket name. |
API Endpoint Base URL | Enter the API URL for the site provided by the Prosperoware. |
API Secret Key | Enter the API secret key. If using the Prosperoware Encrypted storage, the API secret key will be provided by Prosperoware. On successful validation the content sync configuration is saved. |
To set up a new config, click the Create Config button. To edit existing configs, click the icon next to the connection and click Edit Config.
Note: You can edit the existing configuration till it's waiting in the queue to pick up. It can not be edited once the job is created.
In the Sync Configuration tab click Create Configuration.
It will pop-up a checklist to be verified before you submit the Initial Sync request. In case of any doubt, please contact CAM support.
Field | Description | ||||||
---|---|---|---|---|---|---|---|
Expected Documents For Database |
Select how many millions of records expected to be synced. Contact CAM support team if expected records are more than 4 Millions and enter the following details:
To Choose workers verify workers status on clicking Check Worker Status link. |
||||||
Choose System |
It will list systems configured in the External System Configuration. You can choose any one of them. |
||||||
System Specific Settings |
These are enabled based on system selected from the dropdown. iManage click here. Office 365 click here. NetDocuments click here. |
||||||
Choose Repository |
Based on the selected system, all the repositories configured within the system is displayed here. Select the repository to be synced. |
||||||
Select Database |
Select the database from the repository to be synced. Tip: In case the token is renewed for NetDocuments, it is recommended to edit and update the NetDocuments server setup to update and populate the database list in this drop-down. |
||||||
Sync Document Content | Select Yes to sync the documents. Set sync schedule for the document. Select the number of days from which the document(s) must be picked to sync with CAM. | ||||||
Keep Document/Folder Versions |
Select Yes to maintain document /folder versions on sync. You can select the version numbers to be maintained from the drop-down. |
||||||
Sync Document Audit | Select Yes to sync the audit data. | ||||||
Sync Users and Groups | Select Yes to sync users and groups. | ||||||
Incremental Sync Interval | Set the incremental sync schedule. After the initial sync, the subsequent data sync will be triggered as per the schedule defined here. Select the Unit and the Duration. | ||||||
For the iManage, Recent Document Sync feature is enabled. | |||||||
Recent Documents Sync Interval |
Set the recent sync schedule. After the initial sync, the subsequent Documents sync will be triggered as per the schedule defined here. Select the Unit and the Duration. Note: It syncs documents only. Folder/workspace structure will be synced during incremental/full sync. This option helps to keep documents up to date. |
||||||
Recent Documents Sync Start From Days | For the initial trigger, select from which day start the recent sync. After the first execution, the subsequent Documents sync will be triggered as per the schedule defined above (Recent Documents Sync Interval). Options available are from the past 2 to 90 days. | ||||||
Auto Start Recent Documents Sync | If selected, after the initial sync, the subsequent Documents sync will be triggered as per the schedule. |
Note: Multiple sync configuration cannot be set for the same system, repository, and database.
CAM implemented a feature to support more than one full sync at a time in each region.
Three parallel stacks are deployed and one stack can be used by one tenant at a time to run full sync.
The status of each worker is tracked: READY or BUSY.
READY -> The worker/stack is available to be allocated for any new initial sync.
BUSY -> The worker/stack is unavailable and is at present in use to run initial sync.
CAM provides system specific settings to perform test run or skip events for better performance.
In Data Sync, a test run can be executed to test configurations of Data Sync.
To enable Test Configuration:
Options are:
Note: When using Select cabinets manually, a maximum of 5 are allowed. The add button will stop adding after 5.
NetDocuments keep tracks of change events that are referred to during the incremental sync process. Sometimes tools are being used to perform bulk operations on documents that may not participate in the content or metadata change. Such events can be ignored to optimize the syncing process.
You can skip these events generated by a specific user from the sync. Enter the below details:
If your organization has pre-provisioning OneDrive for many or each new user, by adding their email addresses you can exclude OneDrive data (Content + Metadata) of the individual from the sync process. Enter the below details:
Now when a new Data Sync is configured, a sample of the metadata mappings is provided to ensure the correct mappings before a sync is started.
To review metadata:
Warning: You cannot continue if you have not acknowledged mappings are correct.
In the Action menu of the Data Sync job, certain events can be skipped.
In NetDocuments, events can be ignored by name.
The out of the box list of exclusions that can be selected for iManage, Office 365, or other systems.:
A full Data Sync for High Q includes the following options:
Documents
Site Groups
Users of Site Groups
Security of Folders and Documents (if present)
Available for C2-C5.
Permissions | Allows User To |
---|---|
View Data Sync | Enables user to view Administration>Data Sync |
Manage Data Sync | Enables user to view Administration>Background Jobs |
Allow Audit Sync | Enables the synching of audit information. For C3-C5 |