HOLD_ADD function
Use to add documents to a hold. 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.
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:
The syntax of the parameter file for the hold_add
function is: