Hold

The Hold action places a preservation order on a particular item or set of items in a managed repository through the appropriate connector.

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

  • To specify documents by their identifiers, set the Identifiers action parameter. The Distributed Connector queries IDOL Server to find the documents so that it can send Hold actions to the correct connector groups.
  • To specify documents by their identifiers, you can alternatively 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. You can use the IdentifiersXML parameter instead of Identifiers if you want to avoid the query to IDOL.
  • To specify documents that match a query, set the Text action parameter. The Distributed Connector queries IDOL Server and places holds on 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.  
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.  
FieldText Sets the value of the FieldText parameter, used when queries are sent to IDOL.  
Identifiers A comma-separated list of identifiers specifying the documents to hold. You must set one of Identifiers, IdentifiersXML, StateMatchID, or Text.
IdentifiersXML Specifies the identifiers of the documents to hold. You must set one of Identifiers, IdentifiersXML, StateMatchID, or Text.
InsertMeta Inserts metadata into the IDOL index related to what was held during a particular hold action.  
RemoveMeta Removes metadata from the IDOL index following the action.  
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 hold. 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 hold by their identifiers:

/action=fetch&fetchaction=hold
	      &identifiers=PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG...

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

/action=fetch&fetchaction=hold
	      &statematchid=B8UGIK95FKJG-23

Response

The Hold 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.