Hitachi

JP1 Version 12 JP1/Service Support Configuration and Administration Guide


jssitemedit (edits an Item)

Organization of this page

Description

This command searches for the target Item in the Item management database using the specified process work board serial number or serial number as the search key. Then the command edits the data of the found Item. If you do not specify a new value for any particular datum of the Item, the system assumes the old value for that datum. After you execute this command to edit the data of an Item, the history of the Item data is stored in the Item management database.

Format

jssitemedit -b process-work-board-ID
             -r registrant-ID
             -cht person-in-charge-type
             -ch person-in-charge-ID
             {-pi process-work-board-serial-number
              [-evt JP1/IM - Manager-host-name serial-number] | 
              -evt JP1/IM - Manager-host-name serial-number}
            [-st status]
            [-ctdate end-date-and-time]
            [-causc cause-code]
            [-rsltc result-code]
            [-avodc workaround-type-code]
            [-soltc solution-category-code]
            [-chsc scale-of-change]
            [-rtyp release-type]
            [-phem occurred-type]
            [-fail problem-component-and-version]
            [-solt solution]
            [-avod workaround]
            [-rcaus fundamental-cause]
            [-s severity]
            [-ipt impact-level]
            [-pr priority]
            [-srsn reason-for-severity]
            [-iptrsn reason-for-impact-level]
            [-prrsn reason-for-priority]
            [-itmc Item-type]
            [-isuc problem-domain]
            [-t title]
            [-det overview]
            [-sit work-status]
            [-ins impact-service]
            [-cus customer-name]
            [-reqp inquirer]
            [-shdl schedule-and-main-steps]
            [-eval impact-assessment-for-change]
            [-dlrst discussions-result]
            [-mesu how-to-avoid-the-problem-in-the-future]
            [-free free-memo-column]
            [-ecost cost-(planed)]
            [-acost cost-(actual)]
            [-acdate occurrence-date-and-time]
            [-stdate start-date-and-time]
            [-deadline deadline]
            [-jp1 product-name]
            [-jobnet jobnet-name]
            [-job job-name]
            [-snmp SNMP-source]
            [-node monitored-node-name]
            [-alarm alarm-name]
            [-utextn n-pieces-of-extended-text-data]
            [-utimen n-pieces-of-extended-time-data]
            [-ucoden n-pieces-of-extended-code-data]
            [-uintn n-pieces-of-extended-numerical-data]
            [-uurinfon n-user-types-or-role-types n-user-IDs-or-role-IDs]
            [-m code-mapping-file-name]
            [-f]
            [-mail]

Required execution permission

Administrator permissions

Storage folder

JP1/SS-path\bin\

Arguments

-b process-work-board-ID

Use no more than 64 half-width alphanumeric characters to specify the process work board ID of the new process work board where you want to register the target Item.

-r registrant-ID

Use no more than 64 half-width alphanumeric characters to specify the ID of the new registrant of the target Item.

An error occurs in the following cases:

  • No user with the specified ID exists.

  • The user with the specified ID does not have the permission to register Items in the specified process work board.

-cht person-in-charge-type

Specify USER or ROLE as the new type of the person who is in charge of the target Item. The type is not case sensitive.

-ch person-in-charge-ID

Use no more than 64 half-width alphanumeric characters and underscores (_) to specify the new user ID of the person in charge of the target Item or the new role ID of the role in charge of the target Item.

-pi process-work-board-serial-number

Specify the process work board serial number of the Item to be edited.

When executing the jssitemedit command, you must specify either the -pi option or the -evt option, or both.

If you specify both options, the command uses the process work board serial number specified by the -pi option as the search key for the target Item. Then the command uses the JP1/IM - Manager host name and the serial number specified in the -evt option as the new JP1/IM - Manager host name and serial number for the target Item.

For details about how to check process work board serial numbers, see 3.2.2(1) List of Items.

-evt JP1/IM - Manager-host-name serial-number

Specify the name of the JP1/IM - Manager host that registered the JP1 event as the Item to be edited. Also, use a decimal number in the range from 0 to 2,147,483,647 to specify the serial number of the JP1 event.

When executing the jssitemedit command, you need to specify either the -pi option or the -evt option, or both.

If you specify both options, the command uses the process work board serial number specified in the -pi option as the search key for the target Item. Then the command uses the JP1/IM - Manager host name and the serial number specified in the -evt option as the new JP1/IM - Manager host name and serial number for the target Item. If you specify the -evt option alone, the command uses the JP1/IM - Manager host name and the serial number specified in the -evt option as the search keys. Also note that if you specify only the -evt option, the specified JP1/IM - Manager host name and serial number might be insufficient to identify the target Item and an error might occur.

-st status

Specifies the new status to be set for the target Item. You can specify one of the following by default:

  • Received

  • Investigating

  • Planning

  • Discussing

  • Support requested

  • Reviewing

  • Acknowledged

  • Close

  • Extended status#

#

You can specify any of the extended statuses. The default extended statuses are extended status 01 to extended status 40.

If you have changed any status names, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13 Definition Files.

-ctdate end-date-and-time

Specifies the new date and time of completion to be set for the target Item in YYYY/MM/DD hh:mm:ss format or YYYY/MM/DD hh:mm format. You can specify a date and time in the range from 1970/01/02 00:00:00 to 2036/12/31 23:59:59.

Note that even if you specify the date and time of completion for an Item in YYYY/MM/DD hh:mm:ss format, it will be displayed in YYYY/MM/DD hh:mm format in the View Item window, in the Edit item window, and in Item previews in the main window. However, when you output the Item to a CSV file, the date and time of completion will be displayed in YYYY/MM/DD hh:mm:ss format.

-causc cause-code

Specifies the new cause to be set for the target Item. You can specify one of the following by default:

  • Blank

  • New software error

  • Known software error

  • New hardware error

  • Known hardware error

  • Documentation error

  • Document missing

  • User error

  • Specifications

  • Third-party error

  • Process error

  • Customer request

  • Function extension

  • Business requirement

  • Incident and problem fix

  • Process improvement

If you have customized any causes, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-rsltc result-code

Specifies the new result to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Completed

  • Canceled

  • Not confirmed

  • Change completed

  • Known problem

  • Unknown cause

  • Succeeded

  • Failed (planning error)

  • Failed (human error)

  • Failed (others)

If you have customized any results, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-avodc workaround-type-code

Specifies the new workaround type to be set for the target Item. You can specify one of the following by default:

  • Blank

  • None

  • Not operated

  • Operated in degraded mode

  • Restarted

  • File recovered

  • Change rolled back

  • Others

If you have customized any workaround types, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-soltc solution-category-code

Specifies the new solution category to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Knowledge

  • Document

  • User solution

  • Secondary support

  • Problem management

  • Third-party investigation

If you have customized the solution categories, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-chsc scale-of-change

Specifies the new scale of change to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Small scale

  • Middle scale

  • Large scale

If you have customized any scales of change, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-rtyp release-type

Specifies the new release type to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Package release

  • Full release

  • Delta release

If you have customized any release types, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-phem occurred-type

Specifies the new occurred type to be set for the target Item. No default value exists. If you want to specify an occurred type, create a code mapping file (jp1imss_itemedit_codemap.conf) for the applicable Item form. Use the -m option to specify the code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-fail problem-component-and-version

Use a character string consisting of 1,024 bytes or less to specify the new problem component and version to be set for the target Item. For problem-component-and-version, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-solt solution

Use a character string consisting of 4,096 bytes or less to specify the new solution to be set for the target Item. For solution, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-avod workaround

Use a character string consisting of 4,096 bytes or less to specify the new workaround to be set for the target Item. For workaround, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-rcaus fundamental-cause

Use a character string consisting of 4,096 bytes or less to specify the new fundamental cause to be set for the target Item. For fundamental-cause, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-s severity

Specifies the new severity level to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Emergency

  • Alert

  • Critical

  • Error

  • Warning

  • Notice

  • Information

  • Debug

If you have customized any severity levels, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-ipt impact-level

Specifies the new impact level to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Small

  • Middle

  • Large

If you have customized any impact levels, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-pr priority

Specifies the new priority level to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Standard

  • Emergency

  • Very urgent

If you have customized any priority levels, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

If you do not specify a value in the -pr option, the priority level is not updated even if the automatic input function for Items is enabled.

-srsn reason-for-severity

Use a character string consisting of 512 bytes or less to specify the new reason for the severity level to be set for the target Item. For reason-for-severity, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-iptrsn reason-for-impact-level

Use a character string consisting of 512 bytes or less to specify the new reason for the impact level to be set for the target Item. For reason-for-impact-level, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-prrsn reason-for-priority

Use a character string consisting of 512 bytes or less to specify the new reason for the priority level to be set for the target Item. For reason-for-priority, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-itmc Item-type

Specifies the new Item type to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Inquiry

  • Failure

  • Customer request

If you have customized any Item types, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-isuc problem-domain

Specifies the new problem domain to be set for the target Item. You can specify one of the following by default:

  • Blank

  • Application

  • Middleware

  • OS

  • Hardware

  • Network

  • Process

If you have customized any problem domains, use the -m option to specify the relevant code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-t title

Use a character string consisting of 512 bytes or less to specify the new title of the target Item. For title, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-det overview

Use a character string consisting of 2,048 bytes or less to specify the new overview to be set for the target Item. For overview, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-sit work-status

Use a character string consisting of 4,096 bytes or less to specify the new work status to be set for the target Item. For work-status, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-ins impact-service

Use a character string consisting of 255 bytes or less to specify the new impact-service to be set for the target Item. For impact-service, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-cus customer-name

Use a character string consisting of 1,024 bytes or less to specify the new customer name to be set for the target Item. For customer-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-reqp inquirer

Use a character string consisting of 255 bytes or less to specify the new inquirer to be set for the target Item. For inquirer, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-shdl schedule-and-main-steps

Use a character string consisting of 4,096 bytes or less to specify the new schedule or main steps to be set for the target Item. For schedule-and-main-steps, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-eval impact-assessment-for-change

Use a character string consisting of 4,096 bytes or less to specify the new impact assessment for change to be set for the target Item. For impact-assessment-for-change, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-dlrst discussions-result

Use a character string consisting of 2,048 bytes or less to specify the new discussions result to be set for the target Item. For discussions-result, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-mesu how-to-avoid-the-problem-in-the-future

Use a character string consisting of 4,096 bytes or less to specify the new thought for preventing reoccurrence to be set for the target Item. For thought-for-preventing-reoccurrence, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-free free-memo-column

Use a character string consisting of 4,096 bytes or less to specify the new free memo to be set for the target Item. For free-memo-column, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-ecost cost-(planned)

Use a decimal integer in the range from 0 to 2,147,483,647 to specify the new cost (planned) to be set for the target Item.

-acost cost-(actual)

Use a decimal integer in the range from 0 to 2,147,483,647 to specify the new cost (actual) to be set for the target Item.

-acdate occurrence-date-and-time

Specifies the new date and time of occurrence to be set for the target Item in YYYY/MM/DD hh:mm:ss format or YYYY/MM/DD hh:mm format. For occurrence-date-and-time, you can specify a date and time in the range from 1970/01/02 00:00:00 to 2036/12/31 23:59:59.

Note that even if you specify the date and time of occurrence for an Item in YYYY/MM/DD hh:mm:ss format, it will be displayed in YYYY/MM/DD hh:mm format in the View Item window, in the Edit item window, and in Item previews in the main window. However, when you output the Item to a CSV file, the date and time of occurrence will be displayed in YYYY/MM/DD hh:mm:ss format.

-stdate start-date-and-time

Specifies the new date and time of start to be set for the target Item in YYYY/MM/DD hh:mm:ss format or YYYY/MM/DD hh:mm format. For start-date-and-time, you can specify a date and time in the range from 1970/01/02 00:00:00 to 2036/12/31 23:59:59.

Note that even if you specify the date and time of start for an Item in YYYY/MM/DD hh:mm:ss format, it will be displayed in YYYY/MM/DD hh:mm format in the View Item window, in the Edit item window, and in Item previews in the main window. However, when you output the Item to a CSV file, the date and time of start will be displayed in YYYY/MM/DD hh:mm:ss format.

-deadline deadline

Specifies the new deadline to be set for the target Item in YYYY/MM/DD hh:mm:ss format or YYYY/MM/DD hh:mm format. For deadline, you can specify a date and time in the range from 1970/01/02 00:00:00 to 2036/12/31 23:59:59. If you do not specify a value in the -deadline option, the deadline is not updated even if the automatic input function for Items is enabled.

Note that even if you specify a deadline for an Item in YYYY/MM/DD hh:mm:ss format, it will be displayed in YYYY/MM/DD hh:mm format in the View Item window, in the Edit item window, and in Item previews in the main window. However, when you output the Item to a CSV file, the deadline will be displayed in YYYY/MM/DD hh:mm:ss format.

-jp1 product-name

Use a character string consisting of 1,024 bytes or less to specify the new JP1 product name to be set for the target Item. For product-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-jobnet jobnet-name

Use a character string consisting of 1,024 bytes or less to specify the new jobnet name to be set for the target Item. For jobnet-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-job job-name

Use a character string consisting of 1,024 bytes or less to specify the new job name to be set for the target Item. For job-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-snmp SNMP-source

Use a character string consisting of 1,024 bytes or less to specify the new SNMP source name to be set for the target Item. For SNMP-source, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-node monitored-node-name

Use a character string consisting of 255 bytes or less to specify the new monitored node name to be set for the target Item. For monitored-node-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-alarm alarm-name

Use a character string consisting of 255 bytes or less to specify the new alarm name to be set for the target Item. For alarm-name, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-utextn n-pieces-of-extended-text-data (n: 1 to 20)

You can add a maximum of 20 user-customized elements of the character string type (extended text data) to an Item. Specify the new character string to be entered in the input field of each element of the target Item and enclose each character string between double quotation marks ("). The number of character strings you can specify here depends on the value of n as follows.

  • When n is from 1 to 5: Each character string must consist of 4,096 bytes or less.

  • When n is from 6 to 15: Each character string must consist of 2,048 bytes or less.

  • When n is from 16 to 20: Each character string must consist of 512 bytes or less.

For extended text data, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).

-utimen n-pieces-of-extended-time-data (n: 1 to 5)

You can add a maximum of 5 user-customized elements of the date type (extended time data) to an Item. Specify the new dates and time to be entered in the input field of each element of the target Item in YYYY/MM/DD hh:mm:ss format or YYYY/MM/DD hh:mm format. For extended time data, you can specify a date and time in the range from 1970/01/02 00:00:00 to 2036/12/31 23:59:59.

Note that even if you specify a user-customized element of the date type in YYYY/MM/DD hh:mm:ss format, it will be displayed in YYYY/MM/DD hh:mm format in the View Item window, in the Edit item window, and in Item previews in the main window. However, when you output the Item to a CSV file, the user-customized element of the date type will be displayed in YYYY/MM/DD hh:mm:ss format.

-ucoden n-pieces-of-extended-code-data (n: 1 to 5)

You can add a maximum of 5 user-customized elements of the code type (extended code data) to an Item. Specify the new contents to be entered in the input field of each element of the target Item. When you use extended code data, make sure that you create a code mapping file and define extended code data in it. Use the -m option to specify the code mapping file. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-uintn n-pieces-of-extended-numerical-data (n: 1 to 5)

You can add a maximum of 5 user-customized elements of the numeric type (extended numeric data) to an Item, by using a decimal integer in the range from 0 to 2,147,483,647.

-uurinfon n-user-types-or-role-types n-user-IDs-or-role-IDs (n: 1 to 5)

You can add a maximum of 5 user-customized elements of the user/role type to an Item. Specify the new contents to be entered in the input field of each element of the target Item. For a user type, specify USER or ROLE. User types are not case sensitive. For a user ID or a role ID, use no more than 64 half-width alphanumeric characters and underscores (_) to specify a user ID in the User management window or a role ID in the Role management window.

If view permissions are set for individual Items in the work board in which the relevant Item is registered, one of Extended user information type 01 to 05 (uurinfo1 to uurinfo5) is used to set view permissions for the Items. In this case, for n-user-types-or-role-types and n-user-IDs-or-role-IDs of the relevant Extended user information type n (uurinfon), specify the Item view permissions owner.

-m code-mapping-file-name

Use a character string consisting of 255 bytes or less to specify the name of the code mapping file when you use a user-defined code mapping file. You can use an absolute path or a relative path to specify the file name. When you use a relative path, make sure that it will have 255 bytes or less after it is converted to an absolute path. For details about code mapping files, see Code mapping file (jp1imss_itemedit_codemap.conf) in Chapter 13. Definition Files.

-f

Edits the target Item even if it is being edited by another user.

This option is valid when the user who executes this command belongs to the process work board management role or is the process work board manager.

-mail

Enables the email notification function.

You can check whether email notification is performed in the log file (jssmailnotification_infonumber.log). number is the number of the log file. For details, see User log definition file (jp1mailnotification.conf) in Chapter 13. Definition Files.

Return values

Return value

Meaning

0

Normal end

1

Abnormal end

About the automatic input function for Items

The jssitemedit command automatically updates the priority level and the deadline even if the -pr option and the -deadline option are not specified when the automatic input function for Items is enabled.

The command automatically updates the priority level when one of the following conditions is satisfied:

However, if the -pr option is specified but a value is not specified for it, the command does not automatically update the priority level even if one of the above conditions is satisfied.

The command automatically updates the deadline when either of the following conditions is satisfied:

However, if the -deadline option is specified but a value is not specified for it, the command does not automatically update the deadline even if the automatic input function for Items is enabled.

The deadline is determined by adding the work time specified for each priority level to the date and time when the target Item was registered.

Prerequisites for executing the command

Remarks

Example

The following example shows how to change the status of the Item with process work board serial number 000001 in the process work board with process work board ID HQsystem to Close.

jssitemedit -b HQsystem -pi 000001 -r user001 -cht USER -ch jp1admin -st Close