jssitemimportEx (imports extended Item information)
- Organization of this page
Description
This command registers new Item information in the Item management database of JP1/Service Support. The command can also register the Item information that you output to CSV files by using the jssitemexportEx command in the JP1/Service Support database.
When you execute the jssitemimportEx command, the command checks whether the contents of all the extended Item information entries files in the specified input source folder are correct. If the contents of the files are correct, the command starts registering the Item information in the Item management database. If any of the extended Item information entries files contains improper data, the command does not register the Item information in the files.
Format
jssitemimportEX -i input-source-folder-name {-ALL | -s -id system-ID | -p -id process-work-board-ID} [-latest]
Required execution permission
Administrator permissions
Storage folder
JP1/SS-path\bin\
Arguments
-i input-source-folder-name
Use a character string consisting of 80 bytes or less to specify the name of the folder containing extended Item information entries files. Count half-width characters as 1-byte each and full-width characters as2-bytes each. You can use an absolute path or a relative path to specify the folder name. When you use a relative path, make sure that it will be 80 bytes or less after it is converted to an absolute path. Note that UNC paths cannot be specified.
The input source folder must have the same configuration as the output destination folder specified for the jssitemexportEx command. Also, make sure that the format of the file used as the input source of Item information (Item information CSV file, related information CSV file, or attached file#) is the same as described in the section of the jssitemexportEx command. You need to observe the file naming conventions for Item information CSV files and related information CSV files.
- #
-
A file of extended Item information entries is a generic term for Item information CSV files, related information CSV files, and attached files.
For details about the format of the input source files and the configuration of the folder to which the jssitemexportEx command outputs the files, see jssitemexportEx (exports extended Item information) in Chapter 12. Commands. For further details about the format of Item information CSV files, related information CSV files and attached files, and naming conventions for the files, see File for extended Item information entries (Optional) in Chapter 13. Definition Files.
-ALL
Registers the Item information in all systems including the master system.
-s id system-ID
Registers the Item information in a selected system. For system-ID, use 1 to 64 half-width alphanumeric characters.
-p -id process-work-board-ID
Registers the Item information in a selected process work board. For process-work-board-ID, use 1 to 64 half-width alphanumeric characters.
-latest
Registers only the latest Item information (the data type is Most recent) specified by the -i option. The command does not register the information about escalation when the -latest option is specified.
Return values
Return value |
Meaning |
---|---|
0 |
Normal end |
1 |
The command failed while registering Item information. |
2 |
The command failed before registering Item information. |
Body items in an Item information CSV file
Some items in the body section of an Item information CSV file are mandatory. For details about the list and descriptions of items in an Item information CSV file, see File for extended Item information entries (Optional) in Chapter 13. Definition Files.
When you create an Item information CSV file (from which you can register Item information into the Item management database), you can omit the header section, the first line (attribute name) in the body section, and the footer section.
Body items in a related information CSV file
All the items in the body section of a related information CSV file are optional. The header section is also optional. For details about the list and description of items in a related information CSV file, see File for extended Item information entries (Optional) in Chapter 13. Definition Files.
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.
-
The jssitemimportEx command ends abnormally depending on the status of the specified system or process work board. The following table describes the differences in the result of the command depending on the status of a system or a process work board.
No.
System status
Process work board status
Result of the command
1
Waiting to be deleted
Not applicable
The command ends abnormally (unallowed status).
2
Operating
In process
The command ends abnormally (unallowed status).
3
Operating
The command ends normally.
4
Ended
The command ends abnormally (unallowed status).
5
Waiting to be deleted
The command ends abnormally (unallowed status).
-
Note that the jssitemimportEx command can only register the Item information in extended Item information entries files into the Item management database. You need to register the information about process work boards, Item forms, and information about users separately. For details, see step 4 in 11.2.8(1) Reregistering Item information.
-
When you use the jssitemimportEx command to register large quantities of Item information, the command might end abnormally due to insufficient free space in the Item management database. For this reason, before you execute the jssitemimportEx command, execute the jssbackup command or the jssitemexportEx command to save Item information just in case.
Remarks
-
When you use the jssitemimportEx command to register large quantities of Item information at a time, the command runs over a long period of time, causing a great load on the Item management server and JP1/Service Support. We recommend that you execute the jssitemimportEx command when the load on the Item management server and JP1/Service Support is low, for example, at midnight.
-
If you cancel the jssitemimportEx command while it is being executed, all the Item information in the files in the specified input source folder is not registered in the Item management database.
-
If you cancel the jssitemimportEx command by using Ctrl+C while the command is being executed, the Item information in the files in the specified input source folder might not be registered in the Item management database. For this reason, do not cancel the command during execution by using Ctrl+C.
-
If the specified input source folder contains unnecessary folders or files, unintended data might be registered in the Item management database or an error might occur.
-
Do not manipulate the folders and files under the specified input source folder while executing the jssitemimportEx command. If you do, the command will end abnormally. Also, do not execute the jssitemexportEx command with an input source folder specified while you execute the jssitemimportEx command.
-
The jssitemimportEx command registers the information about existing Items in the Item management database without change. If you want to summarize the information about existing Items, execute the jsscollectdata command with the -a option.
-
If you use the jssitemexportEx command to output Item information to files (Item information CSV file, related information CSV file, and attached files) and then use the jssitemimportEx command to register it in the Item management database (regardless of whether the Item information has been edited), the size of data in the files and the size of data registered in the Item management database will differ. The size of data registered in the Item management database might be greater than the size of the data in the files. For this reason, delete unnecessary Items from the Item management database and then execute the jssitemimportEx command.
-
When the name of an attached file (excluding the attached file ID) stored in a process-work-board-serial-number folder differs from the value specified for an Attached file in the Item information CSV file, the jssitemimportEx command registers the attached file into the Item management database using the Attached file name in the Item information CSV file.
-
You can use the following commands to register and edit the elements of Items that do not exist in Item forms. However, if you use the jssitemimportEx command to register an Item that has elements not existing in an Item form, an error will occur.
-
jssitementry command (registers an Item)
-
jssitemedit command (edits an Item)
-
jssitemimport command (imports Item information)
If an error occurs, perform either of the following procedures and re-execute the jssitemimportEx command.
-
Add new elements to the target Item form, register the Item form in the Item management database, and change the version number of Item form specified in the Item information CSV file to the version number of the modified Item form in the Item management database.
-
Delete the body items in the Item information CSV file that do not exist in the Item form.
-
-
Make sure that the input file you specify is created with a character encoding that is compatible with the system locale of the machine on which JP1/Service Support is installed. The character encodings that can be used are as follows:
-
In a Japanese environment: MS932
-
In an English environment: ISO-8859-1
-
In a Chinese environment: GB18030
-
Example
The following example shows how to register the Item information from all systems in C:\tmp in the Item management database. The Item information (from all systems) was previously output to C:\tmp by using the jssitemexportEx command.
jssitemimportEx -i c:\tmp -all