13.3.3 Details on settings in the environment-settings file (ajs3web.conf)
This subsection describes the details on the format of settings and the items to be set in the environment-settings file (ajs3web.conf).
- Organization of this subsection
(1) File storage directory
The following describes the folders for storing the file ajs3web.conf and the model file ajs3web.conf.model.
(a) Model file storage folder
The following shows the folder storing the ajs3web.conf.model file.
/etc/opt/jp1ajs3web/conf/
(b) ajs3web.conf file storage folder
The following shows the directory storing the ajs3web.conf file.
/etc/opt/jp1ajs3web/conf/#
- #:
-
In a cluster configuration, the file name is as follows:
shared-directory/jp1ajs3web/conf
(2) File-editing procedure
The procedure for editing the ajs3web.conf file varies between the case in which the size and number of log files are to be changed and the case in which other setting items are to be changed.
(a) Procedure for changing the size and number of log files
To change the size and number of log files, you must delete all application server logs and the files related to the logs before editing the ajs3web.conf file.
The following describes the procedure for changing the size and number of log files:
-
Execute the following command to stop the HTTP and web application servers.
/etc/opt/jp1ajs3web/jajs_web_stop
-
Make backups of all log files found in any directory.
-
Delete the following files:
-
All application server log files
-
appserver.mm file in the mmap directory that is in the directory storing application server log files
-
-
Back up the ajs3web.conf file, and store the backup file in any directory.
-
Copy the model file (ajs3web.conf.model), and then rename the copy of the file to ajs3web.conf.
-
Open the ajs3web.conf file by using a text editor such as vi.
-
Modify the definitions to be changed.
-
Save the ajs3web.conf file.
-
Execute the following command to start the HTTP and web application servers.
/etc/opt/jp1ajs3web/jajs_web
(b) Procedure for changing items other than the size and number of log files
The following describes the procedure for changing items other than the size and number of log files:
-
Execute the following command to stop the HTTP and web application servers.
/etc/opt/jp1ajs3web/jajs_web_stop
-
Back up of the ajs3web.conf file, and store the backup file in any directory.
-
Copy the model file (ajs3web.conf.model), and then rename the copy of the file to ajs3web.conf.
-
Open the ajs3web.conf file by using a text editor.
-
Modify the definitions to be changed.
-
Save the ajs3web.conf file.
-
Execute the following command to start the HTTP and web application servers.
/etc/opt/jp1ajs3web/jajs_web
(3) When the setting takes effect
When the JP1/AJS3 Web Application Server service starts
(4) Format
The following shows the format of settings in the ajs3web.conf file:
[] HNTR_LOG_LEVEL=level-of-the-message-to-be-output-to-integrated-trace-log HNTR_LOG_LANG=language-type-of-the-message-to-be-output-to-integrated-trace-log SYS_LOG_LEVEL=level-of-the-message-to-be-output-to-syslog COM_LOG_SIZE=size-of-a-command-log-file COM_LOG_LEVEL=level-of-the-message-to-be-output-to-command-log COM_LOG_NUM=number-of-command-log-files COM_LOG_LANG=language-type-of-the-message-to-be-output-to-command-log SERVER_LOG_SIZE=size-of-an-application-server-log-file SERVER_LOG_LEVEL=level-of-the-message-to-be-output-to-application-server-log SERVER_LOG_NUM=number-of-application-server-log-files SERVER_LOG_LANG=language-type-of-the-message-to-be-output-to-application-server-log PFM_URL=URL-to-access-PFM-Web-Console EXECUTION_PROHIBITED_DISPLAY_FORMAT=display-format-of-prohibited-execution-of-a-root-jobnet-registered-for-planned-execution [host-name-or-IP-address-of-destination-JP1/AJS3-Manager-host] TIMEZONE=time-zone-of-destination-JP1/AJS3-Manager SUMMARY_MAX_COUNT=maximum-number-of-monitoring-targets-on-Web-GUI HOSTNAME_ALIAS_FOR_PFM=JP1/AJS3-Manager-host-alias-name-to-be-passed-to-PFM-Web-Console [host-name-or-IP-address-of-destination-JP1/AJS3-Manager-host] :
When writing a comment on a line, begin the comment line with a semicolon (;).
(5) Setting items
The following describes the items to be set. Delimit each item by using a linefeed.
(a) HNTR_LOG_LEVEL
Specify the level of the messages to be output to the integrated trace log.
- Specifiable values
-
- none
-
No message is output.
- error
-
Error messages are output.
- warn
-
Error and warning messages are output.
- info
-
Error, warning, and information messages are output.
- Default value
-
info
- Recommended value
-
Default value
(b) HNTR_LOG_LANG
Specify the language type of the messages to be output to the integrated trace log.
- Specifiable values
-
- system
-
Messages are output in the language type set in the OS.
If the encoding set in the OS is not English ASCII, UTF-8, or SJIS, English ASCII is used.
- C
-
Messages are output by using English ASCII encoding.
- ja_JP.UTF-8 or ja_JP.utf8
-
Messages are output by using UTF-8 encoding.
- ja_JP.SJIS# or ja_JP.sjis#
-
Messages are output by using Shift-JIS encoding.
- #:
-
Can be used only in SUSE Linux.
- Default value
-
system
- Recommended value
-
Set the value appropriate for the operating environment.
(c) SYS_LOG_LEVEL
Specify the level of the messages to be output to syslog.
- Specifiable values
-
- none
-
No message is output.
- error
-
Error messages are output.
- warn
-
Error and warning messages are output.
- info
-
Error, warning, and information messages are output.
- Default value
-
info
- Recommended value
-
Default value
(d) COM_LOG_SIZE
Specify the size of a command log file.
- Specifiable values
-
4 to 16,384 (units: kilobytes)
- Default value
-
128
- Recommended value
-
Default value
(e) COM_LOG_LEVEL
Specify the level of the messages to be output to the command log.
- Specifiable values
-
- none
-
No message is output.
- error
-
Error messages are output.
- warn
-
Error and warning messages are output.
- info
-
Error, warning, and information messages are output.
- Default value
-
info
- Recommended value
-
Default value
(f) COM_LOG_NUM
Specify the number of command log files.
- Specifiable values
-
1 to 16 (units: files)
- Default value
-
2
- Recommended value
-
Default value
(g) COM_LOG_LANG
Specify the language type of the messages to be output to the command log.
- Specifiable values
-
- system
-
Messages are output in the language type set in the OS.
If the encoding set in the OS is not English ASCII, UTF-8, or SJIS, English ASCII is used.
- C
-
Messages are output by using English ASCII encoding.
- ja_JP.UTF-8 or ja_JP.utf8
-
Messages are output by using UTF-8 encoding.
- ja_JP.SJIS# or ja_JP.sjis#
-
Messages are output by using Shift-JIS encoding.
- #:
-
Can be used only in SUSE Linux.
- Default value
-
system
- Recommended value
-
Set the value appropriate for the operating environment.
(h) SERVER_LOG_SIZE
Specify the size of an application server log file.
- Specifiable values
-
4 to 16,384 (units: kilobytes)
- Default value
-
8,192
- Recommended value
-
Default value
(i) SERVER_LOG_LEVEL
Specify the level of the messages to be output to the application server log.
- Specifiable values
-
- none
-
No message is output.
- error
-
Error messages are output.
- warn
-
Error and warning messages are output.
- info
-
Error, warning, and information messages are output.
- Default value
-
info
- Recommended value
-
Default value
(j) SERVER_LOG_NUM
Specify the number of application server log files.
- Specifiable values
-
1 to 16 (units: files)
- Default value
-
2
- Recommended value
-
Default value
(k) SERVER_LOG_LANG
Specify the language type of the messages to be output to the application server log.
- Specifiable values
-
- system
-
Messages are output in the language type set in the OS.
If the language type set in the OS is neither Japanese nor English, English is assumed to be specified.
- ja
-
Messages are output in Japanese.
- en
-
Messages are output in English.
- Default value
-
system
- Recommended value
-
Set the value appropriate for the operating environment.
(l) PFM_URL
Specify the URL of the PFM - Web Console login screen.
- Specifiable values
-
communication-protocol://host-name-or-IP-address-of-PFM-Web-Console-host:port-number/PFMWebConsole/login.do
The following describes the values that can be specified for the variables in communication-protocol://host-name-or-IP-address-of-PFM-Web-Console-host:port number:
- communication-protocol
-
Specify http or https as the communication protocol.
- host-name-or-IP-address-of-PFM-Web-Console-host
-
Specify the host name or IP address of the PFM - Web Console host.
- port-number
-
Specify the number of the port to be used for communication with PFM - Web Console. The default is 20358.
- Default value
-
None.
- Recommended value
-
Set the value appropriate for the operating environment.
(m) EXECUTION_PROHIBITED_DISPLAY_FORMAT
Specify the display format of prohibited execution of a root jobnet registered for planned execution.
- Specifiable values
-
- yes
-
If the execution of a root jobnet registered for planned execution is prohibited, No (Previous execution prohibited) is displayed for Change plan on the following screens and in the following dialog box:
-
List screen
-
Monthly Schedule screen
-
Detail Information dialog box
-
- no
-
If the execution of a root jobnet registered for planned execution is prohibited, Yes (Execution prohibited) is displayed for Change plan on the following screens and in the following dialog box:
-
List screen
-
Monthly Schedule screen
-
Detail Information dialog box
-
- Default value
-
no
- Recommended value
-
Set the value appropriate for the operating environment.
(n) Host name or IP address of destination JP1/AJS3 - Manager instance
Specify the host name or IP address of the destination JP1/AJS3 - Manager instance.
- Specifiable values
-
Character string of 255 bytes or less
- Default value
-
None.
- Recommended value
-
Set the value appropriate for the operating environment.
(o) TIMEZONE
Specify the time zone of the physical or logical host of the destination JP1/AJS3 - Manager instance.
You need to specify this item when the time zone of the destination JP1/AJS3 - Manager instance differs from the time zone of the Web Console server.
- Specifiable values
-
Time zone IDs that can be obtained by using the ajswebtz.bat command
When this item is not specified, the time zone setting in the OS is applied.
For details about the ajswebtz.bat command, see ajswebtz (Linux only) in 3. Commands Used for Normal Operations in the JP1/Automatic Job Management System 3 Command Reference.
- Default value
-
Time zone setting in the OS
- Recommended value
-
Set the value appropriate for the operating environment.
(p) SUMMARY_MAX_COUNT
Specify the maximum number of monitoring targets that can be listed on the Dashboard screen of the Web GUI. You can register a maximum of 20 root jobnets as monitoring-target units per monitoring-target setting.
- Specifiable values
-
1 to 20 (units: monitoring-target units)
- Default value
-
5
- Recommended value
-
Default value
(q) HOSTNAME_ALIAS_FOR_PFM
If a JP1/AJS3 - Manager host to be monitored by JP1/PFM is specified with an alias rather than the actual host name, specify the alias that will be passed to PFM - Web Console.
- Specifiable values
-
Character string of 255 bytes or less
- Default value
-
None.
- Recommended value
-
Set the value appropriate for the operating environment.
(6) Examples
The following shows an example of definitions in the ajs3web.conf file:
[] HNTR_LOG_LEVEL=info HNTR_LOG_LANG=system SYS_LOG_LEVEL=info COM_LOG_SIZE=128 COM_LOG_LEVEL=info COM_LOG_NUM=2 COM_LOG_LANG=system SERVER_LOG_SIZE=8192 SERVER_LOG_LEVEL=info SERVER_LOG_NUM=2 SERVER_LOG_LANG=system EXECUTION_PROHIBITED_DISPLAY_FORMAT=no [ManagerHostA] TIMEZONE=Asia/Tokyo SUMMARY_MAX_COUNT=5 [ManagerHostB] TIMEZONE=America/New_York SUMMARY_MAX_COUNT=5
(7) Notes
-
Do not change the settings of items other than those explained herein.
-
Do not insert a space before or after the equal sign in a definition line.
-
Do not enter a linefeed in the middle of a definition line.
-
If you specify a value for an item that cannot be set, the line including the item will be ignored.
-
If an item to be set is not found, the default specification for that item is assumed for operation.
-
If a setting is invalid, the JP1/AJS3 Web Application Server service cannot start.
-
The definition keys of setting items are not case sensitive, but set values are case sensitive.
-
If the same setting item is defined on multiple lines, only the first line defining the setting item is valid.