Configuration file for monitoring tree
- Organization of this page
Format
TREE:BUILD=value;ID=value;[DATE=generation-date-and-time;]CSV_VER=09000000;MSCOPE=ON (linefeed)
OBJ:monitoring-node-name#, NID:monitoring-node-ID#, ICO:icon-name, TYPE:monitoring-node-type, CLASS:monitoring-object-type, STA:status-ID, CHDT:status-update-time, OBS:monitoring-status, STD:basic-information (attribute-name-1=attribute-name-1#), BKIMG=background-image-file-name, POT:X=X-coordinate;Y=Y-coordinate;Z=Z-coordinate, CON:NAME=status-change-condition-name#, STA=change-status-ID, CID=common-condition-ID;common-condition-information, GCON:NAME=status-change-condition-name#, STA=change-status-ID, CSTA=child-node-status-ID, NUM>=child-node-count, RATIO>=child-node-ratio, (individual-condition-name==individual-condition-value#), EVE:STA=status-ID, RES:JP1-resource-group-name, OWN:monitoring-node-owner's-name, OPE:list-of-operation-items (linefeed)
:- Legend:
-
(linefeed): Location of a linefeed
#: Item that can be edited (all other items cannot be edited)
File
Any file (configuration file for monitoring tree)
Storage directory
Any folder
Description
This file defines the configuration of the monitoring tree that is displayed in the Monitoring Tree window.
By editing the configuration file for the monitoring tree, you can change the information that is displayed in the monitoring tree, such as the names of monitoring nodes and attribute values of basic information. To create a configuration file for monitoring tree, save the tree configuration locally from the Monitoring Tree window or Monitoring Tree (Editing) window. Do not create a configuration file for monitoring tree by any other method. When you edit the configuration file for monitoring tree, make sure that you do not edit any values other than those described below.
If you have updated an uneditable value by mistake and a backup of the configuration file for monitoring tree is available, use the backup file to update the configuration file for monitoring tree again. If no backup file is available, use the jcsdbsetup or jcsdbimport command to set up the monitoring object database again.
It is preferable that you use the Monitoring Tree (Editing) window to edit the monitoring tree, unless otherwise necessary.
To use two-byte characters, standardize the character encoding as MS932. No custom characters can be used. Do not enter an escape character.
When the definitions are applied
The definition takes effect when it is applied to JP1/IM - Manager after this definition file has been opened in the Monitoring Tree (Editing) window.
Information that is specified
- TREE
-
The following parameters contained in TREE cannot be changed.
- BUILD=value
-
value displays the tree generation number. This parameter value is changed by updating at the server.
- ID=value
-
value displays the tree ID.
- DATE=generation-date-and-time
-
generation-date-and-time displays the date and time the tree was generated. This parameter's value is updated when a server update is performed and when the status of a monitoring node changes.
- CSV_VER=09000000
-
This is the CSV file format version. The value might be different depending on the version of JP1/IM - Manager.
- MSCOPE={ON | OFF}
-
Displays whether the monitoring range settings are enabled or disabled. ON means that the monitoring range settings are enabled.
- OBJ:monitoring-node-name
-
Displays the name of a monitoring node that is to be displayed in the monitoring tree. The user can change this information. You can specify a character string with a maximum of 255 bytes. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). If you use a semicolon (;) in the monitoring node name, enter two consecutive semicolons.
If the monitoring node name contains a comma (,), enclose the entire OBJ item in double-quotation marks (").
- Example:
-
To specify "monitoring,node" as the name of a monitoring node, specify as follows:
"OBJ:monitoring,node"
If you enclose the monitoring node name in double-quotation marks ("), you must enclose the monitoring node name in another set of double-quotation marks and then also enclose the entire OBJ item in double-quotation marks.
- Example:
-
To specify "monitoring node" as the monitoring node name, specify as follows:
"OBJ:""monitoring node"""
- NID:monitoring-node-ID
-
Displays the ID (8 hexadecimal characters) of the monitoring node that is to be displayed in the monitoring tree. The user can change this information.
Make sure that each monitoring node ID is unique. Specify a value in the range from 00000001 to 7FFFFFFF.
- ICO:icon-name
-
Displays a maximum of three icon names for the monitoring node, separated by the semicolon (;).
This parameter cannot be changed.
- TYPE:monitoring-node-type
-
Displays the ID that identifies the monitoring group, monitoring object, and virtual root node. This parameter cannot be changed.
- CLASS:monitoring-object-type
-
Displays the type of monitoring node. This parameter cannot be changed.
- STA:status-ID
-
Displays the ID that indicates the status of the monitoring node. This parameter cannot be changed.
- CHDT:status-update-time
-
Displays the time the status of the monitoring node was updated. This parameter cannot be changed.
- OBS:monitoring-status
-
Displays the monitoring status of the monitoring node. This parameter cannot be changed.
- STD:attribute-name=attribute-value
-
Displays the attribute name and attribute value when basic information has been defined for the monitoring node. If multiple basic information items are specified, the items are separated by the semicolon (;).
You can change only attribute-value. You can specify a maximum of 1,023 bytes# of characters for the attribute value. If you use a semicolon (;) in the attribute value, enter two consecutive semicolons.
#: The total length of the field is a maximum of 1,280 bytes (for example, if five basic information items are set, the total length of all five attribute values must be no greater than 1,280 bytes).
If the attribute value contains a comma (,), enclose the entire STD item in double-quotation marks (").
- Example:
-
To specify attribute,value as the attribute value, specify as follows:
"STD:attribute-name=attribute,value"
If you enclose the attribute value in double-quotation marks ("), you must enclose the attribute value in another set of double-quotation marks and then also enclose the entire STD item in double-quotation marks.
- Example:
-
To specify "attribute value" as the attribute value, specify as follows:
"STD:attribute-name=""attribute value"""
- BKIMG=background-image-file-name
-
Displays the name of the background image file that is set in the Visual Monitoring (Editing) window or that is set when the map is displayed in the Monitoring Tree (Editing) window. This parameter cannot be changed.
- POT:X=X-coordinate;Y=Y-coordinate;Z=Z-coordinate
-
Displays the icon location information (coordinates) that is set in the Visual Monitoring (Editing) window or that is set when the map is displayed in the Monitoring Tree (Editing) window. This parameter cannot be changed.
- CON
-
CON includes the parameters shown below. Note that if the value of TYPE is 1 (monitoring group), the CON parameter is not displayed.
- NAME=status-change-condition-name
-
Displays the status change condition name. The user can change this information. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). None of the following characters can be used: * " ' \ : ; | = + ? < . >. If the line contains more than one NAME parameter, the same status change condition name cannot be used more than once on that line.
If the status change condition name contains a comma (,), enclose the entire CON item in double-quotation marks (").
Example:
To specify "status change,condition name" as the status change condition name, specify as follows:
"CON:NAME=status change,condition name;
STA=700;
individual condition name==individual condition value"
- STA=change-status-ID
-
Displays the change status ID. This parameter cannot be changed.
- CID=common-condition-ID;common-condition-information
-
Displays the common condition ID and the common condition information. For the common condition information, the common conditions that have been set in the Status-Change Condition Settings window, such as the ID and information needed by the system for management purposes, are displayed with the items separated by the semicolon (;). This parameter cannot be changed.
- GCON
-
GCON includes the parameters described below.
Note that the GCON parameter is not displayed if the value of TYPE is 2 (monitoring object) or if no status change condition has been set for the monitoring group.
- NAME=status-change-condition-name
-
Displays the status change condition name. The user can change this information. Specifiable characters are one-byte alphanumeric characters and two-byte characters (except custom characters). None of the following characters can be specified: * " ' \ : ; | = + ? < . >. If the line contains more than one NAME parameter, the same status change condition name cannot be used more than once on that line.
If the status change condition name contains a comma (,), enclose the entire GCON item in double-quotation marks (").
- STA=change-status-ID
-
Displays the change status ID. This parameter cannot be changed.
- CSTA=child-node-status-ID
-
Displays the status IDs of child nodes. This parameter cannot be changed.
- NUM>=child-nodes-count
-
Displays the number of child nodes. This parameter cannot be changed. This parameter and the RATIO parameter are mutually exclusive.
- RATIO>=child-node-ratio
-
Displays the ratio of child nodes. This parameter cannot be changed. This parameter and the NUM parameter are mutually exclusive.
- individual-condition-name==individual-condition-value
-
Displays an individual condition if it has been set in the Status-Change Condition Settings window. If multiple individual conditions have been specified, they are separated by the semicolon (;). You can change only individual-condition-value. The == part depends on the setting in the GUI as shown below; do not change this part.
== (same as)
!= (not same as)
^= (starts with)
>= (includes)
<= (does not include)
*= (regular expression)
+= (host name comparison)
For individual-condition-value, you can specify a maximum of 1,023 bytes# of characters. If you use a semicolon (;) in an individual condition value, enter two consecutive semicolons.
#: The total length of the field is a maximum of 1,280 bytes (for example, if five individual conditions are set, the total length of all five condition values must be no greater than 1,280 bytes).
If an individual condition value contains a comma (,), enclose the entire CON item in double-quotation marks (").
Example:
To specify "individual,condition value" as the individual condition value, specify as follows:
"CON:NAME=status change condition name;
STA=700;
individual condition name==individual,condition value"
If you enclose the individual condition value in double-quotation marks ("), you must enclose the individual condition value in another set of double-quotation marks and then also enclose the entire CON item in double-quotation marks.
Example:
To specify ""individual condition value"" as the individual condition value, specify as follows:
"CON:NAME=status change condition name,;
STA=700;
individual condition name==""individual condition name"""
- EVE:STA=status-ID
-
Displays the status ID that was set in the event generation condition. This parameter cannot be changed.
- RES:JP1-resource-group-name
-
Displays the JP1 resource group name of the monitoring node. This parameter cannot be changed.
- OWN:monitoring-node-owner's-name
-
Displays the name of the monitoring node owner. This parameter cannot be changed.
- OPE:list-of-operation-items
-
Displays a list of operation items that the login user has for the monitoring node. This parameter cannot be changed.
Note
-
If you change the monitoring node ID, there may be adverse effects on the Visual Monitoring window. This is because the monitoring node IDs are used to manage the monitoring nodes that are displayed in the Monitoring Tree window and the Visual Monitoring window.
If you have changed a monitoring node ID, make sure that there are no problems on the Visual Monitoring window.