HOLD_RELEASE function

Use to remove documents from a hold. To query the database to determine the documents that should be removed from the hold, you can use the following parameters:
  • SQL query (-i)
  • text search string (-t or -T)
  • load ID (-X)

If you selected the option in the application group to use implied hold, documents are placed on hold as soon as they are loaded, and there is not a hold name that is associated with the documents that are placed on hold. To remove documents from an implied hold, specify IMPLIED_HOLD as the hold name. For best performance when removing documents from an IMPLIED_HOLD, it is recommended that you use the SQL query (-i) parameter instead of the load ID (-X) parameter to determine the documents that should be removed from the hold. For example, you might specify –i “WHERE doc_name LIKE ‘2FAA%’” to remove holds on all documents where the doc_name_prefix portion of the load ID starts with 2FAA. To determine the doc_name_prefix, find the load ID of the document(s), which is in the format of agid-pri_nid-sec_nid-doc_name_prefix-start_dt-stop_dt-appid. For example, if the load ID is 770659-1-0-2FAA-19960313000000-19980313000000-770660, the doc_name_prefix is 2FAA, so the SQL query would be “WHERE doc_name LIKE ‘2FAA%’”.

Ensure that Enhanced Retention Management is turned on for the application group and you have permission to release documents from a hold before you attempt this function. Otherwise, a permission error will occur.

If a duplicate attempt is made to remove the same documents from a hold, no error occurs, and ARSDOC displays a successful message. However, the system log might contain messages that indicate that the documents were already released.

Read syntax diagramSkip visual syntax diagramarsdoc hold_release-ffolder-GapplGroup-hinstance -isqlQuery-qnamedQuery-tsearch_string-Tsearch_string-lholdname -ppassword-Sstartdate,enddate,format-uuserid-Uuser_alias-v-X loadId-1trace_file-2level
When you use the parameter file option, you must specify the -F, -h, -p, -u, -U, -v, -1, and -2 parameters on the command line. All other parameters must be specified in the parameter file. The following diagram shows the syntax of the hold_release function when you use the parameter file option:
Read syntax diagramSkip visual syntax diagramarsdoc hold_release-Fparmfile -hinstance -ppassword-uuserid-Uuser_alias-v-1trace_file-2level
The syntax of the parameter file for the hold_release function is:
Read syntax diagramSkip visual syntax diagram[-lholdname ][-ffolder ][-GapplGroup][-Sstartdate,enddate,format][-isqlQuery][-tsearch_string][-Tsearch_string][-tsearch_string][-Tsearch_string][-Tsearch_string][-qnamedQuery][-XloadId]