Guide information file (jcs_guide.txt)

Organization of this page

Format 1
Format 2
File
Storage directory
Description
When the definitions are applied
Information that is specified
Example definition

Format 1

DESC_VERSION=1
 
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_GUIDE=message
[END]
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_GUIDE=message
[END]
   :

To Page Top

Format 2

DESC_VERSION=2
 
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string
EV_FILE=guide-message-file
[END]
[EV_GUIDE_number]
NUM=number
EV_COMP_number=attribute-specification:regular-expression
EV_TITLE=character-string=character-string
EV_FILE=guide-message-file
[END]
   :

To Page Top

File

The guide information file (jcs_guide.txt) to be edited depends on the language encoding supported by JP1/IM. The following table shows the correspondence between the language encodings supported by JP1/IM and the guide information files to be edited.

Table 2‒52: Correspondence between language encodings supported by JP1/IM and the guide information files
OS	Language type	Language encoding supported by JP1/IM	File to be edited
Windows	Japanese		`jcs_guide_sjis.txt` (guide information file)
	Japanese		`jcs_guide_sjis.txt.model` (model file for the guide information file)
	English		`jcs_guide.txt` (guide information file)
	English		`jcs_guide.txt.model` (model file for the guide information file)
	Chinese		`jcs_guide_GB18030.txt` (guide information file)
UNIX^#	Japanese	Shift-JIS encoding	`jcs_guide_sjis.txt` (guide information file)
		Shift-JIS encoding	`jcs_guide_sjis.txt.model` (model file for the guide information file)
		EUC encoding	`jcs_guide_euc.txt` (guide information file)
		EUC encoding	`jcs_guide_euc.txt.model` (model file for the guide information file)
		UTF-8 encoding	`/etc/opt/jp1scope/conf/jcs_guide_UTF-8.txt`
		UTF-8 encoding	`shared-directory/jp1scope/conf/jcs_guide_UTF-8.txt`
	English		`jcs_guide.txt` (guide information file)
	English		`jcs_guide.txt.model` (model file for the guide information file)
	Chinese	GB18030 encoding	`jcs_guide_GB18030.txt` (guide information file)

#: Only files corresponding to the languages supported by the OS exist.

To Page Top

Storage directory

In Windows

For a physical host:: Scope-path\conf\
For a logical host:: shared-folder\jp1scope\conf\

In UNIX

For a physical host:: /etc/opt/jp1scope/conf/
For a logical host:: shared-directory/jp1scope/conf/

To Page Top

Description

This file defines guide information about the JP1 events that trigger a change in monitoring object status.

The information specified in this file is displayed in the Guide window of JP1/IM - View.

The maximum size of the guide information file is 1 megabyte.

Format 2 is used to import a user-created TXT or HTML file as the guide-message file and then display it in the Guide window.

If there are multiple matching guide information items, the first item specified in the guide information file is effective.

In Windows, guide information files from version 07-00 of JP1/IM - Manager (Central Scope) can also be read in JP1/IM - Manager version 08-00 and later.

In Windows, guide information files from version 08-00 or later of JP1/IM - Manager can also be read in version 07-00 of JP1/IM - Manager (Central Scope), but the specification EV_FILE=guide-message-file under DESC_VERSION=2 is ignored, and the specification EV_GUIDE=message takes precedence. An error results if the file includes neither specification.

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

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

To Page Top

When the definitions are applied

After the guide information file is edited, the definitions in the file take effect when JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed.

To Page Top

Information that is specified

DESC_VERSION=1 | 2

Specifies the version of the guide information file. The permitted values are 1 and 2.

If you specify the EV_FILE parameter to call a guide-message file, you must specify 2 in this parameter.

If you specify DESC_VERSION=1, EV_GUIDE=message, and EV_FILE=guide-message-file together, the specification of EV_FILE=guide-message-file will be ignored.

If you specify DESC_VERSION=2 and also specify both EV_GUIDE=message and EV_FILE=guide-message-file, the specification of EV_FILE=guide-message-file will take precedence.

[EV_GUIDE_number]

This is the start tag for the guide information. The information from the [EV_GUIDE_number] tag to the [END] tag constitutes a single definition block. Between this parameter and [END], specify a condition for JP1 events that are to be displayed in the Guide window and the message that is to be displayed. The number begins with 1 and increments by 1 up to the number of guides.

The specification in each instance of the EV_GUIDE_number tag must be unique. If an invalid character string is specified, a log is output and the corresponding specification is ignored.

If an attribute specified in the EV_GUIDE_number tag is not permitted, the corresponding specification is ignored.

NUM=number

Specifies the total number of EV_COMP_number entries.

EV_COMP_number=attribute-specification:regular-expression

Specifies an attribute to be compared. Specify this parameter for each attribute that is to be compared. The specification in number begins with 1 and increments by 1. When multiple parameters have been specified and the AND condition among them is completely satisfied, the message specified in the EV_GUIDE parameter is displayed in the Guide window.

The value specified in EV_COMP_number is ignored if it is less than 1 or greater than the value specified in NUM=number.

Express the event ID as 8 digits. If you specify B.ID as an attribute specification for EV_COMP_number and you set only the base part of the event ID in the matching condition, you can omit specification of the extended part.

Example:

EV_COMP_1=B.ID:00004107:00000000 or EV_COMP_1=B.ID:00004107

attribute-specification

Specifies an attribute of one the following types:

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

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

Monitoring node attribute: If you specify this type of attribute, you can use the format T.MONNODEID (monitoring node ID), with the monitoring node ID expressed as 8 hexadecimal characters.

regular-expression

Specifies a value of the attribute specified in attribute-specification using a regular expression. 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.

EV_TITLE=character-string

Specifies the character string that is to be displayed as the title of the Guide window. You can specify this parameter only once between [EV_GUIDE_number] and [END].

EV_GUIDE=message

Specifies the character string that is to be displayed as a guide message in the Guide window. If you use HTML tags, you can display the guide message in HTML format in the Guide window (for details about the supported HTML tags, see Table 2-53 HTML tags that can be used in guide messages in the description of EV_FILE). Note that you can specify this parameter only once between [EV_GUIDE_number] and [END].

Express the message as a maximum of 10,240 bytes of characters. If the specified message consists of more than 10,240 bytes, the portion of the message in excess of 10,240 bytes is not displayed in the Guide window.

To use \ in the message, specify \\. To use $, specify \$. If $B.attribute-nameΔ or $E.attribute-nameΔ is specified in the message, the attribute value corresponding to the JP1 event attribute name is expanded (Δ indicates a space). The monitoring node ID replaces $T.MONNODEIDΔ (Δ indicates a single-byte space). If there is no corresponding attribute, the attribute is replaced with blanks.

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

EV_FILE=guide-message-file

Specifies the full path or relative path (from Scope-path\conf\guide\ or /etc/opt/jp1scope/conf/guide/) of the file that contains the guide message to be displayed in the Guide window. Note that you can specify this parameter only once between [EV_GUIDE_number] and [END].

Express the file name using a maximum of 1,024 bytes of characters. If the specified file name exceeds 1,024 bytes, an error occurs when JP1/IM - Manager starts or the guide message file is called from JP1/IM - View.

When you specify this parameter, you must specify 2 as the value of DESC_VERSION.

The file specified as guide-message-file can have any file name and extension. We recommend that you use a file name that is easy to manage, and that you use the extension .txt if the guide messages are in TXT format and the extension .html or .htm if the guide messages are in HTML format.

Examples: guide001_AJS2.txt, guide001_AJS2.htm

Guide-message file

Specify in the guide-message file in TXT or HTML format the information that you want to display in the Guide window. The information that you can specify is the same as for EV_GUIDE in the guide information file. In the case of a guide-message file, you can edit the formatting by inserting linefeed codes.

The contents and syntax of the guide-message file are not checked.

You can store the created guide-message file in any folder. However, when you are operating in a cluster configuration, you should store it in the following folder for purposes of system failover:

• In Windows

shared-folder\jp1scope\conf\guide\

• In UNIX

shared-directory/jp1scope/conf/guide/

The maximum size of a guide-message file is 1 megabyte. If the file size exceeds 1 megabyte, an error occurs when the guide-message file is loaded from the Guide window of JP1/IM - View.

The table below lists and describes the HTML tags and attributes that can be used to create a guide-message file in HTML format.

Table 2‒53: HTML tags that can be used in guide messages
Tag	Attribute	Description
`HTML`	--	Declares that this is an HTML text. This tag is mandatory.
`HEAD`	--	Declares the header of the HTML text. This tag is mandatory.
`BODY`	--	Declares the body of the HTML text. This tag is mandatory.
`A`	`HREF="URL"`	Specifies a link-target URL. If a relative path or a URL beginning with `mailto:` is specified, the integrity of the operation is not guaranteed. The link specified here is displayed in the Guide window (HTML format). Clicking the link starts a Web browser and accesses the specified URL.
`H1`, `H2`, `H3`, `H4`, `H5`, `H6`	--	Specifies headers.
`FONT`	`SIZE="font-size"`	Specifies the font size. The permitted values are from 1 to 7.
`FONT`	`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`	--	Specifies italics type.
`HR`	--	Specifies an underscore.
`BR`	--	Specifies a forced linefeed.

Legend:: --: None

If any other HTML tags are used, the integrity of operations is not guaranteed.

[END]

Specifies the end tag for the guide information.

To Page Top

Example definition

# JP1/IM-CS Guide Information File.
 
DESC_VERSION=1
[EV_GUIDE_1]
NUM=2
EV_TITLE=JP1/AJS2  Abnormal termination of job A
EV_COMP_1=T.MONNODEID:0000000A
EV_COMP_2=B.ID:00000111
EV_GUIDE=The job terminated abnormally. \nCheck whether an error has occurred on the $E.C0 host.
[END]
[EV_GUIDE_2]
NUM=1
EV_COMP_1=B.ID:00004107
EV_GUIDE=The job terminated abnormally. \nCheck whether an error has occurred on the $E.C0 host.\nAs an example of failure, a job failed at host A due to a memory shortage in the past. Use the vmstat command to check the available memory capacity.
[END]

To Page Top