Parameters

-a application
The name of the application to load. If the application group contains more than one application, then you must identify the application to load. Otherwise, the load will fail. If you plan to automate the loading of data into different application groups and applications, then use the -A parameter to specify the component of the input file name that identifies the name of the application.
-A applID
Determines the component of the input file name that identifies the application to load. If the application group contains more than one application, then you must identify the application to load. Otherwise, the load will fail. You typically use this parameter when you run the ARSLOAD program as a started task to automate the loading of data into different application groups and applications.
  • By default, the ARSLOAD program uses the FORM component of the input file name to identify the application group to load. You can use the -G parameter to specify a different component of the input file name that identifies the application group. For example, arsload -G JOBNAME.
  • If the application group to load contains more than one application (source of data), then you must identify the application to load. Otherwise, the load will fail. For example, to use the DATASET component of the input file name to identify the application, run the ARSLOAD program with the -A DATASET parameter. For a started task or job, DATASET is the DD name that defines the input file.
Choose one of the WRITER, MVS, JOBNAME, DATASET, or FORM components of the input file name to identify the application.
-b <index #,field_name>
Specify the name of an index field and a number that identifies the part of the input file name that the ARSLOAD programs assigns to that index field. For index_number, you can specify 1 - 8 and the number must match a part of the input file name identified by the -B parameter.
In the following example, assume that the input file name is ApplGroup1.App1.ARD:
arsload -b "1,field1" -B "AG.1APP.ARD" -g ApplGroup1 ...
During the load, the ARSLOAD program assigns the value App1 from the input file name to the index field "field1" of application group "ApplGroup1".
-B "format"
Use this parameter to do the following tasks:
  • Define the file name formats for MVS download files and files processed by the ARSLOAD daemon.
  • Identify the parts of the file name that the ARSLOAD program assigns to an index field specified by the -b parameter.
Use the following identifiers to define the file name format:
1 - 8
A number prefixed to a part of the file name that identifies that part as a value to assign to an index field.
AG
Application group name
APP
Application name
DAT
Abbreviation for DATASET
EXT
Extension
FLD
Field place holder for indexing
FOR
Abbreviation for FORMS
HH
Abbreviation for HHMMM
IGN
Ignore
JOB
Abbreviation for JOBNAME
MVS
MVS
WRI
Abbreviation for WRITER
YY
Abbreviation for YYDDD
The following example uses the full word of the JOB, DAT, FOR, YY, and HH identifiers to define the file name format:
MVS.JOBNAME.DATASET.FORMS.YYDDD.HHMMM.ARD
The following example shows the same file name format with the abbreviated words:
MVS.JOB.DAT.FOR.YY.HH.EXT
The following example shows the same file name format and indicates that the ARSLOAD program assigns the JOB part of file name to index field 1:
MVS.1JOB.DAT.FOR.YY.HH.EXT
The following examples show different ways that you can define the file name formats:
ARSLOAD -G FORMS -D “-“ -B “WRItER-MVS-IGN-IGN-FORms”
ARSLOAD -G JOBNAME -B “WRITER.IGN.JOB.IGN.DAT.IGN.EXT”
ARSLOAD -D “-“ -B “IGN-IGN-AG-APP-IGN.EXT”
ARSLOAD -B “APP.IGN.AG.IGN.IGN”
The following examples show how to identify the parts of the file name to assign to an index field:
  • Single index format, where the ARSLOAD daemon assigns the DAT part of the file name to index field account_num:
    arsload -b “1,account_num” -B “AG.APP.1DAT”
  • Multiple index format, where the ARSLOAD daemon assigns the different parts of the file name to different index fields:
    arsload -b “1,report_name” -b "2,run_date" -b "3,app_name" -B “AG.3APP.1FLD.2YY”
    The following table maps the index field name to the part of the file name
    Index field name Part of the file name
    report_name FLD
    run_date YY
    app_name APP

You can use the -B parameter or combine the -g and -a parameters, but you cannot use all three of them together. If you specify the -B parameter, you identify the application group name and the application name as parts of the file name.

-c indexDir
The file system in which Content Manager OnDemand temporarily stores data created by the indexing program. The default location is the directory from which the ARSLOAD program was invoked.
-C class
Specifies the JES SYSOUT class or classes that the ARSLOAD program monitors for input data to process when running as a started task. You can specify up to 36 classes. The classes should be specified as a string of characters. For example: -C A or -C ACDFLPQ.
-d dataDir
Specifies an HFS file system to monitor for input data to process.
Restriction: If you specify the -C, -F, or -W parameters, the -d parameter is ignored.

The name of an input file residing in this file system must conform to the following format: WRITER.MVS.JOBNAME.DATASET.FORMS.YYYYDDD.HHMMSST.ARD

Important: The .ARD file name extension is required to initiate a load process, and all associated files must have .ARD as part of the filename.

By default, the ARSLOAD program uses the FORMS component of the file name to identify the application group to load. However, you can use the -G and -A parameters to specify a different component of the file name (WRITER, MVS, JOBNAME, DATASET, or FORMS) to identify the application group and application to load.

Restriction: The ARSLOAD program cannot invoke an indexing program when the -d parameter is specified. Therefore, the input data to be loaded must have been indexed. The WRITER.MVS.JOBNAME.DATASET.FORMS.ARD.ind, WRITER.MVS.JOBNAME.DATASET.FORMS.ARD.out, and if applicable, WRITER.MVS.JOBNAME.DATASET.FORMS.ARD.res files produced by the indexer must exist in the directory specified by the -d parameter before the ARSLOAD program is started.

Not all indexers can accept an input file from the HFS. Files should not be placed in a -d directory that require one of those indexers, such as ACIF.

You can specify the -d parameter more than once, to specify multiple file systems for the ARSLOAD program to process.

You cannot specify the -i, -n, or -v parameters when you specify the -d parameter.

-D dest
Allows the specification of a destination to use for SYSOUT selection. If specified, the ARSLOAD program will select and process only the SYSOUT for the specified destination.
-e
Specify this parameter to allow the ARSLOAD program to process loads that contain empty document files. If you specify the -n parameter with the -e parameter, the empty file is retained after processing, however no data is loaded into Content Manager OnDemand. If you are running the ARSLOAD program as a daemon with the -e parameter, the empty file will not cause an error and the ARSLOAD daemon will not exit.
-E
When specified, exits that are associated with the ARS.RSADUPDT logical exit point are to be invoked. If the -E parameter is not specified, then the exit routines are not invoked. The exit routines may be used to modify some of the parameters that are used by Content Manager OnDemand when document data is being captured (loaded) by the ARSLOAD program, such as the name of the application group, application, or storage node into which the data will be loaded. For more information, see Report Specifications Archive Definition Exit in the IBM Content Manager OnDemand for z/OS: Configuration Guide.
Note: The Report Specifications Archive Definition Exit requires that the input file (loadFilename) must exist. Otherwise, the ARSLOAD program will fail with message ARS1112E - Unable to open the file <loadFilename>.
-f
Use to unload the data if the load process fails. If the database manager step fails, then Content Manager OnDemand should remove any index data that was added to the database. If the storage manager step fails, then Content Manager OnDemand should remove any storage objects that were copied to storage volumes.
Tip: If an input file fails to load, you should review the message log that was created during the load process. You can retrieve a message log from the system log. If the message log contains a Load ID, then it means that for some reason, Content Manager OnDemand stored at least some of the input data in the application group. Before you attempt to reload the input data, you must remove the data that was created during the failed load process by using the UNLOAD function of the ARSADMIN program. See ARSADMIN for help with removing the data that is created when a file is loaded into the system.
-F form
Specifies the JES FORM name that the ARSLOAD program monitors for input data to process when running as a started task.
-g applGroup
The name of the application group to load. This parameter is required if you specify a load file name to process. This parameter is optional if you specify the -d parameter. If you specify the -d parameter, then by default, the ARSLOAD program uses the FORM component of the input file name to determine the name of the application group to load. If you plan to automate the loading of input files into different application groups and applications, then you should use the -G parameter to specify the component of the input file name that identifies the application group to load.
-G applGroupID
Determines the component of the input file name used to identify the name of the application group to load. You typically use this parameter when you run the ARSLOAD program as a started task to automate the loading of input files into different application groups and applications.
  • By default, the ARSLOAD program uses the FORM part of the file name to identify the application group to load. You can use the -G parameter to specify a different part of the file name that identifies the application group. For example, arsload -G JOBNAME.
  • If the application group to load contains more than one application (source of data), then you must identify the application to load. Otherwise, the load will fail. For example, to use the DATASET part of the file name to identify the application, run the ARSLOAD program with the -A DATASET parameter. For a started task or job, DATASET is the DD name that defines the input file.
Choose one of the WRITER, MVS, JOBNAME, DATASET, or FORM parts of the file name to identify the application group.
-h instance
The name of the Content Manager OnDemand instance to process. The ARSLOAD program will attempt to locate the specified instance name in the ARS.INI file, to obtain the TCP/IP address, host name or host name alias of the system on which the instance is running. If the ARSLOAD program cannot locate the instance name in the ARS.INI file, then the specified value is treated as a host name. Note: The ARSLOAD program also supports the -I parameter. You can use either parameter to specify the name of the instance to process. If you specify both, the value of the last parameter specified is used.
You must specify this parameter and name the instance if:
  • The name of the default instance is not ARCHIVE.
  • You are running more than one instance on the same system and you want to process an instance other than the default instance.
  • You are running the ARSLOAD program on a system other that the system on which the instance that you want to process is running.
Note: If you are running multiple instances of Content Manager OnDemand on the same system, then you should always specify the -h parameter to identify the name of the instance that you want to process. You should also verify that the ARS.INI file is configured with the correct information for all instances of Content Manager OnDemand. See the IBM Content Manager OnDemand for z/OS: Configuration Guide for more information about working with multiple instances of Content Manager OnDemand.
-i
Use to run the data indexing program only; do not copy report data to storage volumes or add the index data to the database.
-I instance
The name of the Content Manager OnDemand instance to process. The ARSLOAD program will attempt to locate the specified instance name in the ARS.INI file, to obtain the TCP/IP address, host name or host name alias of the system on which the instance is running. If the ARSLOAD program cannot locate the instance name in the ARS.INI file, then the specified value is treated as a host name.Note: The ARSLOAD program also supports the -h parameter. You can use either parameter to specify the name of the instance to process. If you specify both, the value of the last parameter specified is used.
You must specify this parameter and name the instance if:
  • The name of the default instance is not ARCHIVE.
  • You are running more than one instance on the same system and you want to process an instance other than the default instance.
  • You are running the ARSLOAD program on a system other that the system on which the instance that you want to process is running.
If you are running multiple instances of Content Manager OnDemand on the same system, then you should always specify the -I parameter to identify the name of the instance that you want to process. You should also verify that the ARS.INI file is configured with the correct information for all instances of Content Manager OnDemand. See the IBM Content Manager OnDemand for z/OS: Configuration Guide for more information about working with multiple instances of Content Manager OnDemand.
-j parmFile
Use to specify the name of a file that contains additional indexing parameters. Each line (or record) in the file represents one complete indexing parameter, including keywords and data values.

When you specify the -j parameter and name a file, the ARSLOAD program adds the indexing parameters from the specified file to the indexing parameters that it extracts from the application. (Indexing parameters are typically specified on the Indexing Information page in the application.) If an indexing parameter appears in both the application and the file that you specify, then the ARSLOAD program uses the value from the file.

For IBM® Content Manager OnDemand for z/OS®, if the parmFile starts with //DD:name, "name" specifies the name of a DD statement in the ARSLOAD JCL. Otherwise, the parmFile specifies a file in the Unix System Services file system.

The following shows an example of a file that contains additional indexing parameters to be processed by ACIF:
FORMDEF=F1ABBB0
PAGEDEF=P1ABBB0
USERLIB=HLQ.SAPKULI1
The following shows an example of the -j "//DD:name" parameter, and some instream indexing instructions: 
-j "//DD:PD"
  	  |
 	//PD  DD  *	
	 FIELD5=X'F1F061F3F161F0F5'   /* 10/31/05 */
	 INDEX6=X'D7D6E2E3C9D5C76DC4C1E3C5',FIELD5,(TYPE=GROUP,BREAK=NO)
-J file name delimiter
Use this parameter to define file name formats for MVS download files and files that are processed by the ARSLOAD daemon. By default, this parameter is "."
-K
Specifies that ARSLOAD should not detach ARSADMIN. Normally, ARSLOAD attaches and detaches ARSADMIN several times for each file loaded. If you specify -K, ARSLOAD does not detach ARSADMIN. This may improve performance by not requiring the LE enclave associated with ARSADMIN to be constantly created or destroyed. In addition, if ARSLOAD is running without TCP/IP, the Db2® connection can persist.
Restriction: Do not specify the -K parameter if you are using any 390 Indexer exits until you verify that the exits function correctly in this environment. In particular, the LE enclave is no longer terminated between reports. This impacts exits that rely on enclave termination to perform cleanup, for example, closing files.
-l fieldID
Indicates that the ARSLOAD program will capture and place the entire name of the input file into the field identifier specified in the fieldID variable.
-n
Determines whether Content Manager OnDemand deletes the input files when the ARSLOAD program ends.
  • If you specify the -n parameter, then Content Manager OnDemand does not delete the input files when the ARSLOAD program ends.
  • If you do not specify the -n parameter, then Content Manager OnDemand deletes the input files when the ARSLOAD program ends.

In either case, if the ARSLOAD program fails in the load step because of a device or system problem, then you can restart the load step after you correct the problem by using the intermediate files that were created by the ARSLOAD program. The ARSLOAD program stores the intermediate files in the directory named with the -c parameter (or the directory from which you started the ARSLOAD program, if you did not specify the -c parameter). The intermediate files have the same name as the original input file.

-p password
The password for the user specified with the -u parameter. If the user is not assigned a password, enter a null password (that is, specify -p "").
-s ddname
Specifies a DD name in the JCL that identifies the input data set for ACIF, the OS/390®, or the IBM Content Manager OnDemand PDF Indexer for Multiplatforms. Not supported by the Generic indexer. This parameter should be specified when the ARSLOAD program is invoked with a load file name.

The -s parameter causes the ARSLOAD program to pass the associated DD name to the indexing program as the value of the INPUTDD parameter. Because none of the indexers can accept input from the HFS (except for the Generic indexer, which really does not perform indexing), you must specify the -s parameter. For the Generic indexer, input files must be in the HFS; they cannot be specified by using the -s parameter.

-t seconds
Determines the polling time in seconds. This is the interval of time in which the ARSLOAD program checks the input directories for input files to process. The default value is 600 seconds, which means that the ARSLOAD program checks the input directories every ten minutes.
-u userid
The userid of a Content Manager OnDemand user with administrator authority for the application group. The user must have permission to add documents to the application group.

If you omit the -u parameter, and the ARS.PTGN dynamic exit has been enabled, your user ID as returned by UNIX System Services will be used, provided that you also omit the -p parameter.

The IBM Content Manager OnDemand for z/OS: Configuration Guide describes how to enable the ARS.PTGN exit.

-V fileName
Specifies the name of the file that contains the keywords and values that are to be used by ARSLOAD. Each line is used for a single keyword or value. Trailing blanks are stripped, and lines should not have sequence numbers. Single and double quotations marks in lines that start and end with single or double quotation marks (" or ') are removed. The first line becomes the first keyword or value, and the second line becomes the second keyword or value, continuing until the input file is exhausted. The parmfile is in the format acceptable to the fopen() C-runtime function call. For example, to specify a DD statement called PARM, you can use //DD:PARM
-v
Enables verbose mode, which displays all messages (informational and error). By default, the ARSLOAD program displays error messages.
-W writer
Specifies the JES WRITER that the ARSLOAD program monitors for input files to process when running as a started task.
-X indexer
Allows you to override the indexing program that was specified on the Indexer Information page in the application.
The possible values are A, G, X, and 3:
  • Specify -X A to use ACIF.
  • Specify -X G to use the Content Manager OnDemand Generic indexer.
  • Specify -X X to use the Content Manager OnDemand XML indexer.
  • Specify -X 3 to use the Content Manager OnDemand 390 indexer.
You must specify an indexing program if the input contains index data in a format other than the one supported by the indexing program that was specified for the application. For example, assume that you defined an application and specified ACIF as the indexing program. Later, you used the ARSDOC program to extract documents from an application group. The ARSDOC command generates index data that is in the Generic indexer format. To load the index data into the application, you must specify: 
arsload -X G . . .
loadFilename
Specifies an input file to process.

You may specify the names of one or more input files to process. If you specify more than one input file, separate the file names with a blank character.

The ARSLOAD program appends the following file type extensions to the file name that you specify: .ind, .out, .res, .ann, and .ang
  • The .ind file contains the index data
  • The .out file contains the report data
  • The .res file contains the resource data
  • The .ann file contains text annotations
  • The .ang file contains graphic annotations
For example, if you specify arsload -g BILLS po3510, the ARSLOAD program looks for and processes the following files:
  • po3510.ind
  • po3510.out
  • po3510.res
  • po3510.ann
  • po3510.ang
The file extensions on all .ind, .out, .res, .ann, and .ang files must be lowercase. File names with extensions .IND, .OUT, .RES, .ANN, and .ANG will not be processed.

If the ARSLOAD program does not find a file with the .ind file type extension, it automatically calls the indexing program to process the input file.

If you specify the -s parameter, then specify /dev/null for the loadFilename parameter.

Tip: If you do not specify a load file name, the ARSLOAD program can use the following sources for input files to process:
  • one or more classes specified with the -C parameter,
  • one or more file systems specified with one or more -d parameters,
  • a destination that is specified with the -D parameter,
  • a FORM name that is specified with the -F parameter, or
  • a WRITER name that is specified with the -W parameter.
If you omit the load file name, the ARSLOAD program will run in daemon mode and attempt to load input data from the JES spool (if any of the JES spool options -C, -D, -F, or -W were specified) or poll the directories that are specified by the -d parameter for input data to process. If you omit the load file name and you do not specify at least one of the daemon mode parameters (-C, -D, -F, -W, or -d), the ARSLOAD program will issue a usage note and exit.
-1 trace_file
Specify a fully qualified trace file name as directed by IBM Software Support.
-2 level
Specify a value as directed by IBM Software Support.