7.2.1 List of environment setting parameters
- Organization of this subsection
(1) Defining the environment setting parameters
You define the environment setting parameters in system environment files and job environment files. For details about these files, see 2.6.1 Specifying the environment files.
The parameters that can be specified in a system environment files and a job environment file are the same. The following table shows the specification values that take effect depending on whether the system environment file and job environment file are specified:
|
System environment file |
Job environment file |
|
|---|---|---|
|
Omitted |
Specified |
|
|
Omitted |
Each parameter's default value |
Values specified in the job environment file |
|
Specified |
Values specified in the system environment file |
Depends on the parameter specifications# |
- #
-
If the same parameter is specified in both, it is handled as described in the following:
-
Environment setting parameters that can be specified only once in a file
The specification in the job environment file takes effect.
-
Environment setting parameters that can be specified more than once in a file
JP1/Advanced Shell merges all the specifications of the parameter beginning with the specifications in the job environment file.
- Example:
-
Specifications in the system environment file
#-adsh_conf PATH_CONV /jp1as/abc c:\\jp1as\\abc
#-adsh_conf PATH_CONV /jp1as/def c:\\jp1as\\def
- Specifications in the job environment file
-
#-adsh_conf PATH_CONV /jp1as/abc c:\\jp1as\\ghi
#-adsh_conf PATH_CONV /jp1as/def c:\\jp1as\\def
#-adsh_conf PATH_CONV /jp1as/kkk c:\\jp1as\\kkk
- The analysis results are equivalent to the following:
-
#-adsh_conf PATH_CONV /jp1as/abc c:\\jp1as\\ghi <--1.
#-adsh_conf PATH_CONV /jp1as/def c:\\jp1as\\def <--1.
#-adsh_conf PATH_CONV /jp1as/kkk c:\\jp1as\\kkk <--1.
#-adsh_conf PATH_CONV /jp1as/abc c:\\jp1as\\abc <--2.
#-adsh_conf PATH_CONV /jp1as/def c:\\jp1as\\def <--2.
-
- Notes:
-
1. Specified in the job environment file
2. Specified in the system environment file
(2) List of environment setting parameters
The following table lists and describes the environment setting parameters that are specified in the environment files of JP1/Advanced Shell. Specification of these parameters is optional.
|
Parameter name |
Definition |
Maximum number of times parameter can be specified#1 |
Changeability at the start of child jobs |
|---|---|---|---|
|
ADSHCMD_RC_ERROR |
Defines the return code to be used when an extended script command fails. |
1 |
Y |
|
ADSHCMD_RC_SUCCESS |
Defines the return code to be used when an extended script command is successful. |
1 |
Y |
|
ASC_FILE |
Defines a naming rule for accumulation files used in the coverage auto-acquisition functionality. |
1 |
-- |
|
BATCH_CVR |
Enables the coverage auto-acquisition functionality. |
1 |
-- |
|
CHILDJOB_EXT |
Defines an extension for job definition script files that are to be executed as child jobs. |
255 |
Y |
|
CHILDJOB_PGM |
Defines a program path specification that is to be executed as child jobs. |
255 |
Y |
|
CHILDJOB_SHEBANG |
Defines an executable program path for job definition script files that are to be executed as child jobs. |
255 |
Y |
|
CMDRC_THRESHOLD_DEFINE |
Defines a return code threshold for a command. This parameter can also be defined for return codes of shell scripts and child jobs. |
No limit#3 |
Y |
|
CMDRC_THRESHOLD_USE_PRESET |
Defines a return code threshold for UNIX-compatible commands. |
1 |
Y |
|
COMMAND_CONV_ARG |
Defines a rule for converting an argument in job definition scripts during command execution. |
255 |
Y |
|
ESCAPE_SEQ_ECHO_DEFAULT |
Defines the action of the echo command when the escape-character option is omitted. |
1 |
Y |
|
ESCAPE_SEQ_ECHO_HEX |
Specifies whether ASCII code characters in hexadecimal notation are to be interpreted as escape characters. |
1 |
Y |
|
EVENT_COLLECT |
Specifies whether the operation information acquisition functionality is to be enabled for job definition scripts. |
1 |
Y |
|
HOSTNAME_JP1IM_MANAGER#2 |
Specifies for the user-reply functionality the operation management server on which JP1/IM - Manager is running that is to be the destination of JP1 events. |
1 |
DN |
|
JOBEXECLOG_PRINT |
Defines the job execution log contents to be output to the standard error output when a job terminates. |
1 |
-- |
|
JOBLOG_SUPPRESS_MSG |
Defines a message whose output to job execution logs is to be suppressed. |
No limit#3 |
Y |
|
KSH_ENV_READ |
Defines whether the ENV shell variable is to be read. |
1 |
Y |
|
LOG_DIR#4 |
Defines the path name of the directory to which system execution logs are to be output. |
1 |
Y |
|
LOG_FILE_CNT#5 |
Defines the number of files to be used to back up system execution logs. |
1 |
Y |
|
LOG_FILE_SIZE#5 |
Defines the size of a file to which system execution logs are to be output. |
1 |
Y |
|
OUTPUT_MODE_CHILD |
Specifies whether a job execution log is to be output to the standard error output when a child job terminates. |
1 |
Y |
|
OUTPUT_MODE_ROOT |
Specifies whether a job execution log is to be output to the standard error output when a root job terminates. |
1 |
-- |
|
OUTPUT_STDOUT |
Defines the destination for the root job standard output. |
1 |
-- |
|
PATH_CONV |
Defines a rule for converting absolute path names. |
255 |
Y |
|
PATH_CONV_ACCESS |
Defines a rule for converting file path names in job definition scripts when files are input and output. |
255 |
Y |
|
PATH_CONV_ENABLE |
Enables the path conversion functionality. |
1 |
Y |
|
PATH_CONV_RULE (Windows only) |
Defines a rule for converting file paths. |
1 |
Y |
|
PERMISSION_SPOOLJOB_DIR (UNIX only) |
Defines permission for the spool job directory. |
1 |
-- |
|
PERMISSION_SPOOLJOB_FILE (UNIX only) |
Defines permission for the files under the spool job directory. |
1 |
-- |
|
PIPE_CMD_LAST (UNIX only) |
Defines execution processing for the last command in a pipe. |
1 |
Y |
|
SPOOL_DIR#2, #4, #6 |
Defines the spool root directory path name. |
1 |
DN |
|
SPOOLJOB_CHILDJOB |
Specifies whether a child job's spool job is to be deleted or is to be merged into the spool job of the root job when the child job terminates. |
1 |
N |
|
SPOOLJOB_CREATE |
Defines whether a spool job is to be created when a job definition script is run. |
1 |
N |
|
TEMP_FILE_DIR#4 |
Defines the path name of the directory for storing temporary files. |
1 |
Y |
|
TRACE_DIR#4 |
Defines the path name of the directory to which traces are to be output. |
1 |
Y |
|
TRACE_FILE_CNT#7 |
Defines the number of files to which traces are to be output. |
1 |
Y |
|
TRACE_FILE_SIZE#7 |
Defines the size of a file to which traces are to be output. |
1 |
Y |
|
TRACE_LEVEL |
Defines a trace output level. |
1 |
Y |
|
TRAP_ACTION_SIGTERM |
Defines the job controller's action when a forced termination request is received. |
1 |
Y |
|
UNSUPPORT_TEST (Windows only) |
Defines the handling of an unsupported conditional expression. |
1 for each condition |
Y |
|
USERREPLY_DEBUG_DESTINATION |
Defines the input source and the destination of event notification and reply-request messages during debug execution when the user-reply functionality is used. |
1 |
DN |
|
USERREPLY_JP1EVENT_INTERVAL#2 |
Defines the minimum interval at which JP1 events are to be issued by the adshecho and adshread command in the user-reply functionality. |
1 |
DN |
|
USERREPLY_WAIT_MAXCOUNT#2 |
Defines the maximum number of concurrent reply-request messages that can be output by the user-reply functionality per physical or logical host. |
1 |
DN |
|
VAR_ENV_NAME_LOWERCASE (Windows only) |
Defines whether environment variable names in lowercase letters are supported. |
1 |
Y |
|
VAR_SHELL_FUNCINFO |
Defines arrays for managing information about shell functions. |
1 |
Y |
|
VAR_SHELL_GETLENGTH |
Defines the unit for lengths when the lengths of variable values are referenced. |
1 |
Y |
- Legend:
-
Y: If a change is made when a child job starts to the setting in effect when its root job started, that change will be effective (but making such a change is not recommended).
N: If a change is made when a child job starts to the setting in effect when its root job started, that change will be ignored.
DN: When a child job starts, do not make any change to the setting in effect when its root job started. If a change is made, JP1/Advanced Shell might not operate correctly.
--: Not applicable to child jobs.
- #1
-
For a parameter that can be specified in both the system environment file and the job environment file, make sure that the total number of specifications of the parameter in both files combined does not exceed the maximum value shown in this column.
To determine whether a parameter can be specified in both the system environment file and the job environment file, see the explanations for the individual parameters.
- #2
-
To use the user-reply functionality, you must specify these parameters in the system environment file. When you make a change to these parameters in the system environment file, you must restart the user-reply functionality's management daemon or service.
Also note the following regarding the specification of these parameters:
-
Do not specify these parameters in a job environment file. If they are specified in a job environment file, the following problems might occur:
HOSTNAME_JP1IM_MANAGER: When a reply is entered or canceled with the adshchmsg command, the reply-waiting events accumulated in JP1/IM - View are not released while the user-reply functionality management's daemon or service is stopped.
USERREPLY_WAIT_MAXCOUNT: The information specified in the job environment file is ignored.
USERREPLY_JP1EVENT_INTERVAL: JP1/IM - View's processing load increases.
-
If different values are specified in the system environment file and the job environment file for the parameter shown below, the problem described below might occur. If you use the user-reply functionality, do not specify the following parameter in the job environment file:
SPOOL_DIR: Output of reply-request messages fails.
-
- #3
-
Limited by the available memory size.
- #4
-
You can use multiple environments on the same host by specifying different directories in these parameters.
- #5
-
If multiple users output system execution logs to the same file, the values of LOG_FILE_CNT and LOG_FILE_SIZE specified by the last user that started output of system execution logs become effective.
- #6
-
To inherit information to a host in a standby system during cluster operation, you must share the directory to be inherited among the multiple hosts. In this case, share at least the directory specified in this parameter among the hosts.
- #7
-
If multiple users output trace logs to the same file, the largest values specified for TRACE_FILE_CNT and TRACE_FILE_SIZE by the users become effective.
If the values of TRACE_FILE_CNT and TRACE_FILE_SIZE are changed in the environment file, the specified values are compared with the existing values for the number of trace files and file size, and whichever are larger become effective.
To reduce the number of trace files and the file size, you must delete all files from the trace folder (do not delete files from the trace folder while a job is outputting traces to those trace files).