3.5.1 Connection configuration file

This section describes the details of the description format and setting items of the connection configuration file.

Note: The connection configuration file must be located on the execution host for a service linkage job.

Organization of this subsection

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

(1) File storage folder

It is also optional for the file name and the folder or directory where you want to store the file. However, store it in a folder or directory where the absolute path containing the file name is no more than 255 bytes.

The following is the location of the sample file for the connection configuration file:

In Windows:

JP1/AJS3 - Manager or JP1/AJS3 - Agent installation folder\conf\ajscsajob_network.conf.model

In Linux:

/etc/opt/jp1ajs2/conf/ajscsajob_network.conf.model

To Page Top

(2) File-editing procedure

Copy the existing connection configuration file to any location for backup and edit it with your text editor. You can copy the sample connection configuration file from its storage location and edit it as required.

To Page Top

(3) When the setting takes effect

When executing the next service linkage job.

To Page Top

(4) Format

The following shows the format of connection configuration file:

CSAServerName=Host name of the JP1/AJS3 for Cloud Service Applications server
CSAConnectProtocol=Protocol for a service linkages job to connect with the JP1/AJS3 for Cloud Service Applications server
CSAConnectPortNumber=Port number for a service linkage job to connect with the JP1/AJS3 for Cloud Service Applications server
ConnectTimeout=Connection timeout time for connecting the JP1/AJS3 for Cloud Service Applications server
ProxyAddr=Proxy for communication with JP1/AJS3 for Cloud Service Applications server
CAFile=Name of the server certificate file to verify the server certificate for SSL communication with the JP1/AJS3 for Cloud Service Applications server
Timeout=Maximum time for processing during a single connection with the JP1/AJS3 for Cloud Service Applications server
CSAConnectRetryCount=Number of retries when the connection with the JP1/AJS3 for Cloud Service Applications server cannot be established
CSAConnectRetryInterval=Retry interval when the connection with the JP1/AJS3 for Cloud Service Applications server cannot be established

Note that lines beginning with a hash mark (#) are comment lines.

To Page Top

(5) Setting items

The following describes the items to be set.

(a) CSAServerName

Specify the host name of the JP1/AJS3 for Cloud Service Applications server so that a service linkage job connects to the JP1/AJS3 for Cloud Service Applications server.

This name must be able to be resolved from the execution host for a service linkage job. For name resolution, jp1hosts information or jp1hosts2 information is also effective. For details of jp1hosts or jp1hosts2, please see the JP1/Base User's Guide.

Important: This setting item cannot be specified with the IP address of the JP1/AJS3 for Cloud Service Applications server.

Specifiable number of characters: 1 to 255 (units: bytes)

This setting item cannot be omitted. If it is omitted, the commands for a service linkage job terminate with a non-zero return code.

(b) CSAConnectProtocol

Specify the protocol for a service linkages job to connect with the JP1/AJS3 for Cloud Service Applications server.

Specifiable values

http

A non-SSL protocol is used to communicate with the JP1/AJS3 for Cloud Service Applications server.
https

SSL is used to communicate with the JP1/AJS3 for Cloud Service Applications server.

Default value

http

If the CSAConnectProtocol= setting line is omitted, the default value is assumed to be set.

(c) CSAConnectPortNumber

Specify the port number for a service linkage job to connect with the JP1/AJS3 for Cloud Service Applications server.

Specifiable values: 0 to 65535 (units: port number)
Default value: 22265

(d) ConnectTimeout

Specify the connection timeout time for connecting the JP1/AJS3 for Cloud Service Applications server with the destination host.

If communication with the destination host is not established after the time specified here has passed, the connection is retried as many times as the retry count specified in CSAConnectRetryCount and at the retry interval specified in CSAConnectRetryInterval.

Specifiable values

1 to 600 (units: seconds)

Default value

10 (units: seconds)

If the ConnectTimeout= setting line is omitted, the default value is assumed to be set.

Depending on the settings of the OS on which a service linkage job runs and the network settings of the system, a timeout may occur in a shorter time than the specified connection timeout time, resulting in a connection error.

For the settings of the OS, please see the OS manual.

(e) ProxyAddr

When you use a proxy for communication with JP1/AJS3 for Cloud Service Applications, specify the proxy to use.

If the ProxyAddr= setting line is omitted, no proxy is used (http_proxy environment variables, such as environment variables, are not enabled).

Allowable format

protocol://user:password@host-name-of-the-proxy-server:port-number

The protocol must begin with http:// or https://. It is not case sensitive.

If the port number is omitted, 1080 is assumed.

Operation is not guaranteed if incorrect data is specified.

Important: For the host-name-of-the-proxy-server, specify a value that can be resolved from the execution host of the service linkage job. You cannot resolve the name of the proxy server by using the jp1hosts or jp1hosts2 information.

Allowable number of characters

When it begins with http://, 8 to 2,083 bytes.
When it begins with https://, 9 to 2,083 bytes.

(f) CAFile

If you want to verify the server certificate for SSL communication with the JP1/AJS3 for Cloud Service Applications server, specify the name of the server certificate file.

You can specify only a server certificate in PEM format. If you specify a server certificate in DER format, an error occurs.

If the CAFile= setting line is omitted, the server certificate is not verified.

Allowable number of characters: 1 to 511 bytes (units: bytes)

(g) Timeout

Specify the maximum time for processing during a single connection with the JP1/AJS3 for Cloud Service Applications server.

If the process is not completed after the time specified here has passed, it is retried as many times as the retry count specified in CSAConnectRetryCount and at the retry interval specified in CSAConnectRetryInterval.

Specifiable values

1 to 86,400 (units: seconds)

Default value

600

If the Timeout= setting line is omitted, the default value is assumed to be set.

(h) CSAConnectRetryCount

Specify the number of retries when the connection with the JP1/AJS3 for Cloud Service Applications server cannot be established or when the processing time limit specified in Timeout is exceeded.

If the JP1/AJS3 for Cloud Service Applications server cannot be connected even after retrying as many times as the value specified here, or if the processing time limit is exceeded, the command for the service linkage job will terminate with a non-zero return code.

Specifiable values

0 to 100 (units: number of retries)

If 0 is specified, no retry is conducted and the command for the service linkage job terminates with a non-zero return code.

Default value

If the CSAConnectRetryCount= setting line is omitted, the default value is assumed to be set.

(i) CSAConnectRetryInterval

Specify the retry interval when the connection with the JP1/AJS3 for Cloud Service Applications server cannot be established or when the processing time limit specified in Timeout is exceeded and CSAConnectRetryCount is set to other than 0.

When CSAConnectRetryCount=0, this setting item is ignored.

Specifiable values

1 to 300 (units: seconds)

Default value

If the CSAConnectRetryInterval= setting line is omitted, the default value is assumed to be set.

To Page Top

(6) Notes

A zero-byte line and a line containing only spaces are ignored.
If there is a space or tab at the beginning or end of each line, the value after the space or tab is removed is considered the valid value.
If the value contains spaces in the middle, they are considered part of the value. However, if the value contains a tab in the middle, the command for the service linkage job terminates with a non-zero return code.

Example 1

When CAFile=C:\AAAΔBBB\CAFileΔ, the specified value is regarded as CAFile=C:\AAAΔBBB\CAFile.

(Legend) Δ: space

Example 2

When CAFile=C:\AAA<\t>BBB\CAFileΔ, an error occurs.

(Legend) <\t>: tab, Δ: space
If the same setting item is defined on multiple lines, the last line is valid.
If an unknown keyword exists, the command for the service linkage job terminates with a non-zero return code.
Be sure to specify a value for each item. If no value is specified, the command for the service linkage job terminates with a non-zero return code.
Each line must be within 4,096 bytes including a line feed code. If a specified line exceeds 4,096 bytes, the command for the service linkage job terminates with a non-zero return code.

To Page Top