jssitementry (registers an Item)
- Organization of this page
Description
This command registers the data of a new Item in the Item management database. For the status of the Item, Received is automatically assigned.
If you do not specify any of the following data of the Item, the omitted data is not registered in the Item management database. When you reference the registered Item later, blanks are shown for the data you do not specify.
Format
jssitementry -b process-work-board-ID -t title -r registrant-ID -cht person-in-charge-type -ch person-in-charge-ID [-s severity] [-ipt impact-level] [-pr priority] [-itmc Item-type] [-isuc problem-domain] [-cus customer-name] [-reqp inquirer] [-ins impact-service] [-det overview] [-jp1 product-name] [-jobnet jobnet-name] [-job job-name] [-snmp SNMP-source] [-node monitored-node-name] [-alarm alarm-name] [-url related-information-display-name URL | -urlfile related-information-definition-file] [-evt JP1/IM - Manager-host-name serial-number] [-aim JP1/AIM-server-name-or-JP1/UCMDB-server-name-or-asset-management-server-name -cit device-type -ci server-name-1 [server-name-2 ...]] [-linkitem Item-ID-1 [Item-ID-2 ...]] [-acdate occurrence-date-and-time] [-stdate start-date-and-time] [-deadline deadline] [-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-numeric-data] [-uurinfon n-user-types-or-role-types n-user-IDs-or-role-IDs] [-ulinkn type link-details | -ulinkfilen related-information-definition-file] [-m code-mapping-file-name] [-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 process work board where you want to register the Item.
-t title
Use a character string consisting of 512 bytes or less to specify the title of the 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 (-).
-r registrant-ID
Use no more than 64 half-width alphanumeric characters to specify the ID of the user who registers the 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 type of the person who is in charge of the 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 user ID of the person in charge of the Item or the role ID of the role in charge of the Item.
-s severity
Specifies the severity level of the Item. The following table describes the specifiable values. The severity levels are not case sensitive.
Specifiable value for severity |
Description |
---|---|
Emergency |
Emergency |
Alert |
Alert |
Critical |
Critical |
Error |
Error |
Warning |
Warning |
Notice |
Notice |
Information |
Information |
Debug |
Debug |
-ipt impact-level
Specifies the impact level of the Item. The following table describes the specifiable values. The impact levels are not case sensitive.
Specifiable value for impact level |
Description |
---|---|
S |
Small |
M |
Middle |
B |
Large |
-pr priority
Specifies the priority level of the Item. The following table describes the specifiable values. The priority levels are not case sensitive.
Specifiable value for priority |
Description |
---|---|
N |
Standard |
M |
Urgent |
H |
Very urgent |
If the automatic input function for Items is enabled for the process work board and you omit the -pr option, the value specified in the property file for automatic Item-defaults input for the commands is set. For details about the property file for automatic Item-defaults input for the jssitemedit command and the jssitementry command, see Property file for automatic Item-defaults input (jp1imss_itementry_default.conf) in Chapter 13. Definition Files.
-itmc Item-type
Specifies the Item type of the Item. The following table describes the specifiable values. The Item types are not case sensitive.
Specifiable value for Item type |
Description |
---|---|
QUE |
Inquiry |
FAL |
Failure |
CR |
Customer request |
-isuc problem-domain
Specifies the problem domain of the Item. The following table describes the specifiable values. The problem domains are not case sensitive.
Specifiable value for problem domain |
Description |
---|---|
APP |
Application |
MID |
Middleware |
OS |
OS |
HRD |
Hardware |
NET |
Network |
PRO |
Process |
-cus customer-name
Use a character string consisting of 1,024 bytes or less to specify the customer name for the 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 inquirer for the 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 (-).
-ins impact-service
Use a character string consisting of 255 bytes or less to specify the impact-service for the 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 (-).
You can use the Configuration file for character string substitution to replace a specific character string with a linefeed character before you register an Item. For details about the Configuration file for character string substitution, see Configuration file for character string substitution (jp1imss_replace_string_setting.conf) in Chapter 13. Definition Files.
-det overview
Use a character string consisting of 2,048 bytes or less to specify the overview of the 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 (-).
You can use the Configuration file for character string substitution to replace a specific character string with a linefeed character before you register an Item. For details about the Configuration file for character string substitution, see Configuration file for character string substitution (jp1imss_replace_string_setting.conf) in Chapter 13. Definition Files.
-jp1 product-name
Use a character string consisting of 1,024 bytes or less to specify the JP1 product name for the 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 jobnet name for the 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 job name for the 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 SNMP source name for the 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 monitored node name for the 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 alarm name for the 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 (-).
-url related-information-display-name URL
Specifies the display name of element Related information and the URL of the location that displays the related information for the Item. For related-information-display-name, use a character string consisting of 255 bytes or less. For URL, use a character string consisting of 2,048 bytes or less. For related-information-display-name and URL, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).
-evt JP1/IM - Manager-host-name serial-number
Specify the name of the JP1/IM - Manager host that registered the JP1 event that you want to register as an Item. Also, use a decimal number in the range from 0 to 2,147,483,647 to specify the serial number of the JP1 event.
-urlfile related-information-definition-file
Specify this option when you want to register multiple items of related information to "Related information (JIMSD_FORM_LINKURL)". The following table describes how to specify the path of a related-information definition file.
Method for specifying the path of a related-information definition file |
Either a relative path or an absolute path can be used. |
---|---|
Character string that can be specified for a path |
Use a character string that can be specified for a file name or a directory name. |
Length of character string that can be specified |
The character string must be 255 bytes or less. Count halfwidth characters as 1 byte each and fullwidth characters as 2 bytes each. If you specify a relative path, check the length of the character string after the path is converted to an absolute path. |
For details about related-information definition files, see Related-information definition file in Chapter 13. Definition files.
-aim JP1/AIM-server-name-or-JP1/UCMDB-server-name-or-asset-management-server-name
Specify the name of the JP1/AIM, JP1/UCMDB, or asset management server (JP1/ITDM2 - Asset Console) and the port number to set a link to device information related to the Item. To do so, use a character string consisting of 255 bytes or less. For JP1/AIM-server-name-or-JP1/UCMDB-server-name-or-asset-management-server-name, you can use half-width alphanumeric characters, periods (.), colons (:), and hyphens (-). However, you cannot specify a character string beginning with a hyphen (-).
-cit device-type
Specifies the device type for the Item's element Hardware information. This argument is mandatory when you specify the -aim option. The device types are not case sensitive.
Specifiable value for device type |
Meaning |
---|---|
HOST |
Host (JP1/AIM or JP1/ITDM2 - Asset Console) |
IP |
IP address (JP1/AIM or JP1/ITDM2 - Asset Console) |
ASSETID |
Asset ID (JP1/AIM or JP1/ITDM2 - Asset Console) |
UCMDBHOST |
Host (JP1/UCMDB) |
UCMDBIP |
IP address (JP1/UCMDB) |
UCMDBID |
JP1/UCMDB ID |
-ci server-name-1 [server-name-2 ...]
Specifies the name of the server indicated by the Item's element Hardware information. You can specify a maximum of 10 server names. Use a character string consisting of 255 bytes or less to specify each server name. The -ci option must always come after the -cit option. The server name depends on the value specified for the -cit option that comes immediately before the -ci option (middleware, IP address, or asset ID). For server-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 (-).
-linkitem Item-ID-1 [Item-ID-2 ...]
Specifies the IDs of the related Items to be linked to the Item. Use a character string consisting of 128 bytes or less to specify each Item ID. You can specify a maximum of 10 related Item IDs.
-acdate occurrence-date-and-time
Specifies the date and time when the Item occurred 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. If the automatic input function for Items is enabled for the process work board, omitting the -acdate option sets the time when the jssitementry command is executed. If the automatic input function for Items is disabled and you omit the -acdate option, the occurrence date and time are not set. If you do not want to specify the occurrence date and time at all, specify the -acdate option and omit its value.
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 date and time when the Item started 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. If the automatic input function for Items is enabled for the process work board, omitting the -stdate option sets the time when the jssitementry command is executed. If the automatic input function for Items is disabled and you omit the -stdate option, the start date and time are not set. If you do not want to specify the start date and time at all, specify the -stdate option and omit its value.
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 deadline for the 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. If the automatic input function for Items is enabled for the process work board, omitting the -deadline option sets the time when the jssitementry command is executed plus a certain length of time. The length of time to be added depends on the priority level. The length of time to be added also changes depending on whether you select the Use the settings in the Property file for automatic Item-defaults input check box in the Settings - Automatic item input tab in the New process work board window.
-
When you select the Use the settings in the Property file for automatic Item-defaults input check box
The length of time specified in the property file for automatic Item-defaults input (jp1imss_itementry_default.conf) is added.
-
When you clear the Use the settings in the Property file for automatic Item-defaults input check box
The length of time you specify in the New process work board window or the Edit the process work board window is added.
If you omit the -deadline option when the Use the settings in the Property file for automatic Item-defaults input check box is cleared, no deadline is set for the Item. If you do not want to specify a deadline at all, specify the -deadline option and omit its value.
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.
-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 character string to be entered in the input field of each element 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 dates and time to be entered in the input field of each element 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 contents to be entered in the input field of each element. 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_itementry_codemap.conf) in Chapter 13. Definition Files.
-uintn n-pieces-of-extended-numeric-data (n: 1 to 5)
You can add a maximum of 5 user-customized elements with a numeric value (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 contents to be entered in the input field of each element. For a user type, specify USER or ROLE. User types are not case sensitive. For a user ID or a role ID, specify a user ID in the User management window or a role ID in the Role management window using no more than 64 half-width alphanumeric characters and underscores (_).
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.
-ulinkn type link-details (n: 1 to 5)
You can specify a maximum of 5 groups of details about links that are related to the Item. The information you can specify for link-details differs depending on the value you specify for type. You can specify the following information for link-details:
-
Connection destination server name: Use a character string consisting of 255 bytes or less to specify the name of the JP1/AIM, JP1/UCMDB, or asset management server (JP1/ITDM2 - Asset Console) and the port number.
-
Server name: You can specify a maximum of 10 servers. Use a character string consisting of 255 bytes or less to specify each server name.
-
Item ID: You can specify a maximum of 10 Item IDs. Use a character string consisting of 255 bytes or less to specify each Item ID.
Specification example of link-details when type is aim
connection-destination-server-name -lcitn CI-type -lcin server-name-1 [server-name-2 ...]
-
For connection-destination-server-name, specify the name of the JP1/AIM, JP1/UCMDB, or asset management server (JP1/ITDM2 - Asset Console) to configure a link to the CI information related to the Item.
-
n in -lcitn and -lcin must match n in -ulinkn.
-
For CI-type, specify the value defined in the relevant code mapping file. The CI type is not case sensitive.
-
For server-name, you can specify a maximum of 10 names of servers that contain the CI information related to the Item. The value you can specify for server-name differs depending on the value specified in the -cit option that is specified immediately before (host, IP address, or asset ID). For server-name, you can you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).
Specification example of link-details when type is linkitem
Item-ID-1 [Item-ID-2 ...]
You can specify a maximum of 10 IDs of Items that are related to the Item. Use a character string consisting of 128 bytes or less to specify each Item ID.
Specification example of link-details when type is url
display-name URL
Specify the display name of element Related information and the URL of the location that displays the related information. For display-name, use a character string consisting of 255 bytes or less. For URL, use a character string consisting of 2,048 bytes or less. For display-name and URL, you can use any characters except for control characters (0x00 to 0x1F, 0x7F). However, you cannot specify a character string beginning with a hyphen (-).
-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_itementry_codemap.conf) in Chapter 13. Definition Files.
-ulinkfilen related-information-definition-file (n: 1 to 5)
Specify this option when you want to register multiple items of related information to "Extended link (JIMSD_FORM_REFINFO01 to JIMSD_FORM_REFINFO05)". The following table describes how to specify a path of a related-information definition file.
Method for specifying the path of a related-information definition file |
Either a relative path or an absolute path can be used. |
---|---|
Character string that can be specified for a path |
Use a character string that can be specified for a file name or a directory name. |
Length of character string that can be specified |
The character string must be 255 bytes or less. Count halfwidth characters as 1 byte each and fullwidth characters as 2 bytes each. If you specify a relative path, check the length of the character string after the path is converted to an absolute path. |
For details about related-information definition files, see Related-information definition file in Chapter 13. Definition files.
Enables the email notification function.
You can check whether email notification is performed in the log file (jssmailnotification_infonumber.log). number indicates 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 |
Prerequisites for executing the command
-
For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 12. Commands.
-
You can execute a maximum of 5 jssitementry commands at a time. If you execute 6 or more commands, the commands might fail.
-
While the jssitementry command is being executed, do not execute other JP1/Service Support commands. If you do, the jssitementry command might fail.
-
When you execute the jssitementry command, if any of the entered character strings exceeds the length that can be recognized by Command Prompt, the Item cannot be registered. Make sure that the character strings do not exceed the recognizable length.
-
For the options of the jssitementry command, specify only the elements that appear in the windows. Although all the elements that you specify in the options are registered in the Item management database, you cannot check them unless they appear in the windows.
-
When you use extended code data, make sure that you create a mapping file.
-
The special characters of Command Prompt must be preceded by an escape character at entry. For example, if you want to include a double quotation mark (") in an argument that is enclosed between double quotation marks, an escape character, \, must precede that double quotation mark (\").
However, when you link JP1/Service Support with JP1/IM - Manager, the JP1/IM - Manager's function for converting event transfer information can automatically insert the escape character before any special characters in Command Prompt. For details about the JP1/IM - Manager's function for converting event transfer information, see J P1 Version 11 JP1/Integrated Management - Manager Overview and System Design Guide.
Remarks
-
If you cancel the jssitementry command while it is being executed, Item data will not be registered.
-
If you cancel the jssitementry command by using Ctrl+C while the command is being executed, Item data might not be registered. For this reason, do not cancel the command during execution by using Ctrl+C. If you happen to do so, wait for a while and then re-execute the command.
-
You can output the results of executing the jssitementry command to a log file and check the results. For details, see User log definition file (jp1itementry.conf) in Chapter 13. Definition Files.
-
When you use the jssitementry command, you can register an Item without specifying the mandatory elements that you must enter when you register the Item or when the status of the Item is Close.
-
If the character string specified with the -m option contains full-width characters, the full-width characters are converted to 2-byte characters. If other options can have full-width characters, the full-width characters are converted to 3-byte characters or 4-byte characters.
-
Tab characters are control characters. For this reason, do not specify tab characters in arguments that cannot take control characters (0x00 to 0x1F, 0x7F). When you link JP1/Service Support with JP1/IM - Manager, JP1/IM - Manager's function for converting event transfer information when you register Items can convert tab characters to spaces. For details about JP1/IM - Manager's function for converting event transfer information, see JP1 Version 11 JP1/Integrated Management - Manager Overview and System Design Guide.
-
If you use the Configuration file for character string substitutiononfiguration file for character string substitution to replace the character strings in textarea-type elements of Items with linefeed characters, do not insert linefeed characters into the values of element IDs JIMSD_FORM_USERTEXT01 to JIMSD_FORM_USERTEXT20 in Item forms. If you do so and then execute the jssitementry command, the operation is not guaranteed. For details about the Configuration file for character string substitution, see Configuration file for character string substitution (jp1imss_replace_string_setting.conf) in Chapter 13. Definition Files.
-
When view permissions are set for individual Items in the work board in which a relevant Item is registered, if you register the Item without specifying the Item view permissions owner for the -uurinfon option, users other than the process work board manager will not be able to view the Item. In such a case, the process work board manager must set view permissions for individual Items using either of the following ways:
-
Specify the Item view permissions owner for the -uurinfon option, and then execute the jssitemedit command. For details about the jssitemedit command, see jssitemedit (edits an Item) in Chapter 12. Commands.
-
In the Edit item window, set the Item view permissions owner.
-
Example
The following example shows how to register the data of an Item titled Excessive server access.
jssitementry -b HQsystem -t Excessive server access -r user0001 -cht user -ch user0002 -s Warning -ipt S -pr N -itmc FAL -isuc APP -cus ABC Corporation -reqp Jane Smith -ins impact-service -jp1 /HITACHI/JP1/CentralConsole -jobnet net1 -job Calculation-1 -snmp XXXX -node Monitored node -alarm alarm01 -url Related information http://www.xxxx.html -aim server01 -cit HOST -ci server10 server11 -m jp1imss_itementry_codemap.conf