6.3.4 Inherited event information
When defining an automated action, by using a variable you can specify information about the JP1 event that triggers the action as inherited event information. Inherited event information can be specified for the following items:
-
Target host
-
Execution user name
-
Environment variable file
-
Action
JP1 event attribute values are inherited to automated actions when those values are handed from the event base service to the automatic action service.
The following table lists the inherited event information you can specify.
Attribute |
Variable name |
Inherited event information |
---|---|---|
Basic attribute |
EVBASE |
|
EVID |
|
|
EVIDBASE |
|
|
EVDATE |
|
|
EVTIME |
|
|
EVPID |
|
|
EVUSRID |
|
|
EVGRPID |
|
|
EVUSR |
|
|
EVGRP |
|
|
EVHOST |
|
|
EVIPADDR |
|
|
EVSEQNO |
|
|
EVARVDATE |
|
|
EVARVTIME |
|
|
EVSRCNO |
|
|
EVMSG |
|
|
EVDETAIL |
|
|
Extended attribute |
EVSEV |
|
EVUSNAM |
|
|
EVOBTYP |
|
|
EVOBNAM |
|
|
EVROBTYP |
|
|
EVROBNAM |
|
|
EV"PRODUCT_NAME" |
|
|
EV"OBJECT_ID" |
|
|
EV"OCCURRENCE" |
|
|
EV"START_TIME" |
|
|
EV"END_TIME" |
|
|
EV"RESULT_CODE" |
|
|
EV"JP1_SOURCEHOST" |
|
|
EV extended-attribute-name |
|
|
Other |
EV"@JP1IM_CORRELATE" |
|
EV"@JP1IM_ORIGINAL_SEVERITY" |
|
|
EV"@JP1IM_CHANGE_SEVERITY" |
|
|
EV"@JP1IM_DISPLAY_MESSAGE" |
|
|
EV"@JP1IM_CHANGE_MESSAGE" |
|
|
ACTHOST |
|
|
EVENV1 to EVENV9 |
|
- Organization of this subsection
(1) Specification method
Inherited event information is specified using a variable. Specify the variable in the form $variable-name. To specify a dollar sign as a character, type a backslash (\) before the dollar sign (\$).
The following control characters contained in the character information to be converted are converted to single-byte spaces (0x20).
Control characters that are converted to single-byte spaces: 0x01 to 0x1F (excluding tabs (0x09)), and 0x7F
(2) Encoding of event inheritance information
For Action in the action-related items, you can URL encode or Base64 encode the event inheritance information values.
The specification format is $variable-name$encoding-type. To specify a single-byte alphanumeric character or an underscore (_) immediately after encoding-type, use the format ${variable-name$encoding-type}. If you want to treat a dollar sign ($) as a character, specify the escape character (\) immediately before the $.
In the following cases, $variable-name$encoding-type and ${variable-name$encoding-type} will be interpreted as character strings and will not be converted:
-
There is no event that corresponds to variable-name.
-
The specification format is invalid.
The following table describes the encoding types for event inheritance information and the specification formats.
No. |
Encoding type |
Specification format |
Description |
---|---|---|---|
1 |
URL encoding |
$variable-name$URLENC |
The event inheritance information value is URL encoded as a UTF-8 character string. |
${variable-name$URLENC} |
|||
2 |
Base64 encoding |
$variable-name$ENC |
The event inheritance information value is Base64 encoded. |
${variable-name$ENC} |
|||
3 |
Both Base64 encoding and URL encoding |
$variable-name$ENC$URLENC |
The event inheritance information value is Base64 encoded and then is URL encoded. |
${variable-name$ENC$URLENC} |
|||
4 |
No encoding is performed |
$variable-name |
Neither URL encoding nor Base64 encoding is performed. |
${variable-name} |
Note that encoding of inheritance information cannot be used in the automated action definition file (for compatibility).
(3) Converting inherited event information
You can convert special ASCII characters included in inherited event information into a different character string.
This functionality allows you to convert characters in event information that have a special meaning in the OS into different characters. For example, if the JP1 event information specified by a variable contains characters that have a special meaning in commands, such as a double quotation mark (") or a single quotation mark ('), the command might not be interpreted correctly. We recommend that you use the configuration file for converting information to convert such characters.
Specify the special characters and the characters they are to be converted into using a configuration file for converting information. For details about this file, see Configuration file for converting information (event_info_replace.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.