jssitemexportEx (exports extended Item information)
- Organization of this page
-
Description
This command outputs the Item information and history information that is registered in JP1/IM - Service Support to CSV files. When files are attached to an Item, the command also outputs the attached files. If you cancel the command during execution, the command outputs the Item information up to that point to CSV files. This command includes the jssitemlist (outputs a list of Items) and jssitemhistory (outputs Item history) command functions.
Format
jssitemexportEx -o output-destination-folder-name
{-ALL | -s -id system-ID | -p -id process-work-board-ID
[-pi process-work-board-serial-number]}
{-ct start-date-end-date | -et start-date-end-date}
[-a]
[-f]
[-m CSV-column-name-mapping-file-name]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\bin\
Arguments
-o output-destination-folder-name
For output-destination-folder-name, use 80 bytes or less to specify the name of the folder to which Item information is to be output. Count half-width characters as 1-byte each and full-width characters as 2-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 is 80 bytes or less after it is converted to an absolute path. If the specified folder name does not exist, the system creates a folder with the specified name.
Mainly, the following files are created or output to the specified output destination folder:
-
Item_PWB_process-work-board-ID.csv
A CSV file to which Item information is output (Item information CSV file).
Each file contains Item information including update information for each process work board. A file is created even if no Items exist in the corresponding process work board. Note that a file is created for each process work board even if you specify a system ID in the -s -id option.
-
ItemRefInfo_PWB_process-work-board-ID.csv
A CSV file to which related information is output (related information CSV file).
Each file contains related information for a process work board. A file is created even if no Items exist in the corresponding process work board. Note that a file is created for each process work board even if you specify a system ID in the -s -id option.
-
Attached files
Files attached to an Item.
Attached files are output to a folder for each process work board serial number in a process work board.
An attached file ID is appended to the beginning of each attached file name. An Item information CSV file contains the IDs and names of the attached files that are output under the output destination folder. You can use attached file IDs to identify attached files. Attached files are output to a folder whose name is a process work board serial number. If the name of the folder containing attached files is too short (if the process work board serial number is less than 5 digits), the name is padded with zeros.
The following figure shows an example configuration for Item information CSV files, related information CSV files, and attached files.
Specified output destination folder
|- system01 system-ID
| |- Item_PWB_pwb001.csv Item information CSV file
| |- ItemRefInfo_PWB_pwb001.csv Related information CSV file
| |- pwb001 process-work-board-ID
| |- 00001 process-work-board-serial-number
| |- 00001_AttachedFile01.txt Attached file 1
| |- 00002_AttachedFile02.txt Attached file 2
| |- 00003_AttachedFile03.txt Attached file 3
|- system02 system-ID
| |- Item_PWB_pwb002.csv
| |- ItemRefInfo_PWB_pwb002.csv
:
:-ALL
Outputs the Item information in all systems including the master system.
-s id system-ID
Outputs the Item information in a selected system. For system-ID, use 1 to 64 half-width alphanumeric characters.
-p -id process-work-board-ID
Outputs the Item information in a selected process work board. For process-work-board-ID, use 1 to 64 half-width alphanumeric characters.
-pi process-work-board-serial-number
Outputs the Item information of an Item in the selected process work board. For details about process work board serial numbers, see 3.2.2(1) List of Items.
-ct start-date-end-date
Specifies a period in YYYY/MM/DD format to output the information about the Items created in that period. Insert a hyphen (-) between the start date and the end date.
For start-date and end-date, you can specify dates in the range from 1970/01/01 to 2107/01/01. For start-date, specify a date earlier than end-date.
The start date and the end date are defined as follows.
- start-date
-
Outputs the information about the Items that were created on and after this date. If you specify a non-existent date within the specifiable range, an error occurs.
- end-date
-
Outputs the information about the Items that were created on and before this date. If you specify a non-existent date within the specifiable range, an error occurs.
For example, if you specify 2013/04/01-2013/04/07, the information about the Items that were registered between 2013/04/01 00:00:00(.000) and 2013/04/07 23:59:59(.999) is output.
-et start-date-end-date
Specifies a period in YYYY/MM/DD format to output the information about the Items updated in that period. Insert a hyphen (-) between the start date and the end date.
For start-date and end-date, you can specify dates in the range from 1970/01/01 to 2107/01/01. For start-date, specify a date earlier than end-date.
The start date and the end date are defined as follows.
- start-date
-
Outputs the information about the Items that were updated on and after this date. If you specify a non-existent date within the specifiable range, an error occurs.
- end-date
-
Outputs the information about the Items that were updated on and before this date. If you specify a non-existent date within the specifiable range, an error occurs.
For example, if you specify 2013/04/01-2013/04/07, the information about the Items that were updated between 2013/04/01 00:00:00(.000) and 2013/04/07 23:59:59(.999) is output.
-a
Outputs the information about the Items in all statuses. If you do not specify the -a option, the system outputs the information about the Items in the Close status.
-f
Overwrites the files in the output destination folder. If no files exist in the output destination folder, files are created.
-m CSV-column-name-mapping-file-name
When you use a user-defined CSV column name mapping file, use a character string consisting of 255 bytes or less to specify the name of the file. Count half-width characters as 1-byte each and full-width characters as 2-bytes each. You can use an absolute path or a relative path to specify the name of a CSV column name mapping file. 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 CSV column name mapping files, see CSV column name mapping file (jp1imss_itemcsv_columnmap.conf) in Chapter 12. Definition Files.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
An incomplete CSV file is output. |
|
2 |
Abnormal end |
Contents of an Item information CSV file
An Item information CSV file contains data in the following format.
![[Figure]](GRAPHICS/ZU110520.GIF)
The first line in the body section in an Item information CSV file lists the names of the Items' attributes.
The details about the contents of an Item information CSV file are as follows.
- Header section
-
Output sequence
Header item
Value
1
Product name
JP1/IM - Service Support
2
Version number of the Item information CSV file
The version number of the file is indicated by 6 digits.
3
Character encoding used in the Item information CSV file
Character encoding of output files.
4
Type of data that is output to the Item information CSV file
ITEMEXPORTEX_ITEM
- Body section
-
Output sequence
Body item#1
Description
Corresponding Item form element ID
1
System ID of target system
ID of the system containing the Item
--
2
System name of target system
Name of the system containing the Item
JIMSD_FORM_SYSTEM
3
Process name
Name of the process for the process work board containing the Item
JIMSD_FORM_PROCESS
4
Process work board ID
ID of the process work board containing the Item
JIMSD_FORM_ITEMID#2
5
Process work board serial number
Process work board serial number of the Item
6
Version number
Number that indicates the version of the Item
--
7
Related item serial number
Related Item serial number of the Item
JIMSD_FORM_PROCESSITEMID#2
8
Escalation number
Number of escalations for the Item
9
Item form ID
ID of the Item form used for the Item
--
10
Version number of Item form
Number that indicates the version of the Item form used for the Item
--
11
Item status ID
ID of the status of the Item
--
12
Item status name
Name of the status of the Item
JIMSD_FORM_ITEMSTATUSID
13
Edit status
Indicates whether the Item is being edited by another user when the jssitemexportEx command is executed.
--
14
Data type
Indicates the Item status.
--
15
Escalation source process work board ID
ID of the escalation source process work board if the Item was escalated
--
16
Escalation source related Item serial number
Related Item serial number of the escalation source Item if the Item was escalated
--
17
Escalation source escalation number
Escalation number of the immediately previous escalation source Item if the Item was escalated
--
18
Escalation destination related Item serial number
Related Item serial number of the escalation destination Item if the Item was escalated
--
19
Escalation destination escalation number
Escalation number of the escalation destination Item if the Item was escalated
--
20
Escalation destination process work board ID
ID of the process work board containing the escalation destination Item if the Item was escalated
--
21
Escalation destination system ID
ID of the system containing the escalation destination Item if the Item was escalated
--
22
Escalation system name
Name of the system containing the escalation destination Item if the Item was escalated
--
23
Escalation process name
Name of the process for the process work board containing the escalation destination Item if the Item was escalated
--
24
Link source event database serial number
JP1 event database serial number of the JP1 event that was automatically registered as the Item
JIMSD_FORM_IMEVENTNO
25
JP1/IM - Manager host name
Name of the host running JP1/IM - Manager that automatically registered a JP1 event as the Item
JIMSD_FORM_IMHOSTNAME
26
Severity
Severity level of the Item
JIMSD_FORM_SEVERITYCODE
27
Impact level
Impact level of the Item
JIMSD_FORM_IMPACTCODE
28
Priority
Priority level of the Item
JIMSD_FORM_PRIORITYCODE
29
Item type
Type of the Item
JIMSD_FORM_ITEMCATEGORYCODE
30
Problem domain
Domain of problem addressed by the Item
JIMSD_FORM_ISSUECATEGORYCODE
31
Occurred type
Phenomenon type of the Item
JIMSD_FORM_PHENOMENONCODE
32
Cause
Cause of the Item
JIMSD_FORM_CAUSECODE
33
Result
Result of the Item
JIMSD_FORM_RESULTCODE
34
Solution category code
Category code of solution for the Item
JIMSD_FORM_SOLUTIONCODE
35
Workaround type
Type of workaround for the Item
JIMSD_FORM_AVOIDANCECODE
36
Scale of change
Scale of change required by the Item
JIMSD_FORM_CHANGESCALECODE
37
Release type
Type of release for the Item
JIMSD_FORM_RELEASETYPECODE
38
Occurrence date and time
Occurrence date and time of the Item
JIMSD_FORM_ACCRUALDATE
39
Deadline
Deadline of the Item
JIMSD_FORM_DEADLINE
40
Start date and time
Start date and time of the Item
JIMSD_FORM_STARTDATE
41
End date and time
End date and time of the Item
JIMSD_FORM_COMPDATE
42
Title
Title of the Item
JIMSD_FORM_TITLE
43
Overview
Overview of the Item
JIMSD_FORM_SUMMARY
44
Impact service
Work affected by the Item
JIMSD_FORM_EFFECTSERVICE
45
Reason for severity
Reason for setting the severity level for the Item
JIMSD_FORM_SEVERITYREASON
46
Reason for impact level
Reason for setting the impact level for the Item
JIMSD_FORM_IMPACTREASON
47
Reason for priority
Reason for setting the priority level for the Item
JIMSD_FORM_PRIORITYREASON
48
Workaround
Workaround for the Item
JIMSD_FORM_AVOIDANCE
49
Work status
Work status of the Item
JIMSD_FORM_SITUATION
50
Fundamental cause
Fundamental cause of the Item
JIMSD_FORM_ROOTCAUSE
51
Solution
Solution for the Item
JIMSD_FORM_SOLUTION
52
Problem location and version
Problem component and version for the Item
JIMSD_FORM_FAILURELOCATION
53
Schedule and main steps
Schedule and main steps for the Item
JIMSD_FORM_SCHEDULE
54
Impact assessment for change
Impact assessment for change
JIMSD_FORM_IMPACTEVAL
55
Discussions result
Result of discussions for the Item
JIMSD_FORM_DELIBERATIONRST
56
How to avoid the problem in the future
Thought for preventing reoccurrence of the problem
JIMSD_FORM_MEASURES
57
Free memo column
Free memo
JIMSD_FORM_FREEDESCRIPTION
58
Product name
Name of the product that issued a JP1 event
JIMSD_FORM_JP1PRODUCTNAME
59
Jobnet name
JP1/AJS jobnet name
JIMSD_FORM_JP1JOBNETNAME
60
Job name
JP1/AJS job name
JIMSD_FORM_JP1JOBNAME
61
SNMP source
Name of the source of SNMP traps that are converted to JP1 events by using the SNMP trap conversion function of JP1/Base
JIMSD_FORM_JP1SNMPSRC
62
Monitored node name
Name of the monitored node that is defined by using the integrated scope function of JP1/IM - Manager
JIMSD_FORM_JP1NODENAME
63
Alarm name
Alarm name in the JP1 event issued by JP1/PFM Web Console
JIMSD_FORM_JP1ALARMNAME
64
Customer name
Customer name
JIMSD_FORM_CUSTOMERNAME
65
Cost (planned)
Cost (planned)
JIMSD_FORM_ESTIMATEDCOST
66
Cost (actual)
Cost (actual)
JIMSD_FORM_ACTUALCOST
67
Inquirer's name
Inquirer name
JIMSD_FORM_INQUIRYNAME
68
Registrant ID
ID of the user who registered the Item
--
69
Registrant's name
Name of the user who registered the Item
JIMSD_FORM_REGISTRANT
70
Registrant's name (English)
Name of the user who registered the Item (English)
--
71
Person in charge type
Type of the person in charge of the Item (user or role)
--
72
Person in charge ID
User ID of the person in charge of the Item
--
73
Name of person in charge
Name of the person in charge of the Item
JIMSD_FORM_ASSIGNED
74
Name of person in charge (English)
Name of the person in charge of the Item (English)
--
75
Answerer type
Type of the person in charge of responding to the Item (user or role)
--
76
Answerer ID
User ID of the person in charge of responding to the Item
--
77
Respondent's name
Name of the person in charge of responding to the Item
JIMSD_FORM_RESPONDENT
78
Respondent's name (English)
Name of the person in charge of responding to the Item (English)
--
79
Extended text 1
Additional text data (1 to 20) defined by a user in an Item form
JIMSD_FORM_USERTEXT01 to JIMSD_FORM_USERTEXT20
80
Extended text 2
81
Extended text 3
82
Extended text 4
83
Extended text 5
84
Extended text 6
85
Extended text 7
86
Extended text 8
87
Extended text 9
88
Extended text 10
89
Extended text 11
90
Extended text 12
91
Extended text 13
92
Extended text 14
93
Extended text 15
94
Extended text 16
95
Extended text 17
96
Extended text 18
97
Extended text 19
98
Extended text 20
99
Extended time 1
Additional time data (1 to 5) defined by a user in an Item form
JIMSD_FORM_USERTIME01 to JIMSD_FORM_USERTIME05
100
Extended time 2
101
Extended time 3
102
Extended time 4
103
Extended time 5
104
Extended code 1
Additional code data (1 to 5) defined by a user in an Item form
JIMSD_FORM_USERCODE01 to JIMSD_FORM_USERCODE05
105
Extended code 2
106
Extended code 3
107
Extended code 4
108
Extended code 5
109
Extended numerical data 1
Additional numeric data (1 to 5) defined by a user in an Item form
JIMSD_FORM_USERINT01 to JIMSD_FORM_USERINT05
110
Extended numerical data 2
111
Extended numerical data 3
112
Extended numerical data 4
113
Extended numerical data 5
114
Extended user information type 1
Additional user data (1 to 5) defined by a user in an Item form
- Extended user information (type):
-
User type (user or role)
- Extended user information (ID):
-
User ID
- Extended user name:
-
User name
JIMSD_FORM_USEREXTTYPE01 to JIMSD_FORM_USEREXTTYPE05
115
Extended user information 1
116
Extended user name 1
117
Extended user information type 2
118
Extended user information 2
119
Extended user name 2
120
Extended user information type 3
121
Extended user information 3
122
Extended user name 3
123
Extended user information type 4
124
Extended user information 4
125
Extended user name 4
126
Extended user information type 5
127
Extended user information 5
128
Extended user name 5
129
Editor ID
ID of the user who created or updated the Item
--
130
Editor's name
Name of the user who created or updated the Item
--
131
Editor's name (English)
Name of the user who created or updated the Item (English)
--
132
Registration date and time
Date and time when the Item was registered
JIMSD_FORM_REGISTDATE
133
Update date and time
Date and time when the Item was updated last
JIMSD_FORM_LASTUPDATE
134
Message ID
A message ID is assigned to an Item that is registered by using the jssitementrybymail command (to prevent registering the same Item more than once).
--
135
Related information ID
ID of the related information for the Item
--
136
Attached file ID
ID of an attached file
--
137
Attached file(s)
Name of an attached file
JIMSD_FORM_ATTACHED
- Legend:
-
--: Not applicable.
- #1
-
When Item data contains a linefeed character, the linefeed character is converted to the value specified for hptl_jp1_imss_replace_linefeed_string in the configuration file for CSV. For details about the configuration file for CSV, see Configuration file for CSV (hptl_jp1_imss_csv_setting.properties) in Chapter 12. Definition Files.
- #2
-
Consists of 2 element IDs in an Item form. The following figure describes the details.
![[Figure]](GRAPHICS/ZU110530.GIF)
- Footer section
-
Output sequence
Footer item
Value
1
Number of Items in Close status
Closed Item Number : number-of-Items#
2
Number of Items in statuses other than Close
Unclosed Item Number : number-of-Items#
- #
-
Total number of Items for which the data type is Most recent
Contents of a related information CSV file
A related information CSV file contains data in the following format.
![[Figure]](GRAPHICS/ZU110540.GIF)
The first line in the body section in a related information CSV file lists the names of the attributes.
The details about the contents of a related information CSV file are as follows.
- Header section
-
Output sequence
Header item
Value
1
Product name
JP1/IM - Service Support
2
Version number of the related information CSV file
The version number of the file is indicated by 6 digits.
3
Character encoding used in the related information CSV file
Character encoding of output files.
4
Type of data that is output to the related information CSV file
ITEMEXPORTEX_ITEMREF
- Body section
-
Output sequence
Body item#
Description
1
Process work board ID
ID of the process work board containing the relation source
2
Process work board serial number
Process work board serial number of the relation source
3
Version number
Version number of the relation source
4
Related information ID
ID of the related information
5
Item form part ID
ID of an element in an Item form
6
Related information type
Type of the related information
7
Related information details
Details of the related information
8
Related information 1
Value registered as related information
9
Related information 2
Value registered as related information
- #
-
When Item data contains a linefeed character, the linefeed character is converted to the value specified for hptl_jp1_imss_replace_linefeed_string in the configuration file for CSV. For details about the configuration file for CSV, see Configuration file for CSV (hptl_jp1_imss_csv_setting.properties) in Chapter 12. Definition Files.
Contents of an attached file
The files attached to an Item are output without change.
If the path for an attached file exceeds 255 bytes, the file name is changed as follows.
-
The extension is removed.
-
The characters in the file name are deleted one by one from the end until the path for the file equals 255 bytes.
Half-width characters are calculated as 1-byte characters and full-width characters are calculated as 2-byte characters.
Differences in the result of the command depending on the statuses of the system and process work board
The jssitemexportEx command operates differently depending on the status of the system and of the selected process work board. The following table describes the differences in the result of the jssitemexportEx command depending on the statuses of the system and of the selected process work board.
|
No. |
System status |
Process work board status |
Result |
|---|---|---|---|
|
1 |
Waiting to be deleted |
-- |
The command does not output the Items in the system. |
|
2 |
Operating |
In process |
The command does not output the Items in the process work board. |
|
3 |
Operating |
The command outputs the Items in the process work board. However, the command does not output the Items in the Waiting to be deleted status.#1 |
|
|
4 |
Ended |
||
|
5 |
Waiting to be deleted |
The command does not output the Items in the process work board. |
- Legend:
-
--: Not applicable.
- #
-
If a process work board is in the operating status, you can manipulate the Items in it while the jssitemexportEx command is being executed. For this reason, we recommend that you execute the jssitemexportEx command for the Items in the Close status (processing is completed).
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 11. Commands.
Remarks
-
If you cancel the jssitemexportEx command by using Ctrl+C while the command is being executed, Item information might not be output. 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.
-
If the jssitemexportEx command stops due to an error while it is being executed, the contents of the output files might be incomplete.
-
If you manipulate an Item in a process work board while the jssitemexportEx command is being executed for that process work board, the information about that Item might not be output to a CSV file. For this reason, we recommend that you execute the command after you place the target process work board in the ended status.
-
Do not manipulate the folders and files under the input source folder while the jssitemexportEx command is being executed. If you do, the command will end abnormally. Also, do not execute the jssitemimportEx command with an input source folder specified while you execute the jssitemexportEx command.
Examples
- Example 1
-
If you want to save Item information in files before you delete some Items in the database to reduce the size of the database, specify the command as follows.
The following example shows how to output the information about the Items in the Close status in the process work board with ID pwb001 to CSV files. The command is applied to the Items that were updated between January 1, 2012 and January 1, 2013. The example also shows how to execute the jssitemdeletion command to place some Items in process work board pwb001 into the Waiting to be deleted status.
jssitemexportEx -o C:\export -p -id pwb001 -et 2012/01/01-2013/01/01 jssitemdeletion -p -id pwb001 -n 2012/01/01-2013/01/01
- Example 2
-
If you want to periodically save all Item information in files to create audit logs, specify the command as follows.
The following example shows how to output the information about the Items in all statuses in all systems to CSV files. The command is applied to the Items that were created between January 1, 2012 and January 1, 2013.
jssitemexportEx -o C:\export -ALL -et 2012/12/01-2013/01/01 -a
For this example, place the process work boards in the ended status before you execute the command.
- Example 3
-
If you want to stop using a process work board, specify the command as follows.
The following example shows how to output the information about all the Items in the process work board with ID pwb001, which was created on January 1, 2012 and stopped being used on January 1, 2013 to CSV files.
jssitemexportEx -o C:\export -p -id pwb001 -ct 2012/01/01-2013/01/01 -a
For this example, place the process work board in the ended status before you execute the command.