2.5.13 Update JP1/IM-SS Item information

Function

This service template updates the statuses of registered Items by using the JP1/IM-SS command jssitemedit.

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) Information about an Item registered on the JP1/IM-SS server is updated.

1. The JP1/IM-SS command jssitemedit is issued to update the Item information to the specified values.

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".

Only basic information can be updated for an Item. The Item information to be updated is specified by using the properties in the property group "Item Basic Information".

2. The value of the status (jp1imss.statusTypeCode property) must be specified by using one of the followings keys set in the JP1/IM-SS code mapping file (by default, jp1imss_itemedit_codemap.conf):

- Received

- Investigating

- Planning

- Discussing

- Support requested

- Reviewing

- Acknowledged

- Close

- Extended status 01 to 40

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".

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:

JP1/Automatic Operation 12-00 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, or

JP1/Service Support 11-00 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, Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

Conditions for using the prerequisite products in the service-template execution system:

(1) The Item specified by the Item ID 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 updated. To update properties that are not specified, update them from the JP1/IM-SS GUI or CLI.

Execution privilege

Built-in Administrator

Version

02.00.00

Tags

Configure JP1,SS

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 edited.	Y

The following shows the list of the properties to be displayed in the "Service Definition" window:

(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.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

The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
jp1imss.itemID	Item ID	Specify an ID that uniquely identifies the Item. Specify the Item ID in JP1/IM-SS.	Input	Disabled	R	Item Basic Information
jp1imss.statusTypeCode	Status	Specify the status to be set for the Item.	Input	Disabled	R	Item Basic Information
jp1imss.forceWrite	Whether the Item being editing can be updated	If "true" is specified, the Item can be updated while it is being edited. If "false" is specified, the Item cannot be updated while it is being edited. The default is "false".	Input	Disabled	O	Item Basic Information

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

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.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: < > \| ; & * ? " % / `

The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Characters that can be input
jp1imss.itemID	A string that has 75 or fewer single-byte alphanumeric characters, including hyphens (-)
jp1imss.statusTypeCode	A string that has 255 or fewer single-byte alphanumeric characters and multi-byte characters
jp1imss.forceWrite	Select one of the following values: true,false

Property key

Characters that can be input

jp1imss.itemID

A string that has 75 or fewer single-byte alphanumeric characters, including hyphens (-)

jp1imss.statusTypeCode

A string that has 255 or fewer single-byte alphanumeric characters and multi-byte characters

jp1imss.forceWrite

Select one of the following values:

true,false

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
Hierarchy	Display name	Plug-in name	Description	Error recovery method
1	updateItemJP1IMSS	Update JP1/IM-SS Item information	Updates Items registered to the JP1/IM-SS server.	After removing the cause of the error, run the service again.

To Page Top