3.4.4 Details on the settings in the network-settings file (ajscd_ajs3web.properties)

This subsection describes the details on the format of settings and the items to be set in the network-settings file (ajs3cd_ajs3web.properties).

Organization of this subsection

(1) File storage folder
(2) File-editing procedure
(3) When the setting takes effect
(4) Format
(5) Setting items
(6) Examples
(7) Notes

(1) File storage folder

The ajscd_ajs3web.properties file is not created in the initial status of JP1/AJS3 - Web Console immediately after JP1/AJS3 - Web Console has been installed. While the ajscd_ajs3web.properties file is not created, JP1/AJS3 - Web Console operates by using default settings.

Create the ajscd_ajs3web.properties file only when you want to change settings from the default settings.

(a) Model file storage folder

The following shows the folder storing the model file (ajscd_ajs3web.properties.model) for the network-settings file.

JP1/AJS3-Web-Console-installation-folder\conf

(b) ajscd_ajs3web.properties file storage folder

The ajscd_ajs3web.properties file storage folder varies depending on where JP1/AJS3 - Web Console is installed.

In a cluster configuration, the file name is as follows:: shared-folder\jp1ajs3web\conf

When JP1/AJS3 - Web Console is installed in the default folder or in a folder protected by the system, the ajscd_ajs3web.properties file storage folder is as follows:

%ALLUSERSPROFILE%\Hitachi\JP1\JP1_DEFAULT\jp1ajs3web\conf

The default value of %ALLUSERSPROFILE% is system-drive\ProgramData.

Folders protected by the system use the path to one of the following folders:

Folder in system-drive\Windows
Folder in system-drive\Program Files

If the JP1/AJS3 - Web Console installation folder is other than the above, the ajscd_ajs3web.properties file storage folder is as follows:: JP1/AJS3-Web-Console-installation-folder\conf

To Page Top

(2) File-editing procedure

The following describes the procedure for editing the ajscd_ajs3web.properties file:

Stop the JP1/AJS3 Web Application Server service.
If the ajscd_ajs3web.properties file has already been defined, back up the file, and store the backup file in any folder.
Copy the model file (ajscd_ajs3web.properties.model) into the folder storing the ajscd_ajs3web.properties file, and then rename the copy of the model file to ajscd_ajs3web.properties.
Open the ajscd_ajs3web.properties file by using a text editor.
Modify the definitions to be changed.
Save the ajscd_ajs3web.properties file by using UTF-8 encoding.
Start the JP1/AJS3 Web Application Server service.

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 ajscd_ajs3web.properties file:

ajscd.port_number=port-number-for-connection-to-JP1/AJS3-Manager
ajscd.connect_timeout=timeout-period-of-connection-to-JP1/AJS3-Manager
ajscd.connect_retry_count=number-of-retries-of-connection-to-JP1/AJS3-Manager
ajscd.connect_retry_interval=interval-of-retries-of-connection-to-JP1/AJS3-Manager
ajscd.receive_timeout=timeout-period-of-data-reception-from-JP1/AJS3-Manager
ajscd.login_wait=wait-time-for-login

When writing a comment on a line, begin the comment line with a hash mark (#).

To Page Top

(5) Setting items

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

(a) ajscd.port_number

Specify the port number of the port to connect to JP1/AJS3 - Manager.

Change this setting when the default port number cannot be used for JP1/AJS3 - Manager.

Specifiable values: 5001 to 65535
Default value: 22250
Recommended value: Set the value appropriate for the operating environment.

(b) ajscd.connect_timeout

Specify the timeout period for the connection to JP1/AJS3 - Manager.

By default, connection timeout processing is disabled. Change the setting from the default when you want to enable the timeout processing for the connection to JP1/AJS3 - Manager.

Specifiable values

0 to 86,400 (units: seconds)

When 0 is specified, connection timeout processing is disabled.

Default value

0 (Connection timeout processing is disabled.)

Recommended value

Set the value appropriate for the operating environment.

Cautionary note

The connection timeout specification of the OS and the connection timeout setting in the OS might cause a connection timeout to occur earlier than the timeout period you specify for this setting item.

(c) ajscd.connect_retry_count

Specify the number of times to retry when a communication error occurs in an attempt to connect to JP1/AJS3 - Manager.

Specifiable values: 0 to 100 (units: number of times)
Default value: 3
Recommended value: Set the value appropriate for the operating environment.

(d) ajscd.connect_retry_interval

Specify the interval for retry attempts when a communication error occurs in an attempt to connect to JP1/AJS3 - Manager.

Specifiable values: 1 to 300 (units: seconds)
Default value: 12
Recommended value: Set the value appropriate for the operating environment.

(e) ajscd.receive_timeout

Specify the timeout period for data reception from JP1/AJS3 - Manager.

Specifiable values

0 to 86,400 (units: seconds)

When 0 is specified, reception timeout processing is disabled.

Default value

180

Recommended value

Set the value appropriate for the operating environment.

(f) ajscd.login_wait

Specify the time to wait for login processing (time to wait until entry into sleep state) when authentication of JP1/AJS3 - Manager fails.

Specifiable values: 1 to 10 (units: seconds)
Default value: 1
Recommended value: Set the value appropriate for the operating environment.

To Page Top

(6) Examples

The following shows an example of definitions in the ajscd_ajs3web.properties file:

ajscd.port_number=22250
ajscd.connect_timeout=0
ajscd.connect_retry_count=3
ajscd.connect_retry_interval=12
ajscd.receive_timeout=180
ajscd.login_wait=1

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 a setting is invalid, the JP1/AJS3 Web Application Server service can start, but a processing error occurs in JP1/AJS3 - Web Console.
The definition keys of setting items and set values are case sensitive. If the definition key on a definition line contains uppercase and lowercase letters, the definition line will be ignored.
If the same setting item is defined on multiple lines, only the last line defining the setting item is valid.

To Page Top