Synchronize
The Synchronize
action instructs the connector to synchronize with the data repository immediately. (Usually you would schedule synchronize cycles to occur on a regular basis, according to a schedule).
The connector searches the repository for new, updated, and deleted documents. FlowFiles containing the information are routed to the "Synchronize Output" relationship of the connector group.
You can also synchronize specific documents by providing a list of document identifiers.
Type: asynchronous
Parameter | Description | Required |
---|---|---|
ConnectorGroup
|
The name of the connector group to send the request to. This must match the name you specified when you configured the ConnectorGroupRouter processor in your dataflow. |
Yes |
Documents
|
XML that specifies the documents to synchronize. When you set this parameter, the documents are ingested (FlowFiles are routed to the "Synchronize Output" relationship) whether the documents have changed or not. <documents custom_attribute1="..."> <document custom_attribute2="..."> <CONNECTOR_GROUP>FileSystem</CONNECTOR_GROUP> <AUTN_IDENTIFIER>BASE64</AUTN_IDENTIFIER> </document> ... </documents> The The In NiFi Ingest, actions are represented by FlowFiles. You can specify custom attributes on the |
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 documents are ingested (FlowFiles are routed to the "Synchronize Output" relationship) whether the documents have changed or not. | No |
Custom parameters |
Any other parameters that you set are added to the FlowFile, created by the HandleAciRequest processor, that represents the action. When a connector processes the action, it adds the parameters to any FlowFiles that it generates. The parameters are added as FlowFile attributes named FlowFile attributes can be referenced by processor properties that support expression language, and can be read by Lua scripts. You can therefore set custom parameters to customize processing within NiFi. The maximum size for a custom parameter value is 4KB. |
No |
Example
http://host:10000/action=Synchronize&ConnectorGroup=FileSystem
Response
This is an asynchronous action, so you receive a token in response to the request. The following XML shows an example response to the QueueInfo action.
<autnresponse> <action>QUEUEINFO</action> <response>SUCCESS</response> <responsedata> <actions> <action> <status>Finished</status> <queued_time>2019-Sep-12 15:42:36</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2019-Sep-12 15:42:36</process_start_time> <time_processing>1</time_processing> <process_end_time>2019-Sep-12 15:42:38</process_end_time> <token>...</token> </action> </actions> </responsedata> </autnresponse>
If you set the documents
action parameter, the response should also contain a <success>
element for each of the specified documents, containing the document identifier.