4.11.1 Update JP1/IM-SS Instance
Function
This plug-in is used to issue the JP1/IM-SS command jssitemedit for updating information about Items registered in a JP1/IM-SS process workboard.
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) The specified properties of a specified Item on the JP1/IM-SS server are updated to the specified values. Only properties that are explicitly specified are updated.
(2) The values of the following properties must be specified by using the keys set in the code mapping file (by default, jp1imss_itemedit_codemap.conf):
a) Status (JP1IMSS.statusTypeCode)
b) Cause code (JP1IMSS.causeTypeCode)
c) Result code (JP1IMSS.resultTypeCode)
d) Workaround type code (JP1IMSS.avoidTypeCode)
e) Solution type code (JP1IMSS.solvedTypeCode)
The following default keys can be used for each setting:
a) Status (JP1IMSS.statusTypeCode)
- Received
- Investigating
- Planning
- Discussing
- Support requested
- Reviewing
- Acknowledged
- Close
- Extended status 01 to 40
b) Cause code (JP1IMSS.causeTypeCode)
- Blank
- New software error
- Known software error
- New hardware error
- Known hardware error
- Document error
- Document missing
- User error
- Specifications
- Third-party error
- Process error
- Customer request
- Function extension
- Business requirement
- Incident and problem fix
- Process improvement
c) Result code (JP1IMSS.resultTypeCode)
- Blank
- Completed
- Canceled
- Not confirmed
- Change completed
- Known problem
- Unknown cause
- Succeeded
- Failed (planning error)
- Failed (human error)
- Failed (others)
d) Workaround type code (JP1IMSS.avoidTypeCode)
- Blank
- None
- Not operated
- Operated in degraded mode
- Restarted
- File recovered
- Change rolled back
- Others
e) Solution type code (JP1IMSS.solvedTypeCode)
- Blank
- Knowledge
- Document
- User solution
- Secondary support
- Problem management
- Third-party investigation
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".
Use situation
This service template updates the status of a JP1/IM-SS Item as an extension of problem-recovery processing.
For example, after checking a registered Item, a JP1/IM-SS operator opens the service execution window of JP1/Automatic Operation (hereafter referred to as "JP1/AO") and executes the service template for problem recovery, which includes plug-ins for correcting the failure and updating the Item status on the JP1/IM-SS server. By this process, this service template can be used to update the status of a JP1/IM-SS Item.
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 JP1/IM-SS 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 Item to be updated must exist 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.
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)The free column in which a 1024 or more character setup is possible at JP1/IM-SS can be inputted only to 1024 characters by JP1/AO.
(3) Do not specify a value that begins with "//" for any of the above properties.
(4) 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
jp1IMSSeditItem
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.itemID |
Instance ID |
Specify the instance ID of the JP1/IM-SS to update. |
-- |
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.statusTypeCode |
Status |
Specify the status to configure to the instance. |
-- |
Input |
R |
|
JP1IMSS.closeDateTime |
Closing Date and Time (YYYY/MM/DD hh:mm[:ss]) |
Specify the closing date and time of the instance as YYYY/MM/DD hh:mm:ss or YYYY/MM/DD hh:mm. |
-- |
Input |
O |
|
JP1IMSS.causeTypeCode |
Cause Code |
Specify the cause code to configure to the instance. |
-- |
Input |
O |
|
JP1IMSS.resultTypeCode |
Result Code |
Specify the result code to configure to the instance. |
-- |
Input |
O |
|
JP1IMSS.avoidTypeCode |
Avoidance Type Code |
Specify the avoidance type code to configure to the instance. |
-- |
Input |
O |
|
JP1IMSS.solvedTypeCode |
Solution Type Code |
Specify the solution type code to configure to the instance. |
-- |
Input |
O |
|
JP1IMSS.freeText |
Free Input Field |
Specify a character string to configure for the free input field of the instance. |
-- |
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.forceWrite |
Update of Instances Being Edited |
Specify "true" to update instances even when the instances are being edited. Otherwise, specify "false". |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |