UPDATE HOLD (Update a retention hold)

Edit online

Use this command to update the attributes of a retention hold. To maintain an audit trail of all activity related to the hold, all updates are written to the hold log.

Privilege class

To issue this command, you must have system privilege or unrestricted policy privilege.

Syntax

Read syntax diagramSkip visual syntax diagram UPDate HOLD hold_name DESCription=description CONTact=contact ACTive=YesNo

Parameters

hold_name (Required)
Specifies a name for the hold. The name must be unique and the maximum length is 64 characters.
Restriction: You cannot use the UPDATE HOLD command to change the name of a retention hold. However, you can change the name of a retention hold by using the RENAME HOLD command.
DESCription
Specifies a description for the retention hold. This parameter is optional.

The maximum length of the description is 255 characters. Enclose the description in quotation marks if it contains any blank characters.

CONTact
Specifies the contact information for the person, for example, the lawyer or law firm that requested the hold. This parameter is optional.

The maximum length of the contact information is 255 characters. Enclose the information in quotation marks if it contains any blank characters.

ACTive
Specifies that one or more retention sets can be added to the retention hold by issuing the HOLD RETSET command and considered during query processing. This parameter is optional. The default value is YES.
Yes
Specifies that the retention hold is active and retention sets can be added.
No
Specifies that the hold is inactive after the last retention set in the hold is released. Additional retention sets cannot be added to the hold by issuing the HOLD RETSET command. Information about an inactive hold is not displayed in the output of the QUERY HOLD command by default.

Example: Update the attributes of a retention hold

Update the retention hold COURT_DOCKET_987204 to change the phone number that is listed for the lawyer who requested the hold. 

update hold court_docket_987204
contact="John Q. Lawyer, 520-555-4321"
Table 1. Commands related to UPDATE HOLD
Command Description
DEFINE HOLD Define a retention set hold.
HOLD RETSET Places a retention set in a retention hold.
QUERY HOLD Displays information about a hold that is placed on a retention set.
QUERY HOLDLOG Displays information about the hold log.
RELEASE RETSET Releases a retention set from a retention hold.
RENAME HOLD Changes the name of a hold on a retention set.