Definition file for object types
- Organization of this page
Format
@encode character-encoding [comment] [ObjectType] definition-block [comment] [End] [comment]
File
company-name_product-name_company-name_product-name_obj.en (definition file for object types)
company-name can be changed to series-name_product-name. We recommend that you use the value specified for PRODUCT_NAME at the time of JP1 event issuance as the file name, with the forward slash (/) replaced by the underscore (_). Because hitachi is used for the default file name, use a name other than hitachi for company-name.
Storage directory
- In Windows
-
- For a physical host:
-
Console-path\conf\console\object_type\
- For a logical host:
-
shared-folder\jp1cons\conf\console\object_type\
- In UNIX
-
- For a physical host:
-
/etc/opt/jp1cons/conf/console/object_type/
- For a logical host:
-
shared-directory/jp1cons/conf/console/object_type/
Description
The definition file for object types defines the object types and root object types that are displayed in Object type and Root object type in the following JP1/IM-View windows:
-
Severe Event Definitions window
-
Event Acquisition Settings window
-
Common Exclusion-Conditions Settings window
-
Common Exclusion-Condition Settings (Extended) window
-
Repeated Event Condition Settings window
-
Event Search Conditions window
-
Settings for View Filter window
-
Detailed Settings for Event Receiver Filter window
-
Action Parameter Detailed Definitions window
-
Severity Change Definition Settings window (Add Severity Change Definition Settings window)
-
Display Message Change Definition Settings window (Add Display Message Change Definition Settings window)
For JP1/IM - Manager for Linux, the file must use UTF-8 encoding, and for JP1/IM - Manager for an OS other than Linux, the file must use Shift-JIS or EUC encoding.
If multiple files contain the same object type, the integrity of operations is not guaranteed.
When the definitions are applied
The definition takes effect after JP1/IM - View is restarted.
Information that is specified
- @encode character-encoding
-
Specifies the character encoding that is to be used in the definition file for object types.
To create an additional file for definition file for object types, use an @encode statement to specify the character set for the definition file.
Item names will be expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for object types will be saved in the character encoding specified in the @encode statement.
In the following circumstances, item names displayed in JP1/IM - View might be garbled:
-
If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement
-
If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved
If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the content of the definition file, the character encoding might not be determined correctly.
The specifiable character encodings are as follows:
-
C
-
EUCJIS
-
SJIS
-
UTF-8
-
GB18030
- Note
-
If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).
An error is output in the following cases:
-
A character encoding other than C, EUCJIS, SJIS UTF-8 or GB18030 is specified
-
The definition file does not begin with @encode.
-
@encode is not followed by a character encoding specification.
-
- [comment]
-
Specifies a comment as a character string that begins with a hash mark (#) and does not contain a linefeed code.
- [ObjectType]
-
Specify [ObjectType] and [End] as is, including the square brackets.
- definition-block [comment]
-
A definition block consists of an extended attribute value and a list display character string. The extended attribute value is a character string that is stored in the object type or root object type. The list display character string is a character string that is displayed in a list drop-down list.
- [End]
-
Specify [End] as is, including the square brackets.
When you define this information, note the following:
-
The object type (extended attribute value) cannot contains spaces.
-
For list display character strings, specify the extended attribute value itself instead of characters.
Example definition
The following shows an example of a definition file for object types:
@encode UTF-8 [ObjectType] # Extended attribute value, List display character string Comment ACTION, ACTION // action ACTIONFLOW, ACTIONFLOW // action flow BATCHQUEUE, BATCHQUEUE // batch queue JOB, JOB // job JOBNET, JOBNET // jobnet MEDIA, MEDIA // media PRINTER, PRINTER // printer PRINTJOB, PRINTJOB // print job PRINTQUEUE, PRINTQUEUE // pipe queue PROCESS, PROCESS // process RESTORE, RESTORE // restore [End]