ReleaseHold

The ReleaseHold action releases a document that was placed on hold by the Hold action.

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 release.

<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 an IDOL 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 release. 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=ReleaseHold
	                  &ConnectorGroup=Documentum
		          &Documents=...

Response

This is an asynchronous action, so you receive a token in response to the request. You can use the QueueInfo action to see the result of the action.