Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 Configuration Guide

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

To Page Top

(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:

  1. Execute the following command to stop the HTTP and web application servers.

    /etc/opt/jp1ajs3web/jajs_web_stop

  2. Make backups of all log files found in any directory.

  3. 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

  4. Back up the ajs3web.conf file, and store the backup file in any directory.

  5. Copy the model file (ajs3web.conf.model), and then rename the copy of the file to ajs3web.conf.

  6. Open the ajs3web.conf file by using a text editor such as vi.

  7. Modify the definitions to be changed.

  8. Save the ajs3web.conf file.

  9. 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:

  1. Execute the following command to stop the HTTP and web application servers.

    /etc/opt/jp1ajs3web/jajs_web_stop

  2. Back up of the ajs3web.conf file, and store the backup file in any directory.

  3. Copy the model file (ajs3web.conf.model), and then rename the copy of the file to ajs3web.conf.

  4. Open the ajs3web.conf file by using a text editor.

  5. Modify the definitions to be changed.

  6. Save the ajs3web.conf file.

  7. Execute the following command to start the HTTP and web application servers.

    /etc/opt/jp1ajs3web/jajs_web

To Page Top

(3) When the setting takes effect

When the JP1/AJS3 Web Application Server service starts

To Page Top

(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
GUI_OPERATION_RESTRICTION=setting-that-determines-whether-the-operation-restriction-function-is-enabled
PERMITTED_AJS_MANAGER_HOST=names-of-JP1/AJS3-Manager-hosts-to-which-JP1/AJS3-Web-Console-can-connect
HOST_NAME_INPUT_METHOD=method-for-specifying-host-names-in-the-Web-GUI-login-screen
API_EXECUTION_RESTRICTION=setting-that-determines-whether-execution-of-API-functions-is-to-be-restricted
SERVER_SESSION_TIMEOUT=Web-GUI-session-timeout-period
[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
WEB_CONSOLE_SETTING_USER=JP1-user-who-can-change-the-operating-permission-settings-for-each-JP1-user (user-who-sets-permissions)
HOST_INFO_BAR_BACKGROUND=background-color-of-the-area-that-displays-the-information-about-the-connection-destination-JP1/AJS3-Manager-host-in-the-Web-GUI-window
HOST_INFO_BAR_TEXT=connection-destination-JP1/AJS3-Manager-host-information-to-be-displayed-in-the-Web-GUI-window
HOST_INFO_BAR_TEXT_COLOR=font-color-of-the-area-that-displays-the-information-about-the-connection-destination-JP1/AJS3-Manager-host-in-the-Web-GUI-window
[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 (;).

To Page Top

(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) GUI_OPERATION_RESTRICTION

Specify whether to enable the operation restriction function of the Web GUI.

Specifiable values
yes

The operation restriction function is enabled.

no

The operation restriction function is disabled.

Default value

no

Recommended value

Set the value appropriate for the operating environment.

Cautionary note

To specify yes for this parameter, you must also specify the WEB_CONSOLE_SETTING_USER parameter.

(o) PERMITTED_AJS_MANAGER_HOST

Specify the names of JP1/AJS3 - Manager hosts to which JP1/AJS3 - Web Console is permitted to connect.

Specifiable values

The host name of JP1/AJS3 - Manager

You can specify the following host names:

For physical host

The host name that is output when the hostname command is run on a manager host

For logical host

The logical host name that was specified when the logical host environment was set up

The host name you specify must be a character string consisting of 255 or fewer bytes. You can specify multiple host names by using a comma (,) as a separator. You can specify a maximum of 128 host names. These host names are not case-sensitive.

Default value

None. (There are no restrictions on connections to hosts.)

Recommended value

Set the value appropriate for the operating environment.

Cautionary notes

  • If you specify a comma-separated list, do not add a comma (,) at the end of the list. If you do so, the specified value becomes invalid.

  • If you specify this parameter, make sure that you specify the same value for the parameter [host-name-or-IP-address-of-destination-JP1/AJS3-Manager-host].

  • Be careful if you specify this parameter while there is a user who logged in to the Web GUI without specifying a host name (for example, by specifying an IP address or alias name). In such a case, you must set the monitoring targets again by using the Set Monitoring Targets dialog box after that user logs in to the Web GUI by specifying a host name.

(p) HOST_NAME_INPUT_METHOD

Specify the input method for the Host to connect item that appears on the Web GUI login screen.

Specifiable values
tf

The item is displayed as a text box in which the user is to enter a host name.

dl

The item is displayed as a drop-down list from which the user is to select from among hosts to which connections can be established.

The drop-down list displays host names in the same order that the host names are specified for the PERMITTED_AJS_MANAGER_HOST parameter.

Default value

tf

Recommended value

Set the value appropriate for the operating environment.

Cautionary note

This parameter takes effect only if at least one value is specified for the PERMITTED_AJS_MANAGER_HOST parameter.

(q) API_EXECUTION_RESTRICTION

Specify whether to restrict the execution of API functions from user applications.

Specifiable values
yes

Execution of all API functions is restricted.

no

Execution of API functions is not restricted.

Default value

no

Recommended value

Set the value appropriate for the operating environment.

Cautionary note

If you are using a user application that uses the API of JP1/AJS3 - Web Console, and you specify yes for this parameter, the user application might become unable to operate normally. If the user application becomes unable to operate normally, modify the user application as necessary.

(r) SERVER_SESSION_TIMEOUT

Specifiable values

900 to 3,600 (units: seconds)

Default value

900

Recommended value

Default value

(s) 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.

(t) 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.

(u) 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

(v) 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.

(w) WEB_CONSOLE_SETTING_USER

To use the operation restriction function of the Web GUI, specify one or more JP1 users who can change the operating permission settings (users who set permissions).

Specifiable values

Name of the JP1 user

For details about the characters that can be used to specify JP1 user names, see the JP1/Base User's Guide.

If you specify multiple JP1 user names, use a comma (,) to delimit each user name. You can specify a maximum of 10 JP1 user names. These user names are not case-sensitive.

Default value

None.

Recommended value

Set the value appropriate for the operating environment.

Cautionary notes

  • This parameter takes effect only if yes is specified for the GUI_OPERATION_RESTRICTION parameter.

  • If you specify a comma-separated list, do not add a comma (,) at the end of the list. If you do so, the specified value becomes invalid.

(x) HOST_INFO_BAR_BACKGROUND

Specify the background color of the area that displays the information about the connection-destination JP1/AJS3 - Manager host in the Web GUI window.

Specifiable values

RGB value

Specify a color by its RGB in the R,G,B format. A number in the range from 0 to 255 can be specified for each of R, G, and B. For details about RGB values, see (6) Specifying RGB values.

Default value

192,192,192

Recommended value

Set the value appropriate for the operating environment.

Cautionary notes

  • Do not insert a halfwidth space before or after a comma (,) that is used as a separator. If a space is inserted, the specified values become invalid.

  • Changing the background color of the window area might make the text displayed in the area hard to read, depending on the combination with the font color. If you change the background color, we recommend that you also adjust the font color as needed.

(y) HOST_INFO_BAR_TEXT

Specify the character string to be displayed in the Web GUI window as the information about the connection-destination JP1/AJS3 - Manager host.

Specifiable values

Character string

Specify a character string of no more than 640 characters. If you specify a null string or empty line, a blank is displayed in the area.

Default value

Empty lines

Recommended value

Set the value appropriate for the operating environment.

Cautionary notes

  • Specify a character string that includes the OS, machine name, system name, and other information that describes the connection-destination JP1/AJS3 - Manager host.

  • For the information about the connection-destination JP1/AJS3 - Manager host to be displayed in the window, we recommend that you specify a character string that is no longer than 40 characters. If you specify a character string longer than 40 characters, characters after the first 40 characters might not be displayed.

  • You cannot use control characters, Unicode control characters, and platform-dependent characters.

(z) HOST_INFO_BAR_TEXT_COLOR

Specify the font color of the information about the connection-destination JP1/AJS3 - Manager host to be displayed in the Web GUI window.

Specifiable values

RGB value

Specify a color by its RGB in the R,G,B format. A number in the range from 0 to 255 can be specified for each of R, G, and B. For details about RGB values, see (6) Specifying RGB values.

Default value

0,0,0

Recommended value

Set the value appropriate for the operating environment.

Cautionary notes

  • Do not insert a halfwidth space before or after a comma (,) that is used as a separator. If a space is inserted, the specified values become invalid.

  • Changing the background color of the window area might make the text displayed in the area hard to read, depending on the combination with the font color. If you change the background color, we recommend that you also adjust the font color as needed.

To Page Top

(6) Specifying RGB values

RGB values are used to specify colors. Red, green and blue are specified with values between 0 and 255. One color is specified with a combination of three values.

The following table lists examples of RGB value specifications:

Table 13‒7: Example RGB values

No.

Color

RGB value

1

White

255,255,255

2

Yellow

255,255,0

3

Light gray

192,192,192

4

Sky blue

0,255,255

5

Yellow green

0,255,0

6

Gray

128,128,128

7

Dark yellow

128,128,0

8

Dark pink

255,0,255

9

Blue green

0,128,128

10

Red

255,0,0

11

Green

0,128,0

12

Purple

128,0,128

13

Brown

128,0,0

14

Blue

0,0,255

15

Dark blue

0,0,128

16

Black

0,0,0

The table lists only example RGB values. You can use a wide range of colors within the range that can be specified with RGB values.

To Page Top

(7) 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
GUI_OPERATION_RESTRICTION=yes
PERMITTED_AJS_MANAGER_HOST=ManagerHostA,ManagerHostB
HOST_NAME_INPUT_METHOD=dl
API_EXECUTION_RESTRICTION=yes
SERVER_SESSION_TIMEOUT=900
[ManagerHostA]
TIMEZONE=Asia/Tokyo
SUMMARY_MAX_COUNT=5
WEB_CONSOLE_SETTING_USER=user1,user2
[ManagerHostB]
TIMEZONE=America/New_York
SUMMARY_MAX_COUNT=5
WEB_CONSOLE_SETTING_USER=user3,user4

To Page Top

(8) Notes

To Page Top

Copyright (C) 2019, 2022, Hitachi, Ltd.

Copyright (C) 2019, 2022, Hitachi Solutions, Ltd.