Distributed Connector 23.4

# Collect

The `Collect` action uses an appropriate connector to extract files from a source repository and send them to a destination file system. The `Collect` action also sends metadata (from IDOL, or as specified by the `IdentifiersXML` parameter) to the destination. The metadata is written to a stub-IDX file, an IDX file that contains metadata associated with a file but no content. The stub-IDX file is written alongside the files in the collect destination.

There are several ways that you can specify the documents to collect:

- To specify documents by their identifiers, set the `Identifiers` action parameter. The Distributed Connector queries IDOL Server to retrieve the documents' metadata, so that it can send it to the destination, and so that it can send `Collect` actions to the correct connector groups.
- To specify documents by their identifiers, and define custom metadata to send to the destination, set the `IdentifiersXML` action parameter. When you set the `IdentifiersXML` parameter, the Distributed Connector does not query IDOL, so you must also specify the `AUTN_GROUP` action parameter.
- To specify documents that match a query, set the `Text` action parameter. The Distributed Connector queries IDOL Server and collects all documents that match the query.
- To specify documents that match a stored state token, set the `StateMatchID` action parameter. The Distributed Connector queries IDOL Server to retrieve information about the documents contained in the token.

You must set exactly one of the parameters `Identifiers`, `IdentifiersXML`, `Text`, and `StateMatchID`.

## Parameters

Parameter Name | Description | Required
--- | --- | ---
AnyLanguage | Sets the value of the `AnyLanguage` parameter, used when queries are sent to IDOL. |
AUTN_GROUP | The connector group to send the action to. This parameter is ignored unless you set `IdentifiersXML`. | Required if you set `IdentifiersXML`.
Combine | Sets the value of the `Combine` parameter, used when queries are sent to IDOL. |
Config | An optional Base64 encoded configuration file, to override the connector configuration file. |
DatabaseMatch | Sets the value of the `DatabaseMatch` parameter, used when queries are sent to IDOL. |
Destination | Defines the location to collect files to. | Yes
FieldText | Sets the value of the `FieldText` parameter, used when queries are sent to IDOL. |
IdentifierField | When the Distributed Connector queries IDOL server to find documents, it expects each document to have an identifier in the `AUTN_IDENTIFIER` field. The identifier is required so that a connector can collect the document. If the identifier is stored in a different field, use this parameter to specify the name of the field. |
Identifiers | A comma-separated list of identifiers specifying the documents to collect. | You must set one of `Identifiers`, `IdentifiersXML`, `StateMatchID`, or `Text`.
IdentifiersXML | Specifies the identifiers of the documents to collect. Set this parameter instead of `Identifiers`, if you want to specify custom metadata to associate with each document. | You must set one of `Identifiers`, `IdentifiersXML`, `StateMatchID`, or `Text`.
InsertMeta | Inserts metadata into the IDOL index related to what was collected during the action. |
PrintFields | Sets the value of the `PrintFields` parameter when queries are sent to IDOL. Adds IDOL field values into the stub IDX file. If you do not set this parameter, the stub-IDX only contains the standard fields such as the document reference and `AUTN_GROUP`. |
RemoveMeta | Removes metadata from the IDOL index following the action. When a connector reports to the Distributed Connector (using the `FetchFinished` action) that it has collected documents, the Distributed Connector can remove metadata fields from the documents in IDOL. |
SecurityInfo | Specifies the value of the `SecurityInfo` parameter, used when queries are sent to IDOL. |
StateMatchID | The ID of an IDOL state token that specifies the documents to collect. For example, you can use an existing IDOL query that has been refined. You can set this parameter instead of specifying document identifiers or specifying a new query to send to IDOL. For more information about the `StateMatchID` parameter, refer to the IDOL Server Reference. | You must set one of `Identifiers`, `IdentifiersXML`, `StateMatchID`, or `Text`.
StoredStateField | Sets the value of the `StoredStateField` parameter when queries are sent to IDOL. This parameter specifies the name of a document field to use when creating a stored state token. |
TaskSections | The names of the task sections in the connector's configuration file to use to perform the action. This value is passed to the connector that performs the action. |
Text | Sets the value of the `Text` parameter, used when queries are sent to IDOL. | You must set one of `Identifiers`, `IdentifiersXML`, `StateMatchID`, or `Text`.

Any additional parameters that you specify are passed to the connector that performs the action.

For more information about IDOL query parameters, refer to the IDOL Server Reference.

## Examples

To specify the documents to collect by their identifiers:

    /action=fetch&fetchaction=collect
    	      &destination=\\somepath\folder
    	      &identifiers=PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG...

To collect all documents that are returned as a result of a query to IDOL server:

    /action=fetch&fetchaction=collect
    	      &destination=\\somepath\folder
    	      &text=dolphins
    	      &fieldtext=EQUAL{1}:MAMMAL
     	      &securityinfo=...

To collect documents that were returned in response to a previous IDOL query:

    /action=fetch&fetchaction=collect
    	      &destination=\\somepath\folder
    	      &statematchid=B8UGIK95FKJG-23

## Response

The `collect` action is asynchronous, so you will receive a token in response to the request. Use the token with the QueueInfo action to check the status of the action.

Copyright 2023 Open Text
Version 23.4 | Last updated September 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Distributed Connector 23.4

Topic Title: Collect