Documentum Connector 12.13

# 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`:

- Modify the document's Access Control List (ACL). The connector modifies the ACL so that all users, apart from the user who submitted the hold, are restricted to read-access and cannot modify the document or create new versions of the document. To modify a document's ACL when a hold is placed on the document, set the configuration parameter `HoldUpdateACL` to `true`.
- Modify the document's "frozen" attribute. The connector modifies the "frozen" attribute of a document, which restricts some operations on a document. For a more secure hold consider modifying the ACL as well, or using a retention policy. To apply the "frozen" attribute when a hold is placed on a document, set the configuration parameter `HoldUseFreeze` to `true`.

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

- To hold documents using a retention policy, the Documentum installation must support retention policies through the Retention Policy Administrator, and you must specify the name of the retention policy to use in the connector's configuration file.

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.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 Documentum Connector 12.13

Topic Title: Hold and Release Documents