Hold and Release Documents

You can use the Documentum Connector to place holds on documents in the Documentum repository. Placing a hold on a document prevents the document from being modified or deleted.

The connector can hold documents using a retention policy. To use a retention policy to hold documents, set the configuration parameter HoldUseRetentionPolicy to true and the configuration parameter HoldRetentionPolicy to the name of the retention policy to use. When you hold documents using a retention policy the configuration parameters HoldUpdateACL and HoldUseFreeze are ignored.

Alternatively, instead of using a retention policy, you can configure the hold using the configuration parameters HoldUpdateACL and HoldUseFreeze:

NOTE:

When you do not use a retention policy to hold documents (HoldUseRetentionPolicy=false), the connector stores information about holds in the datastore file for the fetch task. If you use the same task to perform synchronize and hold actions, the datastore contains both synchronize and hold information. If the datastore is deleted, for example by setting SynchronizeKeepDatastore=false, the information about holds is lost and the releasehold fetch action cannot release the documents. If this happens you must manually restore the original attributes of the documents in the Documentum repository. To avoid this issue, you can configure a dedicated fetch task to use for hold and releasehold fetch actions.

Whichever method you use to hold documents, you can also set the configuration parameter HoldAllVersions to specify which versions of the document to hold. By default, when the connector places a hold on a document, it holds the version specified in the hold fetch action. If you want to hold all versions of a document, set the configuration parameter HoldAllVersions to true.

Requirements

Place a Hold on Documents

To place a hold on documents, use the Hold fetch action. You must specify the identifiers of the documents to hold:

http://host:port/action=Fetch
                          &FetchAction=Hold
                          &Identifiers=Document_Identifiers

For more information about this action, refer to the Documentum Connector Reference.

Release Documents

To release documents, use the ReleaseHold fetch action. You must specify the identifiers of the documents to release:

http://host:port/action=Fetch
                          &FetchAction=ReleaseHold
                          &Identifiers=Document_Identifiers

For more information about this action, refer to the Documentum Connector Reference.


_FT_HTML5_bannerTitle.htm