Synchronize
This action searches a repository for new, updated, and deleted documents, and sends the updates to an ingestion server.
Type: Asynchronous
Parameter Name | Description | Required |
---|---|---|
Config
|
A base-64 encoded configuration. The configuration parameters that are set override the same parameters in the connector's configuration file. | No |
TaskSections
|
The names of the fetch tasks, as defined in the configuration file, to include when performing synchronization. If this parameter is not specified, all task sections are used. | No |
Identifiers
|
A comma-separated list of identifiers for documents that you want to synchronize. Specify a list of identifiers to synchronize only those documents. When you set this parameter, the specified documents are sent for ingestion whether they have been updated or not. | No |
SecurityInfo
|
An IDOL security info string. Set this parameter to impersonate the specified user. To impersonate another user you must set DocumentSecurityType and SecurityInfoKeys. |
No |
Override_Config_Parameters
|
Any other action parameters that you set override settings in the connector's configuration file. For example: /action=fetch&fetchaction=... where |
No |
Example
http://host:port/action=Fetch&FetchAction=Synchronize
Response
A sample response appears below. In this example, two tasks were performed as part of the synchronize (DIR1 and DIR2). Both of these found 10 new documents, but ingestion failed for all 20 documents.
<action> <documentcounts> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="DIR1" unchanged="0" updated="0" /> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="DIR2" unchanged="0" updated="0" </documentcounts> <fetchaction>SYNCHRONIZE</fetchaction> <tasks> <success>DIR1</success> <success>DIR2</success> </tasks> <token>MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4</token> <status>Finished</status> <queued_time>2009-Oct-15 14:44:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-Oct-15 14:44:32</process_start_time> <time_processing>3</time_processing> <process_end_time>2009-Oct-15 14:44:35</process_end_time> </action>
If a synchronize task does not complete successfully, the task name appears between <failed>
tags and a message explains the reason for the failure:
<tasks> <failed message="Error message">MyTask1</failed> </tasks>