QUERY HOLDLOG (Query the retention set hold log)

Edit online

Use this command to display all activity related to a retention hold. To maintain an audit trail, all activity related to a hold is logged in the hold log.

You can display the entire history of a hold or the history related to a specific retention set that was added to hold. This history remains available even after all retention sets affected by a hold are released, expired, or deleted. For example, if the hold was renamed by using the RENAME HOLD command or if any attributes, such as description or contact information, were updated by using the UPDATE HOLD command, these actions are tracked in the hold log.

Privilege class

Any administrator can issue this command.

Syntax

Parameters

hold_name: Specifies the name of the hold to query. This parameter is optional. If you specify a hold, only that hold is considered during query processing. If you do not specify a hold, all holds are displayed.

retset_id: Specifies the ID of a retention set that is added to the specified hold. This parameter is optional. If you specify a retention set ID, only that retention set is considered during query processing. If you do not specify a retention set ID, all retention sets that are in the hold are displayed.

SEArch: Specifies a text string that you want to search for in the activity log. Enclose the string expression in quotation marks if it contains blanks. You can use text and a wildcard character to specify this string. This parameter is optional.

ACTion

Specifies the actions taken on the one or more retention holds that match the search criteria are displayed. The following values are possible:

ANy: Specifies that the history of any action taken on the hold or holds that match the search criteria is displayed.
Hold: Specifies that only the entries added to the hold log when retention sets were placed in the hold are displayed.
RELease: Specifies that only the entries added to the hold log when retention sets were released from the hold are displayed.
Create: Specifies that only the entries added to the hold log when the hold was created are displayed.
Update: Specifies that only the entries added to the hold log when the hold was updated are displayed.
REName: Specifies that only the entries added to the hold log when the hold was renamed are displayed.

BEGINDate

Specifies the beginning date in a range of dates. All holds that are defined on a date starting from this range are displayed. This parameter is optional. You can use this parameter with the BEGINTIME parameter to specify a range for the date and time. If you specify a begin date without a begin time, the time will be at 12:00 midnight on the date that you specify. The default is the earliest date on which the first hold is defined.

You can specify the date by using one of the following values:

Value	Description	Example
MM/DD/YYYY	A specific date	05/15/2018
TODAY	The current date	TODAY
TODAY+days or +days	The current date plus the number of specified days	TODAY+3 or +3
TODAY-days or -days	The current date minus the number of specified days	TODAY-3 or -3
EOLM (End Of Last Month)	The last day of the previous month	EOLM
EOLM-days	The last day of the previous month minus the number of specified days	EOLM-1 To include files that were active a day before the last day of the previous month
BOTM (Beginning Of This Month)	The first day of the current month	BOTM
BOTM+days	The first day of the current month, plus the number of specified days	BOTM+9 To include files that were active on the 10th day of the current month

BEGINTime

Specifies the beginning time in a range of times. All holds with a starting time within this range are displayed. You can use this parameter with the BEGINDate parameter to specify a range for the date and time. If you specify a begin time without a begin date, the date will be the current date at the time you specify. This parameter is optional. The default value is 00:00:00.

You can specify the time by using one of the following values:

Value	Description	Example
HH:MM:SS	A specific time	10:30:08
NOW	The current time	NOW
NOW+HH:MM or +HH:MM	The current time plus the specified number of hours and minutes	NOW+02:00 or +02:00
NOW-HH:MM or -HH:MM	The current time minus the specified number of hours and minutes	NOW-02:00 or –02:00

ENDDate

Specifies the ending date in a range of dates. All holds with an end date up to and including this date are displayed. This parameter is optional. You can use this parameter with the ENDTime parameter to specify an ending date and time. If you specify an end date without an end time, the time will be at 11:59:59 PM on the specified end date.

You can specify the date using one of the by using one of the following values:

Value	Description	Example
MM/DD/YYYY	A specific date.	05/15/2018
TODAY	The current date.	TODAY
TODAY+days or +days	The current date plus the number of specified days. The maximum number of days you can specify is 9999.	TODAY+3 or +3
TODAY-days or -days	The current date minus the number of specified days.	TODAY-3 or -3
EOLM (End Of Last Month)	The last day of the previous month.	EOLM
EOLM-days	The last day of the previous month minus the number of specified days.	EOLM-1 To include files that were active a day before the last day of the previous month
BOTM (Beginning Of This Month)	The first day of the current month.	BOTM
BOTM+days	The first day of the current month, plus the number of specified days.	BOTM+9 To include files that were active on the 10th day of the current month

ENDTime

Specifies the ending time in a range of times. All holds with an end time up to and including this time are displayed. This parameter is optional. You can use this parameter with the ENDDate parameter to specify a date and time. If you specify an end time without an end date, the date will be the current date at the time you specify.

You can specify the time by using one of the following values:

Value	Description	Example
HH:MM:SS	A specific time	10:30:08
NOW	The current time	NOW
NOW+HH:MM or +HH:MM	The current time plus the specified number of hours and minutes	NOW+02:00 or +02:00
NOW-HH:MM or -HH:MM	The current time minus the specified number of hours and minutes	NOW-02:00 or –02:00

Example: Display detailed information about a retention hold

Display detailed information about update actions that were taken on COURT_DOCKET_987204. See Field descriptions for field descriptions.

query holdlog court_docket_987204 action=update

   
         Date/Time: 03/01/2019 11:49:42 AM
         Hold Name: court_docket_987204
  Retention Set ID: 83
            Action: Update
            Reason: DESCRIPTION="Hold on data required to address criminal 
                    court docket 987204"
                    CONTACT="John Q., johnqlawyer@testing.com), 522-555-4321"
Administrator Name: SERVER_CONSOLE

Field descriptions

Date/Time: Specifies the date and time when the activity on the hold was logged.

Hold Name: The name of the hold.
Retention Set ID: The retention set ID that is associated with the hold.

Action: The type of action on the hold for which the message was logged.
Reason: The reason why the logged action was taken.
Administrator Name: The administrator ID that was used to run the query.

Related commands

Table 1. Commands related to QUERY HOLDLOG
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.
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.