2.5.21 Register a JP1/IM-SS Item
Function
This service template uses the JP1/IM-SS command jssitementry to register Items.
This service template requires the following servers:
- JP1/IM-SS server
A server on which JP1/IM-SS is operating
- JP1/AO server
A server on which JP1/AO is operating
The following is an overview of the function:
(1) An Item is registered to the JP1/IM-SS server.
1. The JP1/IM-SS command jssitementry is issued to register a new Item in a process workboard of JP1/IM-SS. Only basic information can be registered for an Item. The Item information to be registered is specified by using the properties in the property group "Item Basic Information".
2. If the environment settings for linking with JP1/AO are already specified in JP1/IM-SS, the settings for calling the JP1/AO service execution dialog box are specified in the "related information" for the Item to be registered, by specifying all properties in the property group "JP1/IM-SS Information Related to JP1/IM-SS Linkage with JP1/AO".
The value of the property jp1imss.relatedInformationName is set as the display name of the "related information" for the Item. The URL string set in the "related information" for the Item is created by using specified property values. The format of the URL string is as follows:
URL set in the related information:
<JP1/AO-server-protocol>://<JP1/AO-server-host-name>:<JP1/AO-server-command-execution-port-number>/Automation/launcher/SubmitTask
For the values to be specified for the above properties, see hptl_jp1_imss_add_item_info_url_$n in the JP1/IM-SS system properties file (hptl_jp1_imss_main_setting.properties).
3. The severity level (jp1imss.severity) must be specified by using one of the following keys set in the JP1/IM-SS code mapping file (by default, jp1imss_itementry_codemap.conf):
Note: The names displayed in the default Item form are enclosed in parentheses.
- Emergency (Emergency)
- Alert (Alert)
- Critical (Critical)
- Error (Error)
- Warning (Warning)
- Notice (Notice)
- Information (Information)
- Debug (Debug)
To use keys other than the default keys above, create a code mapping file, and then specify the name of that file for the item that sets the remote code mapping file path (jp1imss.codeMappingFile).
For details about the code mapping file, see the "Job Management Partner 1/Integrated Management - Service Support Configuration and Operation Guide".
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products in the service-template execution system, and the OSs for the prerequisite products in the service-template execution system, see the Release Notes.
Prerequisite products in the system:
Job Management Partner 1/Automatic Operation 10-50 or later
Prerequisite products in the service-template execution system:
(1) The following product must be running on the JP1/IM-SS server:
- Job Management Partner 1/Integrated Management - Service Support 10-10 or later
OSs for the prerequisite products in the service-template execution system:
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter
(3) Windows Server 2012 R2 Standard/Datacenter
Conditions for using the prerequisite products in the service-template execution system:
(1) The process workboard to which Items are to be registered must be defined on the JP1/IM-SS server.
(2) The user ID to be specified as a property must be defined on the JP1/IM-SS server.
(3) The role ID to be specified as a property must be defined on the JP1/IM-SS server.
Conditions for using the JP1/IM-SS function for JP1/AO linkage:
(1) The JP1/IM-SS server and the JP1/AO server must be linked by single sign-on.
For details about how to set up single sign-on, see the section that describes linkage with JP1/AO in the "Job Management Partner 1/Integrated Management - Service Support Configuration and Operation Guide".
(2) Extended text data must be added to the Item form.
The name of the resource group that includes the service called by the JP1/IM-SS function for JP1/AO linkage and the extended text data for that service must be added to the Item form of JP1/IM-SS.
For details about how to set up the Item form, see the section that describes Item form customization in the "Job Management Partner 1/Integrated Management - Service Support Configuration and Operation Guide".
(3) The item IDs for extended text data must be set in the system properties file.
Set the item IDs for the extended text data added to the Item form in the JP1/IM-SS system properties file (hptl_jp1_imss_main_setting.properties). At this time, specify the item IDs as information (resource group name and service name of the service) to be inherited by JP1/AO.
For details about how to set up the system properties file, see the section that describes linkage with JP1/AO in the "Job Management Partner 1/Integrated Management - Service Support Configuration and Operation Guide".
(4) The service to be called by the JP1/IM-SS function for JP1/AO linkage must exist as a service on the JP/AO server.
Cautions
(1) Only properties that are explicitly specified are registered. To register properties that are not specified, update the Item information from the JP1/IM-SS GUI or CLI.
(2) If you specify the any of the following four properties, you must specify all of them:
- jp1imss.relatedResourceGroupName
- jp1imss.relatedResourceGroupNumber
- jp1imss.relatedServiceName
- jp1imss.relatedServiceNumber
(3) For the following properties, do not specify a value that begins with "//":
- jp1imss.titleName
- jp1imss.summary
- jp1imss.relatedInformationName
- jp1imss.relatedServiceName
Execution privilege
Administrator permission is required.
Version
01.50.01
Category
JP1_Operations/Management
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
JP1/IM-SS Environment Information |
Specify information about the JP1/IM-SS server. |
Y |
|
Item Basic Information |
Specify the basic information about the Item to be registered. |
Y |
|
Information Related to JP1/IM-SS Linkage with JP1/AO |
Specify the information needed to use the JP1/IM-SS function for JP1/AO linkage to set up a link for calling a JP1/AO service from JP1/IM-SS. |
N |
The following shows the list of the properties to be displayed in the "Service Definition" dialog box:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1imss.imssServerName |
JP1/IM-SS server host name |
Specify the host name or IP address of the JP1/IM-SS server that manages Items. Do not specify an IPv6 address. |
Input |
Disabled |
R |
JP1/IM-SS Environment Information |
|
jp1imss.processWorkBoardID |
Process workboard ID |
Specify the ID of the process workboard for which the Item is to be registered. |
Input |
Disabled |
R |
Item Basic Information |
|
jp1imss.entryUserID |
Item-registering user ID |
Specify the ID of the user who will register the Item. |
Input |
Disabled |
R |
Item Basic Information |
|
jp1imss.ownerUserType |
Person-in-charge type |
Specify USER or ROLE as the type of person in charge of the Item. |
Input |
Disabled |
R |
Item Basic Information |
|
jp1imss.ownerUserID |
Person-in-charge ID |
Specify the user ID or role ID of the user who is to be in charge of the Item. |
Input |
Disabled |
R |
Item Basic Information |
|
jp1imss.codeMappingFile |
Code mapping file path (remote) |
Specify a full path for a code mapping file on the JP1/IM-SS server if a user-defined code mapping file needs to be used. |
Input |
Disabled |
O |
Item Basic Information |
|
jp1imss.relatedIP |
JP1/AO server host name |
Specify the host name or IP address of the JP1/AO server when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. Do not specify an IPv6 address. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedPortNumber |
HTTP port for executing a JP1/AO server command |
Specify the HTTP port for executing a JP1/AO server command when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedProtocol |
JP1/AO server protocol |
Specify "http" as the protocol when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedResourceGroupNumber |
Extended text data number for resource group of service to call |
When calling JP1/AO service execution window from registered Item-related information, link JP1/IM-SS with JP1/AO to specify the extended text data number in the JP1/IM-SS system properties file as a property to assign to the service resource group name. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedServiceNumber |
Extended text data number for the service to call |
When calling the JP1/AO service execution window from registered Item-related information, link JP1/IM-SS with JP1/AO to specify the extended text data number in the JP1/IM-SS system properties file as a property to assign to the service name. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
The following shows the list of the properties to be displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1imss.titleName |
Title |
Specify the title of the Item. |
Input |
Disabled |
R |
Item Basic Information |
|
jp1imss.severity |
Severity level |
Specify the severity level to be set for the Item. |
Input |
Disabled |
O |
Item Basic Information |
|
jp1imss.summary |
Outline |
Specify the outline of the Item. |
Input |
Disabled |
O |
Item Basic Information |
|
jp1imss.relatedInformationName |
Display name of related information |
Specify the display name of the related information for the Item when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedResourceGroupName |
Resource group name of the service to be called |
Specify the resource group name of the service to be called when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
|
jp1imss.relatedServiceName |
Name of the service to call |
Specify the name of the service to be called when calling the JP1/AO service execution window from the related information for a registered Item by using JP1/IM-SS linkage with JP1/AO. |
Input |
Disabled |
O |
Information Related to JP1/IM-SS Linkage with JP1/AO |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" dialog box:
|
Property key |
Characters that can be input |
|---|---|
|
jp1imss.imssServerName |
A string that has 255 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
jp1imss.processWorkBoardID |
A string that has 64 or fewer single-byte alphanumeric characters |
|
jp1imss.entryUserID |
A string that has 64 or fewer single-byte alphanumeric characters |
|
jp1imss.ownerUserType |
Select one of the following values: USER,ROLE |
|
jp1imss.ownerUserID |
A string that has 64 or fewer single-byte alphanumeric characters, including underscores (_) |
|
jp1imss.codeMappingFile |
A string that has 4 to 255 characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % / ` |
|
jp1imss.relatedIP |
A string that has 255 or fewer single-byte alphanumeric characters, including periods (.) and hyphens (-) |
|
jp1imss.relatedPortNumber |
An integer in the range from 1 to 65,535 |
|
jp1imss.relatedProtocol |
5 or fewer single-byte alphanumeric characters |
|
jp1imss.relatedResourceGroupNumber |
An integer in the range from 1 to 20 |
|
jp1imss.relatedServiceNumber |
An integer in the range from 1 to 20 |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
|
Property key |
Characters that can be input |
|---|---|
|
jp1imss.titleName |
A string that has 512 or fewer characters, does not begin with "//" or "-", and does not include the following symbols: " $ & ; < > ` { | } |
|
jp1imss.severity |
A string that has 255 or fewer single-byte alphanumeric characters and multi-byte characters. |
|
jp1imss.summary |
A string that has 1,024 or fewer characters, does not begin with "//" or "-", and does not include the following symbols: " $ & ; < > ` { | } |
|
jp1imss.relatedInformationName |
A string that has 512 or fewer characters, does not begin with "//" or "-", and does not include the following symbols: " $ & ; < > ` { | } |
|
jp1imss.relatedResourceGroupName |
A string that has 63 or fewer single-byte alphanumeric characters, including underscores (_) and spaces |
|
jp1imss.relatedServiceName |
A string that has 64 or fewer characters, does not begin with "//" or "-", and does not include the following symbols: " $ & ; < > ` { | } |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
|||
|---|---|---|---|---|---|
|
Plug-in name |
Version |
Description |
Error recovery method |
||
|
1 |
entryItemJP1IMSS |
Register JP1/IM-SS Item |
01.13.00 |
Registers an Item to the JP1/IM-SS server. |
After removing the cause of the error, run the service again. |