3.6 usrconf.cfg (Option definition file for batch applications)

Organization of this section
(1) Format
(2) File storage location
(3) Functionality
(4) Defined values
(5) Specifiable keys

(1) Format

Specify the key as follows:

key-name=value

How to specify:
  • The string up to the linefeed is a value.
  • The line beginning with a hash mark (#) is a comment.
  • If you define a line without a value, the line is ignored.
  • You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.
(Example) key-name=value#comment
  • You cannot code with a character encoding that is different from the runtime character encoding.
  • Specify the path in CJBATCHUSRCONFDIR using an absolute path.

(2) File storage location

Set up the path for the storage location of usrconf.cfg (option definition file for batch applications) in the environment variable CJBATCHUSRCONFDIR or store usrconf.cfg (option definition file for batch applications) in the directory that executes the commands used for batch applications. When you execute the commands used for batch applications, the usrconf.cfg file (option definition file for batch applications) will be searched in the following order:

  1. Directory set in environment variable (CJBATCHUSRCONFDIR)
  2. Directory where cjexecjob command (batch application execution command) is executed

(3) Functionality

This file specifies the invocation options for JavaVM that execute batch applications.

If you change the contents of this file while a batch application is running, the changes become effective only when the batch application is started next time.

(4) Defined values

When you execute commands that are used with batch applications, the enabled options will differ depending on whether the scheduling functionality is used.

The following table describes the values defined for each command used with batch applications:

Option namecjexecjobcjkilljobcjlistjob
Scheduling functionality is not usedScheduling functionality is usedScheduling functionality is not usedScheduling functionality is usedScheduling functionality is not usedScheduling functionality is used
add.jvm.argYYNNNN
add.class.pathYYNNNN
batch.ctm.enabledYYYYYY
batch.log.directoryYYYYYY
batch.log.lockIntervalYYYYYY
batch.log.lockRetryCountYYYYYY
batch.log.maintenance.filenumYYYYYY
batch.log.maintenance.filesizeYYYYYY
batch.log.message.filenumYYYYYY
batch.log.message.filesizeYYYYYY
batch.log.stdout.enabledYYNNNN
batch.request.timeoutNYNYNY
batch.schedule.group.nameNYNYNY
batch.vbroker.agent.addrNYNYNY
batch.vbroker.agent.portNYNYNY
Legend:
Y: Option is enabled.
N: Option is disabled.

(5) Specifiable keys

The following table describes the specifiable keys and the default values:

Note
If you use multibyte characters within the file, integrate the multibyte characters and encode used in the following locations:
  • usrconf.cfg (option definition file for batch servers)
  • Arguments of the cjexecjob command (batch application execution command)
  • Source code of the batch application (java.lang.System.out or java.lang.System.err)

Table 3-3 Specifiable keys and default values for usrconf.cfg (Batch applications)

Key nameContentsDefault value
add.jvm.argPass the specified value to batch application on the batch server. You can specify the following option:
  • -D<property>

You can specify the following properties:
  • java.endorsed.dirs
  • java.security.policy
  • java.class.path
  • java.library.path
Note that if you want to specify a system property, specify the value in the usrconf.properties file without using -D.
None
add.class.pathAdd the setup value to the class path of the batch application class loader on the batch server. You can specify only one JavaVM option for this key. If you specify multiple JavaVM options, add new add.class.path.
If a path containing space is specified in the value, the path need not be enclosed with double quotation mark ("). Also, values specified in double quotations are not valid.
To specify the JAR files for the container extension library, specify the add.class.path key in the option definition file for batch servers.
None
batch.ctm.enabledSpecify whether to use the scheduling functionality.
If you specify true:
The scheduling functionality will be used.
If you specify false:
The scheduling functionality will not be used.
false
batch.log.directorySpecify the output location directory of the log file. Specify the path of the log output location with absolute path or the relative path. You can specify following characters:
  • Single byte alphanumeric character
  • Underscore (_)
  • Hyphen (-)
  • Path demarcation character
When the path (including the absolute and relative path up to the current directory when the relative path is specified) that exceeds 180 bytes is specified, a message KDJE40059-W is output, and hence the default value is used. When the default value exceeds 180 bytes, log initialization fails and terminates abnormally. When there is no access permission to directory, or when the file name is specified, a message KDJE55039-W is output and command ends.
In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk.
Cosminexus-installation-directory\CC\batch\logs
batch.log.lockIntervalSpecify the retry interval (unit: milliseconds) as integers from 0 to 2147483647​ for failure in an attempt of exclusive processing of log files. If 0 is specified, an error occurs immediately.
The commands in batch applications are used to output the KDJE55042-E message and terminate the process.
In Windows, specify the value acquired by multiplying the batch.lockRetryCount value and batch.log.lockInterval value in a range from 0 to 2147483647​.
In Windows use the value acquired by multiplying the batch.log.lockRetryCount value and batch.log.lockInterval value as the wait time of exclusive process.
10
batch.log.lockRetryCountIf the exclusive process of the log file fails, specify the retry frequency (unit: times) in integers from 1 to 2147483647​.
The commands in batch applications are used to output the KDJE55042-E message and terminate the process.
1000
batch.log.maintenance.filenumSpecify the number of log files for saving commands to be used in batch applications.
Specify integers from 1 to 64. To change the number of files, stop all commands used in the batch application that are output to the corresponding log files (cjexecjob, cjkilljob, and cjlistjob) and move or delete the log files and the log management files under the mmap directory to another directory.
2
batch.log.maintenance.filesizeSpecify the file size (unit: bytes) of the log file for saving commands to be used in batch applications.
Specify integers from 4096 to 16777216​. To change the size, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
1048576​
batch.log.message.filenumSpecify the number of message log files of the commands to be used in batch applications.
Specify integers from 1 to 64. To change the number of files, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
2
batch.log.message.filesizeSpecify the file size (unit: bytes) of the message log file of the commands to be used in batch applications.
Specify integers from 4096 to 16777216​. To change the size, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
1048576​
batch.log.stdout.enabledSpecify whether to output the messages issued by the batch job input command, with the standard output of batch execution commands.
If you specify true:
Output the message in the standard output.
If you specify false:
Do not output the message in the standard output.
true
batch.request.timeoutSpecify from 0 to 2147483647​ (unit: seconds) as a timeout value for the communication between batch execution commands and batch servers. If you specify 0, the operation continues to wait infinitely.0
batch.schedule.group.nameSpecify a string of 1 to 63 characters having alphanumeric characters and underscore (_) as the schedule group name of batch servers.JOBGROUP
batch.vbroker.agent.addrSpecify the IP address that OSAgent is using. You specify this key in the environment in which multiple IP addresses are distributed.None
batch.vbroker.agent.portSpecify an integer from 1 to 65535 as the port number for connecting to OSAgent.14000