Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command, Definition File and API Reference

Event guide information file (jco_guide.txt)

Organization of this page

Format

DESC_VERSION=file-version
 
[EV_GUIDE_event-guide-number]
EV_USER=JP1-user-name
EV_COMP=attribute-name:attribute-value
EV_GUIDE=event-guide-message
[END]
[EV_GUIDE_event-guide-number]
EV_COMP=attribute-name:attribute-value
EV_COMP=attribute-name:attribute-value
EV_FILE=event-guide-message-file-name
[END]
   :

To Page Top

File

sample_jco_guide_ja.txt (sample file of the event guide information file (Japanese))

sample_jco_guide_en.txt (sample file of the event guide information file (English))

sample_jco_guide_ja.txt.model (model file for the event guide information sample file (Japanese))

sample_jco_guide_en.txt.model (model file for the event guide information sample file (English))

To Page Top

Storage directory

In Windows
For a physical host:

Console-path\conf\guide\

For a logical host:

shared-folder\jp1cons\conf\guide\

In UNIX
For a physical host:

/etc/opt/jp1cons/conf/guide/

For a logical host:

shared-directory/jp1cons/conf/guide/

To Page Top

Description

This file defines event guide information for JP1 events. The information specified in this file is displayed in the Event Details window of JP1/IM - View or the Event Detail window of the integrated operation viewer.

The maximum size of an event guide information file is 1 megabyte. An event guide information file can contain up to 1,000 blocks.

Use the language encoding supported by JP1/IM - Manager to specify the event guide information file.

You must create an event guide information file under the name jco_guide.txt. Copy the sample_jco_guide_ja.txt or sample_jco_guide_en.txt, depending on the language code used by JP1/IM - Manager, and then rename the file jco_guide.txt before you use it. Store the event guide information file in the same directory that stores the sample file. Note that the event guide information file cannot have a user-selected name, unlike the file specified in the EV_FILE parameter (event guide message file).

If an issued JP1 event matches multiple event guide information items, the first item specified in the event guide information file is effective.

When # is specified, any text following # is treated as a comment. Note that a comment cannot be specified after the start tag, attribute information, or the end tag. An error results if a comment is specified following the start tag or the end tag. A comment that is specified following an attribute value is treated as part of the attribute value.

To use \, specify \\. If \ is used in a character combination other than \n or \$, a log is output and the line containing \ is ignored.

The event guide information file and event guide message file are not checked for HTML syntax errors.

To Page Top

When the definitions are applied

Once the event guide information file has been edited, the definitions in the file take effect when JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed. If there is no display area for event guide information in the Event Details window when you log in to JP1/IM - View or the Event Detail window of the integrated operation viewer, apply the definitions and then re-log in to JP1/IM - View or the Event Detail window of the integrated operation viewer. The display area should appear.

After you have edited the event guide message file, you can display the new information by reloading the Event Details window.

To Page Top

Information that is specified

DESC_VERSION=file-version

Specifies the file version of the event guide information file. The specifiable values are 1 and 2. When 2 is specified, you can specify the EV_USER parameter.

[EV_GUIDE_event-guide-number]

This is the start tag for event guide information. The information from the [EV_GUIDE_event-guide-number] to the [END] tag constitutes a single definition block. Between this parameter and [END], specify a comparison condition for determining the JP1 events that are to be displayed in the Event Details window and the message to be displayed. For event-guide-number, specify a decimal number in the range from 1 to 9999.

When there are multiple definition blocks, the event guide numbers need not be in numerical order. However, an error results if the same event guide number is specified more than once, in which case the definition block with the duplicated event guide number is ignored. Note that [EV_GUIDE_1] and [EV_GUIDE_0001] are different.

Specify a unique character string in each EV_GUIDE_event-guide-number. If an invalid character string is specified, a log is output and the corresponding specification is ignored.

If an attribute specified for EV_GUIDE_event-guide-number is not permitted, the corresponding specification is ignored.

EV_USER=JP1-user-name

Specifies the JP1 user name to be displayed in the event guide message. You can specify 1 to 31 bytes of characters. Only one-byte alphanumeric characters can be used. Alphabetic characters are not case sensitive. If you specify this parameter, specify 2 for DESC_VERSION. You can specify this parameter only once. If the parameter is omitted, all JP1 users are assumed as applicable users.

This parameter can be specified only when the version of JP1/IM - Manager is 09-50 or later. You can specify a maximum of 100 JP1 user names by separating them with one or more spaces.

Example:

EV_USER=jp1user1 jp1user2 jp1user3

EV_COMP=attribute-name:attribute-value

Specify this parameter for each attribute that is to be used for comparison with JP1 events. When multiple attributes are specified, they are assumed to be connected by the AND condition. For example, if the EV_COMP parameter is specified twice, the event guide message is displayed in the Event Details window only when both of the conditions are satisfied.

If you specify an event ID for the attribute name in an EV_COMP parameter, you can specify either B.ID or B.IDBASE. In B.ID, specify the 16-digit attribute value in the format basic-part:extended-part. In B.IDBASE, specify the 8-digit basic part.

Example:

  • EV_COMP=B.ID:00004107:00000000

  • EV_COMP=B.IDBASE:00004107

You can specify a maximum of 100 EV_COMP conditions. For an example of using more than one EV_COMP condition, see the example definition below.

Note that a business group name cannot be used for the event-issuing server name (B.SOURCESERVER), the target event server name (B.DESTSERVER), and the event source host name (E.JP1_SOURCEHOST). If you specify a business group name, it is treated as a host name.

attribute-name

Specifies one of the following as the attribute:

• JP1 event basic attribute: If you specify this attribute, use the format B.attribute-name.

• JP1 event extended attribute: If you specify this attribute, use the format E.attribute-name.

Note that the reason for registration (B.REASON) and code set (B.CODESET) cannot be specified.

If you specify the registration time (B.TIME) or the arrival time (B.ARRIVEDTIME) for attribute-name, the total number of milliseconds after UTC January 1, 1970 at 00:00:00 is compared.

Example: Specify a JP1 event of which the arrival time is 10:20:00.000 (total number of milliseconds: 1371000000000) on June 12, 2013

EV_COMP=B.TIME:1371000000000

attribute-value

Specifies as a regular expression the value of the attribute specified in attribute-name. For the regular expression, use an extended regular expression. For details about regular expressions, see Appendix G. Regular Expressions in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

By default, the specified regular expression is compared with the entire attribute value of the JP1 event. The condition is satisfied only if they match exactly.

To accept a partial match, execute the jbssetcnf command specifying a file that contains the common definition information shown below in an argument and then restart JP1/IM - Manager to apply the definition. When you create the definition file, make sure that the end of the file is at the beginning of the last line.

For a physical host

[JP1_DEFAULT\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

For a logical host

[logical-host-name\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

To reset the definition to a complete match (default), specify match for the value of the GUIDE_EV_COMP common definition information.

If the common definition information is missing or the specified value is invalid, the system assumes match for a complete match.

Note that the common definition information is not set at the time of installation.

When you specify an IPv6 address for a source IP address (B.SOURCEIPADDR) and the target IP address (B.DESTIPADDR), use lowercase alphabetic characters as in the following example:

0011:2233:4455:6677:8899:aabb:ccdd:eeff

Also note that abbreviated IP addresses such as the following cannot be specified:

2012:7:8::a:b

When you specify the registered time (B.TIME) or the arrived time (B.ARRIVEDTIME), specify the number of seconds in milliseconds starting from UTC 1970-01-01 00:00:00.

EV_GUIDE=event-guide-message

Specifies a character string that is to be displayed as the event guide information. The specified character string is displayed in the event guide information area in the Event Details window (in Guide under Message).

Note that you can specify this parameter only once between [EV_GUIDE_event-guide-number] and [END].

If you specify EV_GUIDE=event-guide-message and EV_FILE=event-guide-message-file-name together, the specification of EV_FILE=event-guide-message-file-name takes precedence.

To use \ in the message, specify \\. To use $, specify \$. To use a linefeed code in the message, specify \n.

You can use HTML tags and specify variables for JP1 event attributes in event-guide-message.

  • Specifying HTML tags

    If you use HTML tags, you can display the event guide message in HTML format in the Event Details window (for details about the HTML tags that can be specified, see Table 2-27 HTML tags that can be used in the event guide message file, in the description of EV_FILE.

  • Specifying variables for JP1 event attributes

    If you specify $B.attribute-nameΔ or $E.attribute-nameΔ in the message, the attribute value corresponding to the JP1 event attribute name is expanded in the message (Δ indicates a space). Note that the reason for registration (B.REASON) and code set (B.CODESET) cannot be specified. If there is no corresponding attribute, the attribute is replaced with blanks.

    The table below lists the attribute names that can be specified in messages. For details about the attributes of JP1 events, see 3.1 Attributes of JP1 events.

    Table 2‒24: List of attribute names that can be specified in messages

    JP1 event attribute

    Specification in message

    Basic attributes

    Serial number

    B.SEQNO

    Event ID

    Specify either of the following:

    1. B.ID

    2. B.IDBASE

    Source process ID

    B.PROCESSID

    Registered time

    B.TIME

    Arrived time

    B.ARRIVEDTIME

    Source user ID

    B.USERID

    Source group ID

    B.GROUPID

    Source user name

    B.USERNAME

    Source group name

    B.GROUPNAME

    Event-issuing server name

    B.SOURCESERVER

    Target event server name

    B.DESTSERVER

    Source serial number

    B.SOURCESEQNO

    Message

    B.MESSAGE

    Extended attributes

    Event level

    E.SEVERITY

    User name

    E.USER_NAME

    Product name

    E.PRODUCT_NAME

    Object type

    E.OBJECT_TYPE

    Object name

    E.OBJECT_NAME

    Root object type

    E.ROOT_OBJECT_TYPE

    Root object name

    E.ROOT_OBJECT_NAME

    Object ID

    E.OBJECT_ID

    Occurrence

    E.OCCURRENCE

    Start time

    E.START_TIME

    End time

    E.END_TIME

    Result code

    E.RESULT_CODE

    Event source host name

    E.JP1_SOURCEHOST

    Other extended attribute

    E.xxxxxx#
    #:

    You can also specify JP1 product-specific extended attributes. For example, the product-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

    You can specify for an event guide message a maximum of 196,608 characters. If more than 196,608 characters are specified, the portion in excess of 196,608 characters will not be displayed in the Event Details window.

    The event guide message can display a Web page of related products without unreadable text by specifying replacement characters listed in the table below.

    Table 2‒25: Replacement characters that can be specified

    Specification format

    Description

    $B.attribute-nameΔ

    $E.attribute-nameΔ

    Expand the attribute value as is.

    When guide information is in HTML format, use HTML encoding.

    Specify the attribute value in this format to display the JP1 event attribute value as part of the text to be displayed in an event guide message.

    Example: $B.MESSAGEΔ

    $B.attribute-name$URLENCΔ

    $E.attribute-name$URLENCΔ

    Handle the attribute value as a UTF-8 string for URL encoding and expand it.

    Use this format to pass the JP1 event attribute value as a UTF-8 string to be used as the argument (URL parameter) of the Web page application.

    Example: <a href="http://host/page?msg=$B.MESSAGE$URLENCΔ">

    $B.attribute-name$ENCΔ

    $E.attribute-name$ENCΔ

    Perform Base64 encoding for the attribute value as a UTF-8 string and expand it.

    Use this format to display the Base64-encoded JP1 event attribute value as a UTF-8 string as part of the text to be displayed in an event guide message.

    However, to pass the value as an argument (URL parameter) of a Web page application, use the variables $B.attribute-name$ENC$URLENCΔ, $E.attribute-name$ENC$URLENCΔ

    Example: $B.MESSAGE$ENCΔ

    $B.attribute-name$ENC$URLENCΔ

    $E.attribute-name$ENC$URLENCΔ

    Perform Base64 encoding for the attribute value as a UTF-8 string, and then perform URL-encoding to expand it.

    Use this format to pass the Base64 value of the JP1 event attribute value as an argument (URL parameter) of the Web page application.

    Example: <a href="http://host/page?msg=$B.MESSAGE$ENC$URLENCΔ">
    Note:

    When you specify $URLENC or $ENC, you must specify 2 as the value for DESC_VERSION.

EV_FILE=event-guide-message-file-name

Specifies the full path name of a file that contains the text for the event guide message that is to be displayed in the Event Details window. You can specify this parameter only once between [EV_GUIDE_event-guide-number] and [END]. If nothing is specified for event-guide-message-file-name, the file names in the following table are assumed.

Table 2‒26: Event guide message file name

OS

Event guide message file name

Windows

Console-path\conf\guide\EV_GUIDE_event-guide-number.txt

shared-folder\jp1cons\conf\guide\EV_GUIDE_event-guide-number.txt

UNIX

/etc/opt/jp1cons/conf/guide/EV_GUIDE_event-guide-number.txt

shared-directory/jp1cons/conf/guide/EV_GUIDE_event-guide-number.txt

Express the file name using from 1 to 1,024 characters, including the path. If the specified file name exceeds 1,024 characters, an error results when JP1/IM - Manager starts or when the event guide message file is called from JP1/IM - View or the integrated operation viewer.

You can specify any file name and extension for the event guide message file. We recommend that you select a file name that is easy to manage; for the extension, use .txt if the event guide message is in TXT format and .html or .htm if the event guide message is in HTML format.

Example: jco_guidemes001_AJS2.txt or jco_guidemes001_AJS2.htm

Event guide message file

Specify in the event guide message file in TXT or HTML format the information that you want to be displayed in the Event Details window. The information that you can specify in the event guide information file is the same as for EV_GUIDE. In other words, you can use HTML tags and variables for the attributes of JP1 events. To use a backslash sign (\) in a message, write it as\\. To use the dollar sign ($), write it as\$. To insert a linefeed in a message, write it as\n.

However, EV_GUIDE can be used only to specify a one-line message, whereas with the event guide message file you can use linefeed codes for a formatted message.

You can store the created event guide message file in any folder.

The maximum size of an event guide message file is 1 megabyte. If the file size exceeds 1 megabyte, an error occurs when the event guide message file is loaded into the Event Details window of JP1/IM - View or the integrated operation viewer.

The table below lists and describes the HTML tags and attributes that can be used when you create an event guide message file in HTML format. If any other HTML tags are used, the operational results cannot be guaranteed.

Table 2‒27: HTML tags that can be used in the event guide message file

Tag

Attribute

Description

HTML

--

Declares that this is an HTML text. This tag is mandatory.

HEAD

--

Declares the header for the HTML text.

This tag is mandatory.

BODY

--

Declares the body of the HTML text.

This tag is mandatory.

A#1

HREF="URL"

Specifies a linkage-target URL.#2, #3 You can specify URLs beginning with http:// or https://.

Operation with other URLs is unpredictable.

The link specified here is displayed in the Event Details window (HTML format). Clicking the link starts a Web browser and accesses the specified URL. You can encode a maximum of 2,083 characters.

TARGET#5

Specifies the name of the destination window for the page indicated by the URL specified in HREF.

If a destination window with the same name is found in the range of the same session as that of the WWW browser displaying the Integrated Operation Viewer, the window is used as a display destination.

If the destination window is not found, a new window is opened and used as the display destination.

This attribute can accept the following characters:

  • Half-width upper-case and lower-case alphabetic characters

  • Half-width numbers

  • Space characters

  • Symbols (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)

Note that the string cannot start with a half-width number, a space character, or a symbol. However, when you specify _blank, you can specify _ as the first letter.

The names below are not available. It is case-insensitive.

  • _parent

  • _self

  • _top

  • Name that starts with JP1IM_

  • Name with zero length, such as target=""

H1, H2, H3, H4, H5, H6

--

Specifies headers.

FONT

SIZE="font-size"

Specifies the font size. The permitted values are from 1 to 7.

COLOR="font-color"

Specifies the font color. You can specify the following 16 colors:

black, silver, gray, white, maroon, red, purple, fuchsia, green, lime, olive, yellow, navy, blue, teal, aqua

If you specify any other font color, the operation is not guaranteed.

B

--

Specifies boldface type.

I#4

--

Specifies italics type.

HR

--

Specifies a horizontal rule.

BR

--

Specifies a forced linefeed.
Legend:

--: None

#1: The interpretation of the URL in the A tag and the screen to be displayed are dependent on the WWW browser and other aspects of the environment.

#2: The following is a coding example of a URL used to link with JP1/Navigation Platform.

Example:

http://hostA:8080/ucnpBase/portal/screen/Home/action/PLoginUser?contentId=f24077e7-0136-1000-8000-00000ad20b6f-0

For details about linking with JP1/Navigation Platform, see the descriptions of the URL for calling Navigation Platform from JP1 products in the JP1/Navigation Platform manuals.

#3: For details about the URL for linking with JP1/AJS, see the JP1/AJS manuals.

#4: In the integrated operation viewer window, Japanese strings are not italicized even with the I tag.

#5: This attribute is available only for the Integrated Operation Viewer window.

[END]

Specifies the end tag for the event guide information. This item is not case sensitive.

To Page Top

Example definition

# JP1/IM-CC Guide Information File.
 
DESC_VERSION=1
[EV_GUIDE_001]
EV_COMP=B.ID:00004107:00000000
EV_COMP=E.SEVERITY:Error
EV_GUIDE=The job terminated abnormally.\nCheck whether an error has occurred on the $E.C0 host.
[END]

To Page Top

Copyright (C) 2019, 2021, Hitachi, Ltd.

Copyright (C) 2019, 2021, Hitachi Solutions, Ltd.