Configuration file for input-candidate values (Optional)
- Organization of this page
Description
This file defines cross-setting value correlation that links and displays input-candidate values to be displayed as elements in an Item form and elements in the Item form. You need to create a Configuration file for input-candidate values for each process work board that uses the input-assistant function.
The table below shows sample Configuration files for input-candidate values provided by default. Create and customize a definition file by referencing these files.
|
File name |
Description |
|---|---|
|
IM-SS-path\home\public\inputassist\jss_input_assist_sample.txt |
Sample Configuration file for input-candidate values |
|
IM-SS-path\home\public\inputassist\jss_input_assist_sample.txt.model |
Model file for the sample Configuration file for input-candidate values |
Format
#comment #key-value = value #Settings for the IDs of elements for which you set the input-candidate values JIMSD_INPUT_ASSIST_n=element-ID : #Settings for input-candidate values element-ID_n=input-candidate-value element-ID_n=input-candidate-value : #Settings for cross-setting value correlation relation-source-element-ID_n_RELATION_relation-destination-element-ID=n[,n...] relation-source-element-ID_n_RELATION_relation-destination-element-ID=n[,n...] :
Lines starting with a hash mark (#) are treated as comments.
File name
A file name consists of the ID of a process work board that uses the input-assistant function and .txt. For example, if the process work board ID is pwb, the file name will be pwb.txt. A file with a name that consists of a process work board ID and an extension other than .txt, or a file that does not have an extension is not regarded as a Configuration file for input-candidate values.
Storage folder
IM-SS-path\home\public\inputassist
When the definition is applied
The New item window or the Edit item window opens with the definition applied.
What is described
The following is the format of the Configuration file for input-candidate values:
key-value = value :
For the Configuration file of input-candidate values, set the following items by using key values and values:
-
Settings for the IDs of elements for which you set the input-candidate values
-
Settings for input-candidate values
-
Settings for cross-setting value correlation
The key values and values to be specified for each of the above settings are described below.
Setting for the IDs of elements for which you set the input-candidate values
This section describes how to set IDs of elements for which you want to set input-candidate values.
- key-value
-
Specify JIMSD_INPUT_ASSIST_n. For n, specify an integer equal to or greater than 0, which is unique within the key values.
- value
-
Specify an element ID of an Item form. The table below lists the specifiable elements and their element IDs. Note that if you specify an element ID that is not listed in the following table, the specification becomes invalid.
Table 12‒43: List of Item elements and element IDs for which you can set input-candidate values Item element
Element ID
Title
JIMSD_FORM_TITLE
Reason for severity
JIMSD_FORM_SEVERITYREASON
Reason for impact level
JIMSD_FORM_IMPACTREASON
Reason for priority
JIMSD_FORM_PRIORITYREASON
Customer name
JIMSD_FORM_CUSTOMERNAME
Inquirer
JIMSD_FORM_INQUIRYNAME
Product name
JIMSD_FORM_JP1PRODUCTNAME
Jobnet name
JIMSD_FORM_JP1JOBNETNAME
Job name
JIMSD_FORM_JP1JOBNAME
SNMP source
JIMSD_FORM_JP1SNMPSRC
Monitored node name
JIMSD_FORM_JP1NODENAME
Alarm name
JIMSD_FORM_JP1ALARMNAME
Serial number
JIMSD_FORM_IMEVENTNO
JP1/IM-M host name
JIMSD_FORM_IMHOSTNAME
Added item: text#
JIMSD_FORM_USERTEXT01 to 05
JIMSD_FORM_USERTEXT06 to 15
JIMSD_FORM_USERTEXT16 to 20
- #
-
Elements which are supposed to be created by users. For text input elements created by users, you can set input-candidate values only for single-line elements (item-text elements). You cannot set values for multi-line elements (item-textarea elements). If you set an input-candidate value for a multi-line element, the operation is not guaranteed. For details about element types, see Item form definition file (Optional) in Chapter 12. Definition Files.
- Setting example
-
The following is an example when the elements for which you want to set input-candidate values are Title, and Customer name:
JIMSD_INPUT_ASSIST_0=JIMSD_FORM_TITLE JIMSD_INPUT_ASSIST_1=JIMSD_FORM_CUSTOMERNAME
Settings for input-candidate values
This section describes how to set input-candidate values to be displayed.
- key-value
-
Specify element-ID_n. For element-ID, specify the element ID you specified in Setting for the IDs of elements for which you set the input-candidate values. For n, specify an integer equal to or greater than 0, which is unique within the key values.
If the specified element ID is wrong, or it is not the one you specified in Setting for the IDs of elements for which you set the input-candidate values, the specification becomes invalid.
- value
-
Specify the input-candidate value to be displayed. The specifiable length of an input-candidate value (a string) is defined in hptl_jp1_imss_input_assist_nominate_string_max of the system properties. Any full-width characters in an input-candidate value are converted to three or four bytes.
- Setting example
-
The following is an example when you want to set Company A and Company B as the input-candidate values for Customer name.
JIMSD_FORM_CUSTOMERNAME_0=Company A JIMSD_FORM_CUSTOMERNAME_1=Company B
Settings for cross-setting value correlation
In this section, set cross-setting value correlation. By linking elements, you can narrow down input-candidate values for an element at the relation destination according to the selections specified for an element at the relation source.
For the relation source, you can set text-input type elements and selection-type elements in an Item form. For the relation destination, you can set text-input type elements.
When you set cross-setting value correlation for text-input type elements, you must set an input-candidate value for both relation source and relation destination elements. For cross-setting value correlation, according to the selections specified for relation source elements, input-candidate values of the relation destination elements are narrowed down. Therefore, both relation source and relation destination elements must be selection-type elements.
In addition, cross-setting value correlation can be set only for single-line text-input elements (item-text elements). It cannot be set for multiple-line elements (item-textarea elements). If an input-candidate value is set for a multiple-line element, the operation cannot be guaranteed. For a list of elements that can be set for the relation source and the relation destination, see Table 12-44 and Table 12-45.
For cross-setting value correlation, you can associate elements as follows:
-
You can associate a relation source with multiple relation destinations.
For example, you could set Customer name as the relation source, and Title and Inquirer as the relation destinations. However, you cannot set a relation destination for multiple relation sources. If you do so, this setting becomes invalid.
-
You can set an element which is set as the relation destination, as an element of the relation source.
For example, when you set Inquirer as the relation destination for Customer name of the relation source, you can also set the Inquirer as the relation source, and Title as the relation destination.
-
You can specify settings so that when an option is selected at the relation source, the input-candidate values of all associated elements are determined.
For example, when you associate Customer name, Inquirer, and Title, their input-candidate values are determined as follows:
-
Based on the selection for Customer name, input-candidate values for Inquirer and Title are determined.
-
Based on the selection for Inquirer, input-candidate values for Customer name and Title are determined.
-
Based on the selection for Title, input-candidate values for Customer name and Inquirer are determined.
When you want to associate elements as described above, set Customer name as the relation source, and set Inquirer as the relation destination. When you set Inquirer as the relation source, set Title as the relation destination. When you set Title as the relation source, set Customer name as the relation destination.
-
- key-value
-
Specify the key value in the relation-source-element-ID_n_RELATION_relation-destination-element-ID format in order to map relation source and relation destination elements.
Values to be specified for relation-source-element-ID and n differ depending on whether the relation source element format is a text input type or a selection type. For relation-destination-element-ID, specify the ID of an element which is the relation destination.
Values to be specified for relation-source-element-ID and n are described here for relation source elements of text-input type and of selection type separately.
- For text-input type elements
-
For relation-source-element-ID_n, specify element-ID_n, which you specified as the key value for the input-candidate values setting when you set the relation source input-candidate values.
- For selection type elements
-
For relation-source-element-ID, specify the element ID in an Item form. For n, specify the same value as the one entered in the display order for option value="display-order" in the selection type element format of the Item form definition file.
For details about selection type element IDs, see Table 12-45. For details about values for option value="display-order", see Item form definition file (Optional) in Chapter 12. Definition Files.
- value
-
To narrow down input-candidate values for a relation destination element, specify a value in the n[,n...] format.
For n, specify n of the key value for the input-candidate value which you specified to set the input-candidate values for a relation destination element. If you specify another value, the specification becomes invalid.
To specify multiple values, separate them with half-width commas.
- Setting example
-
The following is a setting example when Customer name is specified for the relation source, and Inquirer for the relation destination to set cross-setting value correlation:
JIMSD_FORM_CUSTOMERNAME_0_RELATION_JIMSD_FORM_INQUIRYNAME=0,1,2 JIMSD_FORM_CUSTOMERNAME_1_RELATION_JIMSD_FORM_INQUIRYNAME=3,4
The following table lists the elements that can be set for the relation source and the relation destination according to the format (text-input type or selection type) of the relation source elements.
|
Item element of the relation source (element-ID) |
Item elements that can be set for the relation destination |
|---|---|
|
Title (JIMSD_FORM_TITLE) |
Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Reason for severity (JIMSD_FORM_SEVERITYREASON) |
Title, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Reason for impact level (JIMSD_FORM_IMPACTREASON) |
Title, Reason for severity, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Reason for priority (JIMSD_FORM_PRIORITYREASON) |
Title, Reason for severity, Reason for impact level, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Customer name (JIMSD_FORM_CUSTOMERNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Inquirer (JIMSD_FORM_INQUIRYNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Product name (JIMSD_FORM_JP1PRODUCTNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Jobnet name (JIMSD_FORM_JP1JOBNETNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Job name (JIMSD_FORM_JP1JOBNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
SNMP source (JIMSD_FORM_JP1SNMPSRC) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Monitored node name (JIMSD_FORM_JP1NODENAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Alarm name (JIMSD_FORM_JP1ALARMNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Serial number (JIMSD_FORM_IMEVENTNO) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, JP1/IM-M host name, and Added item: text (01 to 20) |
|
JP1/IM-M host name (JIMSD_FORM_IMHOSTNAME) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, and Added item: text (01 to 20) |
|
Added item: text (JIMSD_FORM_USERTEXT01 to 05) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (06 to 20) |
|
Added item: text (JIMSD_FORM_USERTEXT06 to 15) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 05, 16 to 20) |
|
Added item: text (JIMSD_FORM_USERTEXT 16 to 20) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 15) |
|
Item element of the relation source (element-ID) |
Item elements that can be set for the relation destination |
|---|---|
|
Severity (JIMSD_FORM_SEVERITYCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Impact level (JIMSD_FORM_IMPACTCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Priority (JIMSD_FORM_PRIORITYCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Item type (JIMSD_FORM_ITEMCATEGORYCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, Added item: text (01 to 20) |
|
Problem domain (JIMSD_FORM_ISSUECATEGORYCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Scale of change (JIMSD_FORM_CHANGESCALECODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Release type (JIMSD_FORM_RELEASETYPECODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Result (JIMSD_FORM_RESULTCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Occurred type (JIMSD_FORM_PHENOMENONCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, Added item: text (01 to 20) |
|
Solution category (JIMSD_FORM_SOLUTIONCODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Workaround type (JIMSD_FORM_AVOIDANCECODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Cause (JIMSD_FORM_CAUSECODE) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
|
Extended code (JIMSD_FORM_USERCODE01 to 05) |
Title, Reason for severity, Reason for impact level, Reason for priority, Customer name, Inquirer, Product name, Jobnet name, Job name, SNMP source, Monitored node name, Alarm name, Serial number, JP1/IM-M host name, and Added item: text (01 to 20) |
Notes
-
Use characters other than control characters for key values and values. If a control character is used, the setting becomes invalid.
-
n, which is used as key values and values, becomes valid even if it is not sequential as long as it is unique. When you set a one-digit number, set the value in one digit. When you set a two-digit number, set the value in two digits. When you set a one-digit number, if you set it as a two-digit number, like 01, the setting becomes invalid.
-
When a key value satisfies any one of the following conditions, the setting becomes invalid:
-
A fixed string (such as _RELATION for cross-setting value correlation settings) contained in a key value is wrong.
-
Specify an element which is longer than the string comprising a key value by using an underscore (_).
-
A key value begins with a string other than JIMSD_INPUT_ASSIST or JIMSD_FORM.
-
-
When settings for the IDs of elements for which you set the input-candidate values are correct, but settings for input-candidate values are wrong or not specified, the settings for the IDs of elements for which you set the input-candidate values also become invalid. For Item elements specified for settings for the IDs of elements for which you set the input-candidate values, you cannot use the input-assistant function.
-
You can change the maximum value for n, which is used for key values and values, or the maximum number of characters for an input-candidate value in the system property. For details, see System property file (hptl_jp1_imss_main_setting.properties)in Chapter 12. Definition Files.
-
If you specify the same string more than once for settings of input-candidate values, the smallest n value for relation-source-element-ID_n is used as the key value for setting cross-setting value correlation.
-
The Configuration file for input-candidate values must be created or edited with a character encoding that is compatible with the system locale of the machine on which JP1/IM - Service Support is installed. You can use one of the following character encodings:
-
In a Japanese environment: MS932
-
In an English environment: ISO-8859-1
-
In a Chinese environment: GB18030
-
Definition example
Definition example 1
The following is an example of defining Configuration file for input-candidate values when the input-candidate value is displayed as Customer name. Input-candidate values for Customer name are Company A, Company B, and Company C.
#Setting the ID of an Item element that sets input-candidate values JIMSD_INPUT_ASSIST_0=JIMSD_FORM_CUSTOMERNAME #Setting of the input-candidate values JIMSD_FORM_CUSTOMERNAME_0=Company A JIMSD_FORM_CUSTOMERNAME_1=Company B JIMSD_FORM_CUSTOMERNAME_2=Company C
Definition example 2
A definition example of the Configuration file for input-candidate values when cross-setting value correlation is set for text-input type elements at both relation source and relation destination is shown below.
Set the relation source as Customer name, and the relation destination as Inquirer. Input-candidate values for Customer name are Company A, Company B, Company C, and Company D. Input-candidate values for Inquirer are Taro Hitachi, Jiro Hitachi, Saburo Hitachi, Shiro Hitachi, and Goro Hitachi.
When Company A is selected at the relation source, Taro Hitachi and Jiro Hitachi are displayed as input-candidate values at the relation destination. When Company B is selected at the relation source, Jiro Hitachi and Saburo Hitachi are displayed as the relation destination. When Company C is selected at the relation source, Saburo Hitachi and Shiro Hitachi are displayed as the input-candidate values at the relation destination. When Company D is selected at the relation source, Shiro Hitachi and Goro Hitachi are displayed as the input-candidate values at the relation destination.
#Settings for the ID of the Item element that sets the input-candidate values JIMSD_INPUT_ASSIST_0=JIMSD_FORM_CUSTOMERNAME JIMSD_INPUT_ASSIST_1=JIMSD_FORM_INQUIRYNAME #Settings for the input-candidate values JIMSD_FORM_CUSTOMERNAME_0=Company A JIMSD_FORM_CUSTOMERNAME_1=Company B JIMSD_FORM_CUSTOMERNAME_2=Company C JIMSD_FORM_CUSTOMERNAME_3=Company D JIMSD_FORM_INQUIRYNAME_0=Taro Hitachi JIMSD_FORM_INQUIRYNAME_1=Jiro Hitachi JIMSD_FORM_INQUIRYNAME_2=Saburo Hitachi JIMSD_FORM_INQUIRYNAME_3=Shiro Hitachi JIMSD_FORM_INQUIRYNAME_4=Goro Hitachi #Settings for cross-setting value correlation JIMSD_FORM_CUSTOMERNAME_0_RELATION_JIMSD_FORM_INQUIRYNAME=0,1 JIMSD_FORM_CUSTOMERNAME_1_RELATION_JIMSD_FORM_INQUIRYNAME=1,2 JIMSD_FORM_CUSTOMERNAME_2_RELATION_JIMSD_FORM_INQUIRYNAME=2,3 JIMSD_FORM_CUSTOMERNAME_3_RELATION_JIMSD_FORM_INQUIRYNAME=3,4
Definition example 3
The definition example below of the Configuration file for input-candidate values when cross-setting value correlation is set for elements where the relation source is selection type format and the relation destination is text-input type format.
Set the relation source as Severity, and the relation destination as Reason for severity. Severity is defined as follows in the Item form definition file:
<item-code fiid="JIMSD_FORM_SEVERITYCODE" search="true" >
<label labelname="Severity" />
<options>
<option value="0"></option>
<option value="1">Emergency</option>
<option value="2">Alert</option>
<option value="3">Critical</option>
</options>
</item-code>Input-candidate values for Reason for severity are Reason, Reason 1, Reason 2, Reason 3, Reason 4, and Reason 5.
If the relation source is Not selected, Reason, Reason 1, and Reason 2 are displayed as the input-candidate values for the relation destination. When Emergency is selected at the relation source, Reason 3, Reason 4, and Reason 5 are displayed as the input-candidate values for the relation destination. When Alert is selected at the relation source, Reason 1, Reason 3, and Reason 5 are displayed as the input-candidate values for the relation destination.
#Settings for the ID of the Item element that sets the input-candidate values JIMSD_INPUT_ASSIST_0=JIMSD_FORM_SEVERITYREASON #Settings for the input-candidate values JIMSD_FORM_SEVERITYREASON_0=Reason JIMSD_FORM_SEVERITYREASON_1=Reason 1 JIMSD_FORM_SEVERITYREASON_2=Reason 2 JIMSD_FORM_SEVERITYREASON_3=Reason 3 JIMSD_FORM_SEVERITYREASON_4=Reason 4 JIMSD_FORM_SEVERITYREASON_5=Reason 5 #Settings for cross-setting value correlation JIMSD_FORM_SEVERITYCODE_0_RELATION_JIMSD_FORM_SEVERITYREASON=0,1,2 JIMSD_FORM_SEVERITYCODE_1_RELATION_JIMSD_FORM_SEVERITYREASON=3,4,5 JIMSD_FORM_SEVERITYCODE_2_RELATION_JIMSD_FORM_SEVERITYREASON=1,3,5