Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager GUI Reference


2.3.1 Run Response Action window

The Run Response Action window is for manually executing response action. You can start the Run Response Action window in one of the following ways:

For response action associated with event-information
  • In the [Figure]Operation menu, click the Run Response Action(Event Inheritance) menu.

  • In the Event details dialog box, click the Run Response Action button.

When response action is not associated with the event-information
  • From Integrated Operation Viewer window Option menu, select the Run Response Action menu.

Action type

Select the type of action to be executed from the pull-down menu.

  • cmd: Execute with command.

  • restapi: Run in REST API.

  • eventstatus: Changes the response status of an event.

  • jump: Jumps to the specified URL.

The displayed window differs depending on the type of action selected.

Organization of this subsection

(1) When cmd is selected as an action type

The following explains when cmd is selected as the action type.

Figure 2‒14: Run Response Action window (when the action type is cmd)

[Figure]

Event information to inherit

Displays events that are inherited by response action executable (events subject to inheritance). If there are no JP1 events, they are inactive.

Inherit event information check box

Checked when inheriting the information of the event subject to inheritance to the execution content of response action.

If it is not checked, it will not be inherited.

Target host

Specify the host name under which response action is to be executed, up to 255 bytes.

Command

Specifies the command line to be executed.

You can specify a command line of up to 4096 bytes.

Attribute information of JP1 event displayed in the Event information to inherit can be passed as a parameter of the command using a variable. For details about the variables that can be specified, see 7.8 Response actions manual execution inheritance function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

Environment variable file

Specifies the name of environment variable file stored on the host where response action is executed, as a full path of no more than 255 bytes.

Action name

Specify the action name within 50 bytes.

It is recommended that you enter a meaningful name for each response action to see the history of the actions taken.

Execute button

The following occurs depending on whether the Inherit event information check box is selected in the Event information to inherit.

  • When the Inherit event information check box is selected

    The Preview Execution Script of Response Action window is displayed.

  • When the Inherit event information check box is not checked

    Executes the specified response action.

Execution history

Display the execution history list. When you hover over a line in the execution history, the tooltip text displays its contents.

A maximum of 100 execution histories are displayed. When the number exceeds 100, the oldest one is deleted from the oldest one.

(2) When restapi is selected as an action type

The following explains when restapi is selected as the action type.

Figure 2‒15: Run Response Action window (when the action type is restapi)

[Figure]

Event information to inherit

Displays events that are inherited by response action executable (events subject to inheritance). If there are no JP1 events, they are inactive.

Inherit event information check box

Checked when inheriting the information of the event subject to inheritance to the execution content of response action.

If it is not checked, it will not be inherited.

Method

Select REST API method from the pull-down menu.

  • GET

  • HEAD

  • POST

  • PUT

  • PATCH

  • DELETE

  • OPTIONS

  • TRACE

URL#

Specifies URL of REST API, up to 2046 bytes.

Request header#

Specifies REST API request header in object format. Specify within 65,536 bytes.

Body#

Specifies the body of REST API in an object format. If you specify GET or DELETE in the Method, you can omit it if you do not need the body. If it exceeds 10MB(10,485,760 byte), an error will occur.

Action name

Specify the action name within 50 bytes.

It is recommended that you enter a meaningful name for each response action to see the history of the actions taken.

Execute button

The following occurs depending on whether the Inherit event information check box is selected in the Event information to inherit.

  • When the Inherit event information check box is selected

    The Preview Execution Script of Response Action window is displayed.

  • When the Inherit event information check box is not checked

    Executes the specified response action.

Execution history

Display the execution history list. When you hover over a line in the execution history, the tooltip text displays its contents.

A maximum of 100 execution histories are displayed. When the number exceeds 100, the oldest one is deleted from the oldest one.

#
  • Attribute information of JP1 event displayed in the Event information to inherit can be passed as a parameter using a variable. For details about the variables that can be specified, see 7.8 Response actions manual execution inheritance function in the JP1/Integrated Management 3 -Manager Overview and System Design Guide.

(3) When eventstatus is selected as an action type

The following explains when eventstatus is selected as the action type.

Figure 2‒16: Run Response Action window (When the action type is eventstatus)

[Figure]

Event information to inherit

Displays events that are inherited by response action executable (events subject to inheritance). If there are no JP1 events, they are inactive.

Inherit event information check box

Checked when inheriting the information of the event subject to inheritance to the execution content of response action.

If it is not checked, it will not be inherited.

Response status

Specify the response status. The default is Unprocessed.

  • Unprocessed

  • Processed

  • Processing

  • Held

JP1 event SID, ...

Specifies SID of JP1 events for which you want to obtain response status. If you want to specify SID for more than one JP1 event, specify SID of JP1 event concatenated with ",". You can specify up to 2000 SID. An error occurs if the value is 10MB or higher.

The attribute information of JP1 event displayed in the Event information to inherit can be passed as a parameter of SID of JP1 event using a variable. For details about the variables that can be specified, see 7.8 Response actions manual execution inheritance function in the JP1/Integrated Management 3 -Manager Overview and System Design Guide.

Action name

Specify the action name within 50 bytes.

It is recommended that you enter a meaningful name for each response action to see the history of the actions taken.

Execute button

The following occurs depending on whether the Inherit event information check box is selected in the Event information to inherit.

  • When the Inherit event information check box is selected

    The Preview Execution Script of Response Action window is displayed.

  • When the Inherit event information check box is not checked

    Executes the specified response action.

Execution history

Display the execution history list. When you hover over a line in the execution history, the tooltip text displays its contents.

A maximum of 100 execution histories are displayed. When the number exceeds 100, the oldest one is deleted from the oldest one.

(4) When jump is selected as an action type

The following explains when jump is selected as the action type.

Figure 2‒17: Run Response Action window (When the action type is jump)

[Figure]

Event information to inherit

Displays events that are inherited by response action executable (events subject to inheritance). If there are no JP1 events, they are inactive.

Inherit event information check box

Checked when inheriting the information of the event subject to inheritance to the execution content of response action.

If it is not checked, it will not be inherited.

URL#

Specify URL to be jumped to, up to 2046 bytes.

Specify "http://", "https://", or "index?" at the beginning.

The following characters can be specified:

Single-byte alphanumeric characters and ";", "/", "?", ":", "@", "&", "=", "+", "$", ",", "-", "_", ".", "!", "~", "*", "'", "(", ")", "%"

HTML "target" attribute#

Specifies target of HTML when opening the jumped URL, up to 64 bytes.

The following characters cannot be specified:

  • _self

  • _parent

  • _top

  • Value starting from JP1IM_

If a character that cannot be specified is included when the Execute button is clicked, KAJY64703-E messaging window is displayed.

If the specification is omitted, _blank is assumed.

If a URL beginning with index is specified for URL, this specification is ignored.

Action name

Specify the action name within 50 bytes.

It is recommended that you enter a meaningful name for each response action.

Execute button

The following occurs depending on whether the Inherit event information check box is selected in the Event information to inherit.

  • When the Inherit event information check box is selected

    The Preview Execution Script of Response Action window is displayed.

  • When the Inherit event information check box is not checked

    Executes the specified response action.

#

Attribute information of JP1 event displayed in the Event information to inherit can be passed as a parameter using a variable. For details about the variables that can be specified, see 7.8 Response actions manual execution inheritance function in the JP1/Integrated Management 3 -Manager Overview and System Design Guide.