NiFi Ingest 25.2
NiFi Ingest

# Collect

The `Collect` action retrieves documents from a repository. For each document that is collected, a FlowFile is routed to the "Collect Output" relationship of the connector group.

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 collect.
    <documents custom_attribute1="...">
        <document custom_attribute2="...">
            <CONNECTOR_GROUP>FileSystem</CONNECTOR_GROUP>
            <AUTN_IDENTIFIER>BASE64</AUTN_IDENTIFIER>
        </document>
        ...
    </documents>
The `CONNECTOR_GROUP` element specifies the name of the connector group to send the request to. This overrides the value of the `ConnectorGroup` action parameter for a specific document. If you specify the connector group for every document, you no longer need to set the action parameter. If present in the XML, the `CONNECTOR_GROUP` element must be the first element within the `document` element. The `AUTN_IDENTIFIER` element specifies a Knowledge Discovery document identifier. In NiFi Ingest, actions are represented by FlowFiles. You can specify custom attributes on the `documents` element (for all documents) or on a `document` element (for a single document). These are added to FlowFiles that represent actions, as FlowFile attributes. The FlowFile attributes are named `idol.doc.name`, for example `idol.doc.custom_attribute1`. | Set this or `Identifiers`
`Identifiers` | A comma-separated list of identifiers to specify the documents to collect. | Set this or `Documents`
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 `idol.aci.param.name`, where `name` is the name of the parameter that you set. 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=Collect
    			  &ConnectorGroup=FileSystem
    		          &Documents=...

## 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 16:28:02</queued_time>
                    <time_in_queue>0</time_in_queue>
                    <process_start_time>2019-Sep-12 16:28:02</process_start_time>
                    <time_processing>0</time_processing>
                    <process_end_time>2019-Sep-12 16:28:03</process_end_time>
                    <success>identifier1</success>
                    <success>identifier2</success>
                    <failed reason="File does not exist for collection '/opt/files/spreadsheet2.xlsx'">identifier3</failed>
                    <token>...</token>
                </action>
            </actions>
        </responsedata>
    </autnresponse>

Copyright 2018-2025 Open Text
Version 25.2 | Last updated April 2025

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 25.2

Topic Title: Collect