Hitachi

JP1 Version 13 JP1/Automatic Job Management System 3 for Cloud Service Applications


7.1.10 Connection definitions window

In the Connection definitions window, you can view and edit connection definitions in detail.

Figure 7‒20: Connection definitions window

[Figure]

The following shows the display items and input restrictions for the Connection definitions window:

Definition name

Enter the definition name of the connection definition information. It is saved in the format of /definition-name. It cannot be changed when editing.

Comment

Display the comment of the connection definition information.

JP1 resource group

Display the JP1 resource group of the connection definition information.

Outline tab

This tab shows the outline of the items in the right-hand definition area in a tree format. Clicking an item in the outline jumps to its corresponding item in the right-hand definition area.

Cautionary note

With an item hidden in the right-hand definition area, clicking the corresponding item in the outline does not jump to the item. Show in advance the hidden item in the right-hand definition area.

Variable information tab

Displays the variable information defined by each item in the definition area on the right side and the variable information that is reserved by the system and available by default.

Export button

Clicking this button outputs the connection information being displayed as the connection definition file (slcondefExport.txt). This file will be output to the download folder set by the Web browser.

For details about a connection definitions file, see F.1 Connection definition file.

Note

Even during input of connection definitions, a connection definition file can be exported.

Import button

Click this button to display the Open dialog allowing you to select a connection definition file to be reflected to the screen. Select a connection definition file. It will be reflected on the Connection definitions screen.

For details about the format of a connection definition file, see F.1 Connection definition file.

Note

Even during input of connection definitions, a connection definition file can be imported.

Register button

Click this button to register the connection definitions, which have been input on the Connection definitions screen with JP1/AJS3 for Cloud Service Applications. When registration is successfully completed, the Home window is displayed. If an error occurs, the item with the error is highlighted.

Back button

Go to the Home window without doing anything.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Definition name

Text box

Character string of 1 to 30 bytes.

Single-byte alphanumeric characters, - (hyphen), and _ (underscore) are available.

Required

None

2

Comment

Text box

Character string within 243 bytes.

Not required

None

3

JP1 resource group

Text box

Character string within 63 bytes.

Single-byte alphanumeric characters and _ (underscores) are available.

Not required

JP1_CSA

Organization of this subsection

(1) Common environment variable settings

This section explains about Common environment variable settings in the Connection definitions window.

Figure 7‒21: Common environment variable settings in the Connection definitions window

[Figure]

The following shows the display items for Common environment variable setting:

(a) Common environment variables for command execution

Environment variables at time of command execution

Enter an environment variable to be used for command line execution with connection definitions, execution definitions, and monitoring definitions commonly in the environment-variable-name=environment-variable-value format. When specifying multiple variables, enter a line break for each one.

The following environment variable is prioritized over that set for this item: the environment variable set for Environment variables at time of command execution in the command line of each definition.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Environment variables at time of command execution

Text box

Character string of 20,479 bytes or less.

No line break is counted as part of the character string above.

A tab character can also be specified.

Up to 27,304 characters can be entered.

You can specify a variable in this input item.

Not required

None

(2) Variable settings

This section explains about Variable settings in the Connection definitions window.

Figure 7‒22: Variable settings in the Connection definitions window

[Figure]

The following shows the display items for Variable settings:

Environment variables for the execution host

Display added variables and the list of environment variables name.

Add button

Click this button to open the Setting variables dialog box. Up to 32 variables can be added. For details about this dialog, see 7.1.10(5) Setting variables dialog box.

Delete button

Click this button to delete the variable for the selected row.

Edit button

Click this button to open the Setting variables dialog box with the variable for the selected row. For details about this dialog, see 7.1.10(5) Setting variables dialog box.

↑ button

Move the variable in the selected row one row up.

↓ button

Move the variable in the selected row one row down.

(3) Connection processing

This section explains about Connection processing in the Connection definitions window.

Figure 7‒23: Connection processing in the Connection definitions window

[Figure]

When setting connection processing by specifying a command line for establishing a connection to a service, select Yes and set the items shown below. If No is selected, the items below are not shown.

The following shows the display items for Connection processing:

(a) Execution command settings

Command line

Enter the command line to run.

Command lines entered for this item are executed at the following times:

For service linkage jobs

Before Execution start processing of the execution definition

For service linkage monitoring jobs

Before executing the information acquisition command specified in Monitoring processing of the monitoring definition (executed at monitoring intervals)

Environment variable at time of command execution

Enter an environment variable to be used for command line execution in the environment-variable-name=environment-variable-value format. When specifying multiple variables, enter a line break for each one.

Storing the standard output - Variable for storing the standard output

Enter a variable name in the ?CSACxxxx? format where the standard output details are stored for passing. Replace xxxx with a value.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Command line

Text box

Character string within 1,023 bytes.

A tab character can also be specified.

You can specify a variable in this input item.

Also, specify "@CSA(characters-to-escape)ASC@" at locations where escaping is required. For details, see section 4.3.3 Escaping a command line for cloud service linkage information.

Required

None

2

Environment variables at time of command execution

Text box

Character string of 20,479 bytes or less.

No line break is counted as part of the character string above.

A tab character can also be specified.

Up to 27,304 characters can be entered.

You can specify a variable in this input item.

Not required

None

3

Variable for storing the standard output

Text box

Character string of 58 bytes or less.

A to Z (uppercase alphabetical letters) and 0 to 9 (Arabic numbers) are available.

Not required

None

(b) Execution result judgment (execution definition)

Return code judgment - Command end judgment

Select operation at the end of a connection command executed on the execution definition side from either of the following.

  • Judge based on end condition

    Judge the execution result as normal or abnormal based on the return code.

  • Always normal

    Judge the execution result always as normal regardless of the return code. When this item is selected, Abnormal end condition and Settings for abnormal end are hidden.

Abnormal end condition

Enter an abnormal end condition of the return code of the execution command.

Settings for abnormal end

Set operation when the abnormal end condition is met.

Job return code

Enter the return code of the service linkage job.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Conditions for Abnormal end condition

List box

Select from the following.

Equal to (=), not equal to (!=), less than (<), more than (>), equal to or less than (<=), equal to or more than (>=)

Required

None

2

Value for Abnormal end condition

Text box

A numerical value between 0 and 2,147,483,647.

Required

None

3

Job return code

Text box

A numerical value between 1 and 50.

Required

None

(c) Execution result judgment (monitoring definition)

Return code judgment - Command end judgment

Select operation at the end of a connection command executed on the monitoring definition side from either of the following:

  • Judge based on end condition

    Judge the execution result as normal or abnormal based on the return code.

  • Always normal

    Judge the execution result always as normal regardless of the return code. When this item is selected, Abnormal end condition and Settings for abnormal end are hidden.

Abnormal end condition

Enter an abnormal end condition of the return code of the execution command.

Settings for abnormal end

Set operation when the abnormal end condition is met.

Job return code

Enter the return code of the service linkage monitoring jobs.

Output settings for detailed execution results

Select the content to be output to detailed execution results when a service linkage monitoring job ends abnormally.

  • Output the executed command line

    Select whether to output the executed command line to detailed execution results.

  • Output the standard output

    Select whether to output the standard output of executed commands to detailed execution results.

  • Output the standard error output

    Select whether to output the standard error output of the executed command to detailed execution results.

    No.

    Display item

    Input format

    Input restriction

    Required/Not required

    Assumed value

    1

    Conditions for Abnormal end condition

    List box

    Select from the following.

    Equal to (=), not equal to (!=), less than (<), more than (>), equal to or less than (<=), equal to or more than (>=)

    Required

    None

    2

    Value for Abnormal end condition

    Text box

    A numerical value between 0 and 2,147,483,647.

    Required

    None

    3

    Job return code

    Text box

    A numerical value between 101 and 150.

    Required

    None

(d) Trace information settings (execution definition)

Log output settings

Configure settings for output to the service linkage job log file. For details about service linkage job log, see 9.2.6 Service Linkage Job Log.

Output the executed command line

Select whether to output the executed command line to the log.

Output the standard output

Select whether to output the standard output of executed commands to the log.

Output the standard error output

Select whether to output the standard error output of executed commands to the log.

Standard error output settings

Sets the output to the standard error output.

Output the executed command line

Select whether to output the executed command line to the standard error output.

Output the standard output

Select whether to output the standard output of the executed command to the standard error output.

Output the standard error output

Select whether to output the standard error output of the executed command to the standard error output.

(e) Trace information settings (monitoring definition)

Log output settings

Configure settings for output to the service linkage monitoring job log file for each monitoring interval. The service linkage monitoring job log to be output is different depending on the type of service linkage monitoring job. For details about each type of log, see 9.2.7 Service Linkage Monitoring Job Log.

Output the executed command line

Select whether to output the executed command line to the log.

Output the standard output

Select whether to output the standard output of executed commands to the log.

Output the standard error output

Select whether to output the standard error output of executed commands to the log.

(4) Connection termination processing

This section explains about Connection termination processing in the Connection definitions window.

Figure 7‒24: Connection termination processing in the Connection definitions window

[Figure]

When setting disconnection processing by specifying a command line for disconnection from a service, select Yes and set the items shown below. If No is selected, the items below are not shown.

The following shows the display items for Connection termination processing:

(a) Execution command settings

Command line

Enter the command line to run.

Command lines entered for this item are executed at the following times:

For service linkage jobs

After all processes of the execution definition have ended

For service linkage monitoring jobs

After executing the information acquisition command specified in Monitoring processing of the monitoring definition (executed at monitoring intervals)

Environment variable at time of command execution

Enter an environment variable to be used for command line execution in the environment-variable-name=environment-variable-value format. When specifying multiple variables, enter a line break for each one.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Command line

Text box

Character string within 1,023 bytes.

A tab character can also be specified.

You can specify a variable in this input item.

Also, specify "@CSA(characters-to-escape)ASC@" at locations where escaping is required. For details, see section 4.3.3 Escaping a command line for cloud service linkage information.

Required

None

2

Environment variables at time of command execution

Text box

Character string of 20,479 bytes or less.

No line break is counted as part of the character string above.

A tab character can also be specified.

Up to 27,304 characters can be entered.

You can specify a variable in this input item.

Not required

None

(b) Execution result judgment (execution definition)

Return code judgment - Command end judgment

Select operation at the end of a connection termination command executed on the execution definition side from either of the following.

  • Judge based on end condition

    Judge the execution result as normal or abnormal based on the return code.

  • Always normal

    Judge the execution result always as normal regardless of the return code. When this item is selected, Abnormal end condition and Settings for abnormal end are hidden.

Abnormal end condition

Enter an abnormal end condition of the return code of the execution command.

Settings for abnormal end

Set operation when the abnormal end condition is met.

Job return code

Enter the return code of the service linkage job.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Conditions for Abnormal end condition

List box

Select from the following.

Equal to (=), not equal to (!=), less than (<), more than (>), equal to or less than (<=), equal to or more than (>=)

Required

None

2

Value for Abnormal end condition

Text box

A numerical value between 0 and 2,147,483,647.

Required

None

3

Job return code

Text box

A numerical value between 1 and 50.

Required

None

(c) Execution result judgment (monitoring definition)

Return code judgment - Command end judgment

Select operation at the end of a connection termination command executed on the monitoring definition side from either of the following:

  • Judge based on end condition

    Judge the execution result as normal or abnormal based on the return code.

  • Always normal

    Judge the execution result always as normal regardless of the return code. When this item is selected, Abnormal end condition and Settings for abnormal end are hidden.

Abnormal end condition

Enter an abnormal end condition of the return code.

Settings for abnormal end

Set operation when the abnormal end condition is met.

Job return code

Enter the return code of the service linkage monitoring job.

Output settings for detailed execution results

Select content to be output to detailed execution results when a service linkage monitoring job ends abnormally.

  • Output the executed command line

    Select whether to output the executed command to detailed execution results.

  • Output the standard output

    Select whether to output the standard output of executed commands to detailed execution results.

  • Output the standard error output

    Select whether to output the standard error output of executed commands to detailed execution results.

    No.

    Display item

    Input format

    Input restriction

    Required/Not required

    Assumed value

    1

    Conditions for Abnormal end condition

    List box

    Select from the following.

    Equal to (=), not equal to (!=), less than (<), more than (>), equal to or less than (<=), equal to or more than (>=)

    Required

    None

    2

    Value for Abnormal end condition

    Text box

    A numerical value between 0 and 2,147,483,647.

    Required

    None

    3

    Job return code

    Text box

    A numerical value between 101 and 150.

    Required

    None

(d) Trace information settings (execution definition)

Log output settings

Configure settings for output to the service linkage job log file. For details about service linkage job log, see 9.2.6 Service Linkage Job Log.

Output the executed command line

Select whether to output the executed command line to the log.

Output the standard output

Select whether to output the standard output of executed commands to the log.

Output the standard error output

Select whether to output the standard error output of executed commands to the log.

Standard error output settings

Sets the output to the standard error output.

Output the executed command line

Select whether to output the executed command line to the standard error output.

Output the standard output

Select whether to output the standard output of the executed command to the standard error output.

Output the standard error output

Select whether to output the standard error output of the executed command to the standard error output.

(e) Trace information settings (monitoring definition)

Log output settings

Configure settings for output to the service linkage monitoring job log file for each monitoring interval. The service linkage monitoring job log to be output is different depending on the type of service linkage monitoring job. For details about each type of log, see 9.2.7 Service Linkage Monitoring Job Log.

Output the executed command line

Select whether to output the executed command line to the log.

Output the standard output

Select whether to output the standard output of executed commands to the log.

Output the standard error output

Select whether to output the standard error output of executed commands to the log.

(5) Setting variables dialog box

The Setting variables dialog is displayed for adding a new variable by pressing Add or editing an existing variable by pressing Edit in the Environment variables for the execution host.

Figure 7‒25: Setting variables dialog box

[Figure]

The following shows the display items and input restrictions for the Setting variables dialog box:

Variable name

Enter the name of a variable, in the ?CSACxxxx? format with xxxx replaced with a desired value that stores the value of the environment variable set on the execution host and sets the information to be passed.

Environment variable name

Enter an environment variable name to be stored in the variable.

OK button

Click this button to register the variable with the entered information.

Cancel button

Closes the Setting variable dialog box without doing anything.

No.

Display item

Input format

Input restriction

Required/Not required

Assumed value

1

Variable name

Text box

Character string within 58 bytes.

A to Z (uppercase alphabetical letters) and 0 to 9 (Arabic numbers) are available.

Required

None

2

Environment variable name

Text box

Character string within 64 bytes.

Required

None