HOLD_ADD function

Use to add documents to a hold.

Important: You must have a locale set in your user profile before issuing this API. See the topic titled "Defining a locale" in the IBM® Content Manager OnDemand for i Planning and Installation Guide for important details.
To query the database to determine the documents to add to the hold, you can use the following parameters:
  • SQL query (-i)
  • public named query (-q)
  • text search string (-t or -T)
  • load ID (-x or -X)

Ensure that enhanced retention management is turned on for the application group and you have permission to add documents to a hold before you attempt this function. Otherwise, a permission error will occur.

If a duplicate attempt is made to add the same documents to 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 added.

Read syntax diagramSkip visual syntax diagramarsdoc hold_add-hinstance -lholdname -uuserid-ppassword-ffolder-GapplGroup-Uuser_alias-v-1trace_file-2level-Sstartdate,enddate,format-isqlQuery-tsearch_string-Tsearch_string-tsearch_string-Tsearch_string-Tsearch_string-qnamedQuery-xloadId-XloadId
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_ADD function when you use the parameter file option:
Read syntax diagramSkip visual syntax diagram arsdoc hold_add -F parmfile -h instance -ppassword-uuserid-Uuser_alias-v-1trace_file-2level
The syntax of the parameter file for the HOLD_ADD function is:
Read syntax diagramSkip visual syntax diagram [ -l holdname ] [ -f folder ] [-GapplGroup][-Sstartdate,enddate,format][-isqlQuery][-tsearch_string][-Tsearch_string][-tsearch_string][-Tsearch_string][-Tsearch_string][-qnamedQuery][-xloadId][-XloadId]