DEFINE HOLD (Define a hold for retention set data)

Use this command to define a retention hold so that data in one or more retention sets can be preserved. When the retention set is added to a retention hold, the data cannot be deleted and is not subject to normal expiration processing.

A retention hold is a collection of retention sets that are preserved regardless of their expiration dates. Data in a retention hold can be deleted only when the retention set is released from the retention hold.

Privilege class

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

Syntax

Read syntax diagramSkip visual syntax diagram DEFine HOLD hold_name DESCription=description CONTact=contact

Parameters

hold_name (Required)
Specifies a name for the hold. The name must be unique and the maximum length is 64 characters.
DESCription
Specifies a description for the 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 that requested the hold. For example, the email address of your organization's legal counsel. 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.

Example: Define a retention hold to preserve data in retention sets

Several retention sets contain the financial data that might be relevant in upcoming litigation proceedings to address court docket 987204. To ensure that the relevant data is preserved, create hold COURT_DOCKET_987204 and add all relevant retention sets to this hold.
define hold court_docket_987204  
description="Financial_data_for_2018_held_for_criminal_court_docket987204" 
contact="John Q. Lawyer, 520-555-1234"

Related commands

Table 1. Commands related to DEFINE HOLD
Command Description
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.
UPDATE HOLD Changes the attributes of a hold.