Hitachi

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


Details of statements in definition files

This subsection lists the types and structures of and the values that can be specified in the statements that can be specified in some of the JP1/IM definition files.

Note:

The information provided in this subsection is applicable only to the following three definition files:

  • Definition file for extended event attributes

  • Definition file for executing applications

  • Definition file for the Tool Launcher window

Organization of this page

Types of statements

Table 2‒85: Types of statements

Statement category

Statement types

In-file statements

Start-of-block statement

End-of-block statement

File attribute statement

Product statement

In-block statements

Definition statement for function menu command options

Event attribute definition statement

Block attribute definition statement

Definition file for function menu execution definition identifiers

Application description definition statement

Group definition statement

Function menu display icon definition statement

Definition statement for application execution definition identifiers

Function menu identifier definition statement

Function menu display name definition statement

Sequence definition statement

Function menu parent identifier definition statement

Application path definition statement

Structures of statements

Table 2‒86: Structures of statements

Statement type

Specification format

Start-of-block statement

@define-block type=block-type

End-of-block statement

@define-block-end

File attribute statement

@file type=definition-file-type[, version=definition-format-version]

Product statement

@product name=product-name

Definition statement for function menu command options

arguments=command-arguments

Event attribute definition statement

attr name=attribute-name, title=display-item-name[, type=attribute-display-type]

Block attribute definition statement

block lang=language-type|platform=platform-type|version=version-in-use

Definition file for function menu execution definition identifiers

execute_id=application-execution-definition-identifier

Application description definition statement

description=description-of-application-execution

Group definition statement

group name=group-name, attrs=list-of-attribute-names

Function menu display icon definition statement

icon=display-icon-file-name

Definition statement for application execution definition identifiers

id=application-execution-definition-identifier

Function menu identifier definition statement

id=function-menu-identifier

Function menu display name definition statement

name=display-name

Sequence definition statement

order id=event-ID-definition-character-string, attrs=list-of-attribute-names

Function menu parent identifier definition statement

parent_id=parent-function-menu-identifier

Application path definition statement

path=command-path

Rules for generating specification components in the statements

The table below lists the values that can be specified in the specification components of the statements.

Table 2‒87: Values that can be specified in the specification components of the statements

Specification components

Specifiable values

Hexadecimal characters

From 0 to 9 and A to F

EUCJIS

EUCJIS

GB18030

GB18030

JIS

JIS

Shift-JIS

SJIS

UTF-8

UTF-8

Description of application execution

User-defined character string of from 1 to 50 bytes

Application execution definition

application-execution-definition

Application execution definition block

application-execution-def

Application execution definition identifier

From 1 to 32 alphanumeric characters

Event ID

From 1 to 8 bytes of hexadecimal characters

Event ID definition character string

event-ID|event-ID-definition-character-string enumeration-separator event-ID

Event object type definition block

event-object-def

Event extended attribute definition

extended-attributes-definition

Event attribute group definition block

event-attr-group-def

Event attribute definition block

event-attr-def

Event display sequence definition block

event-attr-order-def

Interface name

From 1 to 32 alphanumeric characters

Group name

From 1 to 32 alphanumeric characters

Command path

File name

Command arguments

User-defined character string that serves as command arguments

Subkey name

From 1 to 32 alphanumeric characters

Forward slash

/

Forward slash-separated alphanumeric character string

forward-slash|alphanumeric-characters|forward-slash-separated-alphanumeric-character-string forward-slash

|forward-slash-separated-alphanumeric-character-string alphanumeric-characters

Default

default

Version

Version character string expressed using from 1 to 7 alphanumeric characters

Version symbolic character

/|.|-

Version range specification

version space-space version

Version character

uppercase-letters|number|version-symbolic-character

File symbolic character

.|/|\\|-|_|~

File name

Character string that serves as a file path

File name character string

file-symbolic-characters|alphanumeric characters|file-name-character-string file-symbolic-characters|file-name-character-string alphanumeric-characters

Platform type

base|alphanumeric-character-string

Product name

Forward slash-separated alphanumeric character string

Block type

event-attribute-definition-block|event-attribute-group-definition-block|event-display-sequence-definition-block|application-execution-definition-block

User-defined character

alphanumeric-character|Japanese-characters|symbol

English

English

Alphabetic characters

Uppercase and lowercase alphabetic characters

Lowercase letters

From a to z

Alphanumeric characters

Alphabetic and numeric characters

Uppercase letters

From A to Z

Menu tree node definition block

function-tree-def

Integrated tree menu definition

function-definition

Function menu identifier

From 1 to 32 alphanumeric characters

Function menu identifier string

[from-0-to-9-bytes-of-function-menu-identifier enumeration-separator]

function-menu-identifier

Language type

Japanese|English

Parent function menu identifier

Function menu identifier

Numeric characters

From 0 to 9

Description

From 1 to 50 bytes of user-defined characters

Attribute value

From 1 to 10,000 bytes of characters

Attribute value type

elapsed_time

Attribute display type

attribute-value-type/display-format

Attribute name

(B|).attribute-name-character-string

Attribute name characters

uppercase-letters|numeric-characters|_

Attribute name character string

Attribute name characters consisting of from 0 to 31 uppercase letters

Attribute name list

attribute-name|list-of-attribute-names\|attribute-names

Definition file type

extended-event-attribute-definition|application-execution-definition|definition-for-opening-monitor-windows|Tool-Launcher-definition

Definition format version

0300

Supported version

ALL|version|version-range-specification

Date and time display format

date_format:display-time-zone

Japanese

Japanese

Japanese characters

Two-byte characters except one-byte kana

Japanese character encoding

Shift-JIS|EUCJIS|JIS|UTF-8

Display icon file name

file-name

Display time zone

CLIENT

Display format

Date and time display format

Display item character

alphanumeric-characters|space|-|_|Japanese-characters

Display item character string

From 0 to 64 bytes of display item character string

Display item name

Display item character string

Display name

From 1 to 32 bytes of user-defined character string

Enumeration separator

\|