4.11.2 Register JP1/IM-SS Instance
Function
This plug-in is used to issue the JP1/IM-SS command jssitementry for registering a new Item in a JP1/IM-SS process workboard.
If the environment settings for linking with JP1/AO are specified in JP1/IM-SS, this plug-in can also be used to register the "related information" required to call the JP1/AO service execution dialog box from the JP1/IM-SS window.
This plug-in requires the following servers:
- JP1/IM-SS server
A server on which JP1/IM-SS is operating
The following is an overview of the processing:
(1) An Item is registered with the specified values in the specified process workboard on the JP1/IM-SS server. Only properties that are explicitly specified are registered.
(2) The values of the following properties must be specified by using the keys set in the JP1/IM-SS code mapping file (by default, jp1imss_itementry_codemap.conf):
a) Severity (JP1IMSS.severity)
b) Influence (JP1IMSS.influence)
c) Priority (JP1IMSS.priority)
d) Item type (JP1IMSS.incidentType)
e) Problem field (JP1IMSS.filedType)
The following default keys can be used for each setting:
a) Severity (JP1IMSS.severity)
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)
b) Influence (JP1IMSS.influence)
Note: The names displayed in the default Item form are enclosed in parentheses.
- S (Small)
- M (Medium)
- B (Large)
c) Priority (JP1IMSS.priority)
Note: The names displayed in the default Item form are enclosed in parentheses.
- N (Standard)
- M (Urgent)
- H (Very urgent)
d) Item type (JP1IMSS.incidentType)
Note: The names displayed in the default Item form are enclosed in parentheses.
- QUE (Inquiry)
- FAL (Failure)
- CR (Customer request)
e) Problem field (JP1IMSS.filedType)
Note: The names displayed in the default Item form are enclosed in parentheses.
- APP (Application)
- MID (Middleware)
- OS (OS)
- HRD (Hardware)
- NET (Network)
- PRO (Process)
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 "JP1/Service Support Configuration and Operation Guide".
(3) The values that can be specified for extended code data (JP1IMSS.extendData) must be defined by creating a code mapping file.
(4) To use the JP1/IM-SS function for JP1/AO linkage, the keywords used to specify the service name and service group name of the JP1/AO service to be called must be specified in the JP1/IM-SS system properties file (hptl_jp1_imss_main_setting.properties). If extended text data is specified for the properties below, user settings can be changed by simply changing the property values, regardless of which extended text data element is to be used.
- JP1IMSS.relatedResourceGroupName (Name of the service group that includes the service to be called by the JP1/IM-SS function for JP1/AO linkage)
- JP1IMSS.relatedResourceGroupNumber (Number of the extended text data element to be assigned to the service group that includes the service to be called by the JP1/IM-SS function for JP1/AO linkage)
- JP1IMSS.relatedServiceName (Name of the service to be called by the JP1/IM-SS function for JP1/AO linkage)
- JP1IMSS.relatedServiceNumber (Number of the extended text data element to be assigned to the service to be called by the JP1/IM-SS function for JP1/AO linkage)
Use situation
This service template registers an Item in JP1/IM-SS as an extension of an automatic action of JP1/Integrated Management - Manager (hereafter referred to as "JP1/IM").
For example, when failure information is registered in JP1/IM, a JP1/IM automatic action calls a JP1/Automatic Operation (hereafter referred to as JP1/AO) service template that includes plug-ins for determining whether the failure is already known, obtaining failure information, and registering an Item to the JP1/IM-SS server. By this process, this service template can be used to register Items to JP1/IM-SS.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) The following product must be running on the job server:
- Job Management Partner 1/Integrated Management - Service Support 10-10 or later, or
JP1/Service Support 11-00 or later
OSs for the prerequisite products on the execution-target server:
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
Conditions for using the prerequisite products on the execution-target server:
(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 "JP1/Service Support Configuration and Operation Guide".
(2) Extended text data must be added to the Item form.
The name of the service 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 "JP1/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 (the service 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) To register the "related information" for calling the JP1/AO service execution dialog box from the JP1/IM-SS window, specify all of the following properties:
- JP1IMSS.relatedInformationName
- JP1IMSS.referURL
- JP1IMSS.relatedResourceGroupName
- JP1IMSS.relatedResourceGroupNumber
- JP1IMSS.relatedServiceName
- JP1IMSS.relatedServiceNumber
(3) If you specify all of properties listed below, for the extended text data elements corresponding to the numbers specified in properties (b) and (d), the values of properties (a) and (c) will be given priority over the values of properties JP1IMSS.extendText1 to JP1IMSS.extendText20.
(a) JP1IMSS.relatedResourceGroupName
(b) JP1IMSS.relatedResourceGroupNumber
(c) JP1IMSS.relatedServiceName
(d) JP1IMSS.relatedServiceNumber
(4) Do not specify a value that begins with "//" for any of the above properties.
(5) If the user ID set in the authentication information of Connection Destination definitions setting is not the built-in Administrator, one of the following conditions must be satisfied.
- The UAC feature in Windows is completely disabled.
- An RDP session has been established for the user ID set in the authentication information of the Connection Destination definitions setting on the target of connection destinations.
Execution privilege
Administrators permissions
Version
02.00.00
Plug-in tags
Configure JP1,SS,Windows
Plug-in name displayed in the task log
jp1IMSSentryItem
Return code
0: Normal
12: Error (Mistake by user) Invalid property
21: Error (Environmental error) No command was found (An error was detected in the component script)
25: Error (invalid environment) Communication error
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
42: Error (error detected in module) Internal error (error detected in the module script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
JP1IMSS.processWorkBoardID |
Process Workboard ID |
Specify the ID of the process workboard of the JP1/IM server. |
-- |
Input |
R |
|
JP1IMSS.subjectTitle |
Instance Title |
Specify the title of the instance. |
-- |
Input |
R |
|
JP1IMSS.registerID |
Registrar ID |
Specify the ID of the user that will be the registrar of the instance. |
-- |
Input |
R |
|
JP1IMSS.staffType |
Staff Type |
Specify the staff type ("USER" or "ROLE"). |
-- |
Input |
R |
|
JP1IMSS.staffID |
Staff ID |
Specify the ID of the user or the ID of the role that will be the staff in charge of the instance. |
-- |
Input |
R |
|
JP1IMSS.severity |
Severity |
Specify the severity to configure for the instance. |
-- |
Input |
O |
|
JP1IMSS.influence |
Influence |
Specify the influence to configure for the instance. |
-- |
Input |
O |
|
JP1IMSS.priority |
Priority |
Specify the priority to configure for the instance. When the instance automatic input settings are enabled, the value specified in the instance automatic input property file for the command will be configured. |
-- |
Input |
O |
|
JP1IMSS.incidentType |
Instance Type |
Specify the instance type. |
-- |
Input |
O |
|
JP1IMSS.filedType |
Problem Field |
Specify the problem field of the instance. |
-- |
Input |
O |
|
JP1IMSS.customerName |
Customer Name |
Specify the name of the customer to configure for the instance. |
-- |
Input |
O |
|
JP1IMSS.reqName |
Requestor |
Specify the requestor to configure for the instance. |
-- |
Input |
O |
|
JP1IMSS.impacts |
Influenced Tasks |
Specify the influenced tasks to configure for the instance. You can configure a letter sequence replacement configuration file to replace certain letters with a line break and register a sequence of letters. |
-- |
Input |
O |
|
JP1IMSS.summary |
Summary |
Specify the summary of the instance. You can configure a letter sequence replacement configuration file to replace certain letters with a line break and register a sequence of letters. |
-- |
Input |
O |
|
JP1IMSS.relatedInformationName |
Display Name of Related Information of Instance |
Specify the display name of the related information of the instance. |
-- |
Input |
O |
|
JP1IMSS.referURL |
Related Information |
Specify the URL for related information. |
-- |
Input |
O |
|
JP1IMSS.linkItemID |
Related Instance ID (Multiple Entries Accepted) |
Specify the ID of related instances in order to link to related instances. Specify the ID with a character string of up to 128 bytes. Separate entries with a comma when specifying multiple items. A maximum of 10 items can be specified. |
-- |
Input |
O |
|
JP1IMSS.occurenceDateTime |
Occurrence Date and Time |
Specify the occurrence date and time of the instance as YYYY/MM/DD hh:mm:ss or YYYY/MM/DD hh:mm. If the instance automatic input settings of the process workboard are enabled, the command execution time will be configured when this field is omitted. |
-- |
Input |
O |
|
JP1IMSS.startDateTime |
Start Date and Time |
Specify the start date and time of the instance as YYYY/MM/DD hh:mm:ss or YYYY/MM/DD hh:mm. If the instance automatic input settings of the process workboard are enabled, the command execution time will be configured when this field is omitted. |
-- |
Input |
O |
|
JP1IMSS.deadLine |
Task Deadline |
Specify the task deadline of the instance as YYYY/MM/DD hh:mm:ss or YYYY/MM/DD hh:mm. If the instance automatic input settings are enabled, a value of the configured time added to the command execution time will be configured when this field is omitted. |
-- |
Input |
O |
|
JP1IMSS.extendText1 |
Extended Text Data 1 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText2 |
Extended Text Data 2 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText3 |
Extended Text Data 3 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText4 |
Extended Text Data 4 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText5 |
Extended Text Data 5 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText6 |
Extended Text Data 6 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText7 |
Extended Text Data 7 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText8 |
Extended Text Data 8 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText9 |
Extended Text Data 9 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText10 |
Extended Text Data 10 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText11 |
Extended Text Data 11 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText12 |
Extended Text Data 12 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText13 |
Extended Text Data 13 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText14 |
Extended Text Data 14 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText15 |
Extended Text Data 15 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText16 |
Extended Text Data 16 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText17 |
Extended Text Data 17 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText18 |
Extended Text Data 18 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText19 |
Extended Text Data 19 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendText20 |
Extended Text Data 20 |
Specify the item as a character string customized by the user. |
-- |
Input |
O |
|
JP1IMSS.extendDateTime |
Extended Time Data (Multiple Entries Accepted) |
Specify the item as a DATE customized by the user. This item can be entered as YYYY/MM/DD hh:mm:ss or YYYY/MM/DD hh:mm. Separate entries with a comma when specifying multiple items. A maximum of 5 items can be specified. |
-- |
Input |
O |
|
JP1IMSS.extendData |
Extended Code Data (Multiple Entries Accepted) |
Specify the item as a code customized by the user. Separate entries with a comma when specifying multiple items. A maximum of 5 items can be specified. Make sure to specify a code mapping file when using extended code data. |
-- |
Input |
O |
|
JP1IMSS.extendNumericValue |
Extended Numeric Value Data (Multiple Entries Accepted) |
Specify the item as a numeric value customized by the user. This item can be entered as a decimal integer value in the range of 0 to 2147483647. Separate entries with a comma when specifying multiple items. A maximum of 5 items can be specified. |
-- |
Input |
O |
|
JP1IMSS.extendUserID |
User ID or Role ID (Multiple Entries Accepted) |
Specify the item as a user or role customized by the user. This item can be entered as a "USER user ID" or a "ROLE role ID". Separate entries with a comma when specifying multiple items. A maximum of 5 items can be specified. |
-- |
Input |
O |
|
JP1IMSS.codeMappingFile |
Code Mapping File (Remote) |
Specify the full path of the code mapping file name on the JP1/IM-SS server when using a code mapping file defined by a user. |
-- |
Input |
O |
|
JP1IMSS.relatedResourceGroupName |
Name of Service Group to which Instance Update Service of JP1/IM-SS Belongs |
Specify the name of the service group to which the instance update service of JP1/IM-SS belongs. |
-- |
Input |
O |
|
JP1IMSS.relatedResourceGroupNumber |
Extended Text Data Number to Assign to Name of Service Group to which Instance Update Service of JP1/IM-SS belongs |
Specify the number of the extended text data that stores the service group name. Specify the number of the extended text data to the system property file of JP1/IM-SS (hptl_jp1_imss_main_setting.properties). |
-- |
Input |
O |
|
JP1IMSS.relatedServiceName |
Service Name of Instance Update Service of JP1/IM-SS |
Specify the service name of the instance update service of JP1/IM-SS. |
-- |
Input |
O |
|
JP1IMSS.relatedServiceNumber |
Extended Text Data Number to Assign to Service Name of Instance Update Service of JP1/IM-SS |
Specify the number of the extended text data that stores the service name. Specify the number of the extended text data to the system property file of JP1/IM-SS (hptl_jp1_imss_main_setting.properties). |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |