Configuring ARS.CFG parameters

You can use various ARS.CFG file parameters to customize ODF for your installation.

For ODF running on all platforms except Windows, you modify these parameters by editing the ARS.CFG file. For ODF running on a Windows server, these parameters are updated by using the OnDemand Configurator.

Table 1. Supported parameter case in ARS.CFG
Operating system Supported parameter case in ARS.CFG
Multiplatforms servers Parameters must be specified in uppercase.
z/OS® servers Parameters can be specified in uppercase, lowercase, or mixed case.
IBM® i servers Parameters must be specified in uppercase.

If you are upgrading from a previous version of ODF, review the list of ARS.CFG file parameters that are no longer supported.

Task management

ARS_JAVA_CMD
Specifies the installed Java™ executable program on your Content Manager OnDemand server. For example: ARS_JAVA_CMD=/usr/java7_64/jre/bin/java
ARS_USER_EXITS_DIR
Specifies the directory where your compiled user exit programs are located.
z/OS only:ARSODF_BANNER_ALLOC_PARMS
For z/OS, specifying a value for the ARSODF_BANNER_ALLOC_PARMS parameter causes all banner data to be created in a sysout data set that is separate from the report. The CLASS, DEST, FORMS, and WRITER parameter values are inherited from the distribution, or from the report bundle definitions if specified. If the ARSODF_BANNER_ALLOC_PARMS parameter is not specified, the banner is created in the same sysout as the report.
z/OS only:ARSODF_DATASET_HLQ
For z/OS, specifies the high-level qualifier to use for non-GDG data set allocation if a File name location is not specified in the distribution or report bundle definition. The default value is ARSODF.
z/OS only:ARSODF_DEFAULT_VARIABLE_LRECL
For z/OS, specifies the logical record length (LRECL) value passed to the open routine when JES opens the sysout data set. The default value that is passed to the open routine is 32756. The LRECL that JES actually allocates might be different than this value.
ARSODF_DISTRIBUTION_THRESHOLD
Specifies the maximum number of distributions that ODF can process at one time. The default value is 0, which indicates that there is no maximum.
ARSODF_EXPIRE_DAYS
ODF routine maintenance removes all entries from the ARSDFPPT, ARSDFDRT, and ARSDFDST ODF operational tables that are older than the number of days specified. If the ARSODF_EXPIRE_DAYS parameter is not specified, then the ARSMAINT program uses 30 days as the default value.
 Windows only:Linux only:AIX only:IBM i only:ARSODF_FILE_LOCATION
For any Multiplatforms or IBM i server, specifies a default path name for a distribution with a Location specified as File if a File name location is not specified in the distribution or report bundle definition. If the ARSODF_FILE_LOCATION parameter is not specified, then the path that is specified by the ARS_TMP parameter in the ARS.CFG file is used.
z/OS only:ARSODF_JESS
For z/OS, JESS must be a string that identifies the JES subsystem name (4 characters). This parameter is used with the Address Space Create dynamic JOB START facility. Valid options are:
  • JES2
  • JES3
  • No entry
An invalid entry is indicated by an error display message, and the default is applied.
z/OS only:ARSODF_JOB_TRACEDIR
For z/OS, specifies the directory name that contains the trace file if trace is active in ARSODF and when Job Name is specified in the distribution definition.
z/OS only:ARSODF_JOBSPACE
For z/OS, indicates how the newest address spaces are classified. A value of 1 specifies that address spaces are assigned the normal job space attribute. A value of 0 specifies that address spaces are assigned the system address space attribute. The default is 0.
This parameter allows address spaces to be classified as normal job spaces rather than as system address spaces. The difference is that system address spaces are not displayed in response to the D A,L operator command. Normal job spaces are displayed.
z/OS only:ARSODF_MANIFEST_ALLOC_PARMS
For z/OS, specifies allocation parameters to use when a manifest is created in a sysout data set that is separate from the report. The CLASS, DEST, FORMS, and WRITER parameter values are inherited from the distribution, or from the report bundle definitions if specified. If the ARSODF_MANIFEST_ALLOC_PARMS parameter is not specified, the manifest is created with the same allocation parameters as the report.
z/OS only:ARSODF_MAXJOBS
For z/OS, enter a number from 1 through 99. Specifies the number of concurrent print processes that are allowed to be started as submitted jobs. A conservative setting for this parameter is 5. An aggressive setting for this parameter is between 10 and 20.
z/OS only:ARSODF_ODFMSG_ALLOC_PARMS
For z/OS, specifies the output parameters used to allocate the JES spool file data set for the ODF Message file. The default value is 'CLA(A)'
ARSODF_PRINTTASKS
Specifies the number of parallel report bundle processor subtasks that are attached. The value can be 1 - 15 numeric digits. For most installations, this value should never exceed 40.
z/OS only:ARSODF_PROC
For z/OS, this parameter names the procedure to be invoked whenever the distribution requirement calls for a print process to be executed as a submitted job. The procedure can be stored in SYS1.PROCLIB, or it can be stored in some other proclib that is known to the Master Scheduler. You can customize the ARSRPSUB procedure that is provided in ARS.V10R5M0.SARSINST.
ARSODF_TMP
Specifies the directory ODF should use for temporary files that are created during the document retrieval process. The default value is /tmp.
ARSODF_TRANSFORM_XML
Specifies the location and name of the transform definition file that ODF should use if transform is specified in distributions. See Verifying the ARSXFORM.XML file for an explanation of the arsxform.xml file.

Timing controls

ARSODF_CONTSLEEP
Must be followed by 1 - 15 numeric digits to specify the time, in seconds, that the continuation thread waits between processing.
The default for this keyword is 600 seconds, which is 10 minutes. The continuation sleep setting requires experimental adjustment based on the nature of distribution scheduling methods that are established in the distribution create process. A high volume of Time of Print distribution scheduling methods can dictate a more frequent need for processing.
ARSODF_DISTSLEEP
Must be followed by 1 - 15 numeric digits to specify the time, in seconds, that the distribution thread waits between one pass of submitting distributions for report bundle processing and the next.
The default for this keyword is 300 seconds, which is 5 minutes. This keyword controls the downtime between scheduling distributions for report bundle processing. All scheduled distributions are analyzed for available reports to submit for report bundle processing, so it is necessary to process distributions in a timely manner.
Tip: Three hundred seconds is a good place to start. A high volume of distributions might dictate a much faster setting, perhaps less than one minute. Despite a faster distribution setting, when there is no work to be done the cycle becomes inactive quickly.
z/OS only:ARSODF_JOBSLEEP
For z/OS, must be followed by 1 - 15 numeric digits to specify the time, in seconds, that the ARSRPSUB address space(s) will remain up before terminating, if they are inactive when there is no outstanding work to perform.
The default for this keyword is 300 seconds, which is 5 minutes.
ARSODF_SCHDSLEEP
Must be followed by 1 - 15 numeric digits to specify the time, in seconds, that the scheduler thread is inactive when there is no outstanding work for it to perform.
The default is 300 seconds, which is 5 minutes. This keyword determines the frequency of the distribution scheduling process. The scheduler thread is responsible for scheduling distributions with a scheduling method of All Ready, Time of Day, and Time of Print. If most of the distributions are of the Loaded distribution scheduling method type, then the scheduler can run infrequently, for example, hourly or even every two hours. The All Ready, Time of Day, and Time of Print distribution scheduling methods require more frequent scheduling.

OAM parameters

z/OS only:ARSODF_OAM_PLAN
For z/OS, specifies the name of the OAM Db2® application plan to be used. The operand string is required to be a non-null character string with no embedded blanks, less than or equal to 8 characters in length. The default is CBRIDBS.
z/OS only:ARSODF_OAM_SLOW_TASKS
For z/OS, determines the number of task control blocks (TCBs) started to handle connections to OAM for retrievals from objects with a slow retrieval time as defined by the ARSODF_OAM_SLOW_THRESHOLD parameter. If the value specified for this parameter is 0, no TCBs are dedicated for slow retrievals and all retrievals are processed by the TCBs that are associated with the ARSODF_OAM_TASKS parameter.
The default is 0. The ARSODF_OAM_SLOW_TASKS TCBs are in addition to the ARSODF_OAM_TASKS TCBs and use additional Db2 connections.
z/OS only:ARSODF_OAM_SLOW_THRESHOLD
For z/OS, specifies the threshold at which OAM retrievals are processed by the TCBs that are associated with the ARSODF_OAM_SLOW_TASKS parameter. If the estimated retrieval time for an object (as indicated by QELQERRT) is greater than or equal to the value of the ARSODF_OAM_SLOW_THRESHOLD parameter, the OSREQ RETRIEVE is processed by an ARSODF_OAM_SLOW_TASKS TCB.
The default value is 0. See the Object Access Method Application Programmer's Reference for other valid QELQERRT values. An ARSODF_OAM_SLOW_THRESHOLD value of 0 along with a nonzero ARSODF_OAM_SLOW_TASKS value causes all OAM retrieve requests to be processed by the ARSODF_OAM_TASKS TCBs.
z/OS only:ARSODF_OAM_TASKS
For z/OS, specifies the number of OAM service threads that need to be established. The operand should be a non-negative decimal integer, less than or equal to 30. A value of 0 implies that OAM services initialization should not be performed. The default is 0.

No longer supported

The following parameters are no longer required or supported. If these parameters are specified, they are ignored.

  • ARSODF_DOC_RETRIEVAL_TRACE
  • ARSODF_NUM_OAMSRVR
  • ARSODF_OAMSSID
  • ARSODF_ODFMSG_MANAGER
  • ARSODF_PDF_DIRECTORY
  • ARSODF_PRINT_PROCESSING_TRACE
  • ARSODF_REMOTE_DB
  • ARSODF_SECURITY_EXIT_FLAG
  • ARSODF_SECURITY_EXIT_PROGRAM
  • ARSODF_TEST
  • ARSODF_TRACE_REPORTID