3.4.1 Details of setting items of the environment setting file (ajs3csaweb.conf)

This subsection describes the details on the format of settings and the items to be set in the environment-settings file (ajs3csaweb.conf).

Organization of this subsection

(1) File storage folder

The following describes the folders for storing the file ajs3csaweb.conf and the model file ajs3csaweb.conf.model.

(a) Model file storage folder

The following shows the folder storing the ajs3csaweb.conf.model file.

In Windows:: JP1/AJS3-for-Cloud-Service-Applications-installation-folder\conf
In Linux:: /etc/opt/jp1ajs3csa/conf

(b) ajs3csaweb.conf file storage folder

The following shows the folder storing the ajs3csaweb.conf file.

In Windows:

JP1/AJS3-for-Cloud-Service Applications-installation-folder\conf^#1

#:1

In a cluster configuration, the file name is as follows:

shared-folder\jp1ajs3csa\conf

In Linux:

/etc/opt/jp1ajs3csa/conf^#2

#:2

In a cluster configuration, the file name is as follows:

shared-folder/jp1ajs3csa/conf

To Page Top

(2) File-editing procedure

The following describes the procedure for editing the ajs3csaweb.conf file:

(a) In Windows

Stop the JP1/AJS3 CSA HTTP Server service and then stop the JP1/AJS3 CSA Web Application Server service.

To make changes with respect to the logs for the ajscsasetup command, this operation is unnecessary.
Back up ajs3csaweb.conf to any folder.

To change the command log settings, you must change ajs3csaweb.conf in the installation folder instead of the one in the shared folder even in cluster operation. Please back up ajs3csaweb.conf in the installation folder.
To change the size or number of log files, delete the following files.

To change the settings for command logging
- All command logs
- The ajscsasetup.mm and jajs_csa_service.mm files under the mmap directory
To make changes with respect to the logs related to starting or stopping services (jajs_csa_service)
- All logs related to starting or stopping services.
- The jajs_csa_service.mm file under the mmap directory.
To change the settings for application server logging.
- All application server logs.
- The appserver.mm file under the mmap directory.
To change the settings for server job logging
- All server job logs.
- The appserverjob.mm file under the mmap directory.
Copy the model file ajs3csaweb.conf.model and rename it to ajs3csaweb.conf. In a cluster environment, you must conduct the following steps on ajs3csaweb.conf under the shared folder. However, to change the settings for command logging, please do so on the ajs3csaweb.conf in the installation folder.
Open the ajs3csaweb.conf file by using a text editor.
Modify the definitions to be changed.
Save the ajs3csaweb.conf file.
Start the JP1/AJS3 CSA Web Application Server service and then the JP1/AJS3 CSA HTTP Server service.

To make changes with respect to the logs for the ajscsasetup command, this operation is unnecessary.

(b) In Linux

Stop the JP1/AJS3 CSA HTTP Server and JP1/AJS3 CSA Web Application Server services by running the following command:
```
/etc/opt/jp1ajs3csa/jajs_csa_stop
```
To make changes with respect to the logs for the ajscsasetup command, this operation is unnecessary.
Back up ajs3csaweb.conf to any directory.

To change the command log settings, you must change ajs3csaweb.conf in the installation folder instead of the one in the shared folder even in cluster operation. Please back up ajs3csaweb.conf in the installation folder.
To change the size or number of log files, delete the following files.

To change the settings for command logging
- All ajscsasetup command logs.
- The ajscsasetup.mm and jajs_csa_service.mm files under the mmap directory.
To make changes with respect to the logs for the commands for starting and stopping services (jajs_csa and jajs_csa_stop)
- All logs related to starting or stopping services.
- The jajs_csa.mm file and jajs_csa_stop.mm file under the mmap directory.
To change the settings for application server logging
- All application server logs.
- The appserver.mm file under the mmap directory.
To change the settings for server job logging
- All server job logs.
- The appserverjob.mm file under the mmap directory.
Copy the model file ajs3csaweb.conf.model and rename it to ajs3csaweb.conf. In a cluster environment, you must conduct the following steps on ajs3csaweb.conf under the shared folder. However, to change the settings for command logging, please do so also on the ajs3csaweb.conf in the installation folder.
Open the ajs3csaweb.conf file by using a text editor such as vi.
Modify the definitions to be changed.
Save the ajs3csaweb.conf file.
Start the JP1/AJS3 CSA HTTP Server and JP1/AJS3 CSA Web Application Server services by running the following command:
```
/etc/opt/jp1ajs3csa/jajs_csa
```
To make changes with respect to the logs for the ajscsasetup command, this operation is unnecessary.

To Page Top

(3) When the setting takes effect

If you change it for the command log:

When executing the ajscsasetup command

If you change it, including other changes:

When the JP1/AJS3 CSA Web Application Server service starts

To Page Top

(4) Format

The following shows the format of settings in the ajs3csaweb.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-tracelog
SYS_LOG_LEVEL=level-of-the-message-to-be-output-to-Windows-event-log
SYS_LOG_LANG=language-type-of-the-message-to-be-output-to-Windows-event-log
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_APP_SIZE=size-of-an-application-server-log-file
SERVER_LOG_APP_LEVEL=level-of-the-message-to-be-output-to-application-server-log
SERVER_LOG_APP_NUM=number-of-application-server-log-files
SERVER_LOG_LANG=language-type-of-the-message-to-be-output-to-application-server-log
SERVER_LOG_JOB_SIZE=size-of-server-job-log-file
SERVER_LOG_JOB_LEVEL=level-of-the-message-to-be-output-to-server-job-log-file
SERVER_LOG_JOB_NUM=number-of-server-job-log-files
SERVER_LOG_APP_MON_SIZE=size-of-an-application-server-log-file-for-executing-service-linkage-monitoring-jobs
SERVER_LOG_APP_MON_LEVEL=level-of-the-message-to-be-output-to-application-server-log-for-executing-service-linkage-monitoring-jobs
SERVER_LOG_APP_MON_NUM=number-of-application-server-log-files-for-executing-service-linkage-monitoring-jobs
SERVER_LOG_JOB_MON_SIZE=size-of-a-server-job-log-file-for-executing-service-linkage-monitoring-jobs
SERVER_LOG_JOB_MON_LEVEL=level-of-the-message-to-be-output-to-server-job-log-for-executing-service-linkage-monitoring-jobs
SERVER_LOG_JOB_MON_NUM=number-of-server-job-log-files-for-executing-service-linkage-monitoring-jobs
USED_DEF LIMIT=Retention period for service-linked job definitions used during job execution
SERVER_SESSION_TIMEOUT=HTTP-session-timeout-period

When writing a comment on a line, begin the comment line with a semi colon (;).

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

The following describes the items to be set. Delimit each item by using a linefeed.

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.

In Windows, If the character encoding set in the OS is neither English ASCII encoding nor Shift-JIS encoding, English ASCII encoding is assumed to be specified.

In Linux, if the character code set in the OS is anything other than the English ASCII code and UTF-8 code, the English ASCII code is assumed.

C

Messages are output by using English ASCII encoding.

SJIS

In Windows, Messages are output by using Shift-JIS encoding. In Linux, unable to specify.

ja_JP.UTF-8 or ja_JP.utf8

In Linux, Messages are output by using UTF-8 encoding. In Windows, unable to specify.

en_US.UTF-8 or en_US.utf8

In Linux, Messages are output by using English ASCII encoding. In Windows, unable to specify.

Default value

system

Recommended value

Set the value appropriate for the operating environment.

(c) SYS_LOG_LEVEL

Specifies the message level to output to the Windows event log (for Windows) or syslog (Linux).

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) SYS_LOG_LANG

Specify the language type of the messages to be output to the Windows event log.

Important: In Linux, unable to specify.

Specifiable values

system

Messages are output in the language type set in the OS.

If the character encoding set in the OS is neither English ASCII encoding nor Shift-JIS encoding, English ASCII encoding is assumed to be specified.

C

Messages are output by using English ASCII encoding.

SJIS

Messages are output by using Shift-JIS encoding.

Default value

system

Recommended value

Set the value appropriate for the operating environment.

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

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

(g) COM_LOG_NUM

Specify the number of command log files.

Specifiable values: 1 to 16 (units: files)
Default value: 2
Recommended value: Default value

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

In Windows, If the character encoding set in the OS is neither English ASCII encoding nor Shift-JIS encoding, English ASCII encoding is assumed to be specified.

In Linux, if the character code set in the OS is anything other than the English ASCII code and UTF-8 code, the English ASCII code is assumed.

C

Messages are output by using English ASCII encoding.

SJIS

In Windows, Messages are output by using Shift-JIS encoding. In Linux, unable to specify.

ja_JP.UTF-8 or ja_JP.utf8

In Linux, Messages are output by using UTF-8 encoding. In Windows, unable to specify.

en_US.UTF-8 or en_US.utf8

In Linux, Messages are output by using English ASCII encoding. In Windows, unable to specify.

Default value

system

Recommended value

Set the value appropriate for the operating environment.

(i) SERVER_LOG_APP_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

(j) SERVER_LOG_APP_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

(k) SERVER_LOG_APP_NUM

Specify the number of application server log files.

Specifiable values: 1 to 16 (units: files)
Default value: 2
Recommended value: Default value

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

(m) SERVER_LOG_JOB_SIZE

Specify the size of server job log file.

Specifiable values: 4 to 16,384 (units: kilobytes)
Default value: 11,264
Recommended value: Default value
Cautionary note: If you want to change the default values, you must check the output size of the server job log during job operation and verify the time period during which the log can be kept as history before you can change the values.

(n) SERVER_LOG_JOB_LEVEL

Specify the level of the messages to be output to the server job log file.

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

(o) SERVER_LOG_JOB_NUM

Specify the number of server job log files.

Specifiable values: 1 to 16 (units: files)
Default value: 3
Recommended value: Default value

(p) SERVER_LOG_APP_MON_SIZE

Specify the size of the application server log file (for executing service linkage monitoring jobs).

Specifiable values: 4 to 16,384 (units: kilobytes)
Default value: 8,192
Recommended value: Default value

(q) SERVER_LOG_APP_MON_LEVEL

Specify the level of the messages to be output to the application server log (for executing service linkage monitoring jobs).

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

(r) SERVER_LOG_APP_MON_NUM

Specify the number of application server job log files (for executing service linkage monitoring jobs).

Specifiable values: 1 to 16 (units: files)
Default value: 2
Recommended value: Default value

(s) SERVER_LOG_JOB_MON_SIZE

Specify the size of the server job log file (for executing service linkage monitoring jobs).

Specifiable values: 4 to 16,384 (units: kilobytes)
Default value: 11,264
Recommended value: Default value
Cautionary note: If you want to change the default values, you must check the output size of the server job log during job operation and verify the time period during which the log can be kept as history before you can change the values.

(t) SERVER_LOG_JOB_MON_LEVEL

Specify the level of the messages to be output to the server job log file (for executing service linkage monitoring jobs).

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

(u) SERVER_LOG_JOB_MON_NUM

Specify the number of server job log files (for executing service linkage monitoring jobs).

Specifiable values: 1 to 16 (units: files)
Default value: 3
Recommended value: Default value

(v) USED_DEF_LIMIT

Specify the retention period for historical information on service linkage job definitions, service linkage monitoring job definitions, or authentication definitions that were used during job execution.

Specifiable values: 0 to 366 (unit: days)
Default value: 180
Recommended value: Set the value appropriate for the operating environment.
Cautionary note: If you set this value to 0, no history information is stored. Therefore, message KNBB2407-Q or KNBB2408-Q will not be displayed in the dialog when service linkage job definitions, service linkage monitoring job definitions, or authentication definitions that have a job execution history are updated or deleted on the Web screen. In addition, when you edit a service linkage job definition, service linkage monitoring job definition, or authentication definition, the message The definition has a job execution history! message will not be displayed.

(w) SERVER_SESSION_TIMEOUT

Specify the server session timeout time. If the specified amount of time has passed since the server receives a request for status acquisition, operation, etc. until the next request arrives, the HTTP session times out.

Specifiable values: 900 to 3,600 (units: seconds)
Default value: 900
Recommended value: Default value

To Page Top

(6) Examples

The following shows an example of definitions in the ajs3csaweb.conf file:

[]
HNTR_LOG_LEVEL=error
HNTR_LOG_LANG=system
SYS_LOG_LEVEL=error
SYS_LOG_LANG=system
COM_LOG_SIZE=10240
COM_LOG_LEVEL=info
COM_LOG_NUM=2
COM_LOG_LANG=system
SERVER_LOG_APP_SIZE=8192
SERVER_LOG_APP_LEVEL=info
SERVER_LOG_APP_NUM=2
SERVER_LOG_JOB_SIZE=8192
SERVER_LOG_JOB_LEVEL=info
SERVER_LOG_JOB_NUM=2
SERVER_LOG_APP_MON_SIZE=8192
SERVER_LOG_APP_MON_LEVEL=info
SERVER_LOG_APP_MON_NUM=2
SERVER_LOG_JOB_MON_SIZE=8192
SERVER_LOG_JOB_MON_LEVEL=info
SERVER_LOG_JOB_MON_NUM=2
SERVER_LOG_LANG=system
USED_DEF_LIMIT=180
SERVER_SESSION_TIMEOUT=900

To Page Top

(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 CSA 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.

To Page Top