arsdoc query

From CMOD.wiki
Jump to: navigation, search

IBM Content Manager OnDemand's arsdoc query utility allows CMOD Administrators to search for document metadata in OnDemand Folders or Application Groups, from the server operating system command line.

arsdoc query help

Simply by typing the arsdoc query command, you'll receive a brief description of the parameters:

IBM Content Manager OnDemand arsdoc query parameters  
 $ arsdoc query
 ARS6004I Usage: arsdoc query -h hostname [-u <userid>] [-p <passwd>] [-U <user_alias>] [-v] (-F <parmfile> | ((-i <sql_query> | -q <namedquery> | -t <search_str> | -T <search_str> | -X <load_id> | -x <load_id>) [-B <dbname>] [-f <foldername>] [-G <name>] [-l <holdname>] [-e <delim>] [-H] [-I <type>] [-N <(field1)>][-n] [-o <filename>] [-d <dir>] [-L <max_hits>] [-S <startdate,enddate[,format]>])) [-1 <trace_file>] [-2 <trace_level>]
   Version:  10.5.0.0
   -d <dir> Directory to write output file
   -e <delim> separator between database values
   -f <foldername> OnDemand folder         	(required in parm file)
   -h <hostname> OnDemand Hostname         	(command line only)
   -i <sql_query> SQL query string
   -l <holdname> OnDemand hold
   -n Add line numbers in output file
   -o <filename> Output file name          	(required in parm file)
   -p <passwd> OnDemand User Login Password Stash File
   -q <namedquery> Public named query
   -u <userid> OnDemand User Login Name
   -t <search_string> Server text search
   -x <load_id> LoadId to use for OnDemand
   -v Verbose                              	(command line only)
   -B <dbname> Name of a database field used to sort the data in ascending order
   -F <parmfile> Requests parameter file   	(command line only)
   -G <name> Application Group Name
   -D Append the document handle to each record in the file
   -H Build a header record
   -I <type> Append the LoadId to each record in the file
      f Search the System Log for the LoadId
      p Create the LoadId from document information
   -L <max_hits> Maximum hits to process
   -N <(field1)> One or more database field names; defines order in file
   -S <startdate,enddate[,format]> Segment date range
   -T <search_string> Full text search
   -U <user_alias> User alias that appears in System Log messages
   -X <load_id> LoadId to use for OnDemand
     -1 <trace_file> Trace file              	(command line only)
     -2 <trace_level> Trace level            	(command line only)
   Flags in a parameter file must be delimited by brackets EX: [-f foldername]

parameters

This is a list of the most popular parameters, in a slightly more logical order:

-I - instance - (uppercase letter i)
Specifies the CMOD instance to connect to. If you only have one instance, and the instance name is ARCHIVE, you can omit this.
If you have multiple CMOD instances on your server, you must specify one of them.
-h - hostname
Specifies the server name to connect to. If you are performing a query on a remote server, specify the domain name or IP address of the server to connect to. If the remote server has multiple instances, you will need to define them locally in your ars.ini configuration file.
-u - CMOD User Name
Specifies the CMOD User name to use in order to connect to authenticate to the OnDemand Server.
-p - CMOD User password stash file
In older versions of CMOD, this parameter was used to specify the CMOD User password. This was painfully insecure, as other users logged into the server could see the command in the process list, and potentially learn the password for a Content Manager OnDemand Administrative account.
Since CMOD v9.0 and higher, stash files can be used to store passwords in a safe and encoded format that is not easily decoded into clear text.