jssitemhistory (outputs Item history)

Description

This command outputs the Item history to a CSV file. Note that the command also outputs the history of the Items that were deleted from the windows and the Items that are placed in the Waiting to be deleted status by using the jssitemdeletion command. If you cancel the jssitemhistory command while it is being executed, the command outputs the history up to that point.

To Page Top

Format

jssitemhistory -o Item-history-file-name
               -r start-date-end-date
              [-b process-work-board-ID | -i related-item-serial-number]
              [-e]
              [-f]

To Page Top

Required execution permission

Administrator permissions

To Page Top

Storage folder

JP1/SS-path\bin\

To Page Top

Arguments

To Page Top

Return values

To Page Top

Contents of an Item history file

An Item history file contains data in the following format. If data is not registered for an element, two double quotation marks (") are shown for that element.

In the first line in the body section in an Item history file, fixed character strings are always shown regardless of how an Item form is customized.

The details about the contents of an Item history file are as follows.

Header section

Output sequence	Header item	Value
1	Product name	JP1/Service Support
2	Version number of the Item history file	The version number of the file is indicated by 6 digits.
3	Character encoding used in the Item history file	Character encoding of output files.
4	Type of data that is output to the Item history file	When no extended element exists ITEMHISTORY When extended elements exist ITEMHISTORYΔExtendedΔData (Note: Δ indicates a half-width space.)

Body section

Output sequence	Body item#1	Corresponding Item form element ID
1	System ID	--
2	System name	JIMSD_FORM_SYSTEM
3	Process work board ID	--
4	Process name#2	JIMSD_FORM_PROCESS
5	Related item serial number	--
6	Escalation number	--
7	Version number#3	--
8	Process work board serial number	--
9	Escalation system name	--
10	Escalation process name	--
11	Title	JIMSD_FORM_TITLE
12	Severity	JIMSD_FORM_SEVERITYCODE
13	Impact level	JIMSD_FORM_IMPACTCODE
14	Priority	JIMSD_FORM_PRIORITYCODE
15	Item type	JIMSD_FORM_ITEMCATEGORYCODE
16	Problem domain	JIMSD_FORM_ISSUECATEGORYCODE
17	Status	JIMSD_FORM_ITEMSTATUSID
18	Work status	JIMSD_FORM_SITUATION
19	Result	JIMSD_FORM_RESULTCODE
20	Update date and time	JIMSD_FORM_LASTUPDATE
21	Editor#4	--
22	Registrant	JIMSD_FORM_REGISTRANT
23	Registrant ID	--
24	Occurrence date and time	JIMSD_FORM_ACCRUALDATE
25	Registration date and time	JIMSD_FORM_REGISTDATE
26	Start date and time	JIMSD_FORM_STARTDATE
27	Person in charge type	--
28	Person in charge	JIMSD_FORM_ASSIGNED
29	Person in charge ID	--
30	Deadline	JIMSD_FORM_DEADLINE
31	Answerer type	--
32	Answerer	JIMSD_FORM_RESPONDENT
33	Answerer ID	--
34	End date and time	JIMSD_FORM_COMPDATE
35	Customer name	JIMSD_FORM_CUSTOMERNAME
36	Inquirer	JIMSD_FORM_INQUIRYNAME
37	Cost (planned)	JIMSD_FORM_ESTIMATEDCOST
38	Cost (actual)	JIMSD_FORM_ACTUALCOST
39	Impact service	JIMSD_FORM_EFFECTSERVICE
40	Overview	JIMSD_FORM_SUMMARY
41	Occurred type	JIMSD_FORM_PHENOMENONCODE
42	Cause	JIMSD_FORM_CAUSECODE
43	Fundamental cause	JIMSD_FORM_ROOTCAUSE
44	Workaround type	JIMSD_FORM_AVOIDANCECODE
45	Workaround	JIMSD_FORM_AVOIDANCE
46	Solution category	JIMSD_FORM_SOLUTIONCODE
47	Solution	JIMSD_FORM_SOLUTION
48	Problem component and version	JIMSD_FORM_FAILURELOCATION
49	How to avoid the problem in the future	JIMSD_FORM_MEASURES
50	Schedule and main steps	JIMSD_FORM_SCHEDULE
51	Impact assessment for change	JIMSD_FORM_IMPACTEVAL
52	Scale of change	JIMSD_FORM_CHANGESCALECODE
53	Release type	JIMSD_FORM_RELEASETYPECODE
54	Discussions result	JIMSD_FORM_DELIBERATIONRST
55	Free memo column	JIMSD_FORM_FREEDESCRIPTION
56	Reason for severity	JIMSD_FORM_SEVERITYREASON
57	Reason for impact level	JIMSD_FORM_IMPACTREASON
58	Reason for priority	JIMSD_FORM_PRIORITYREASON
59	Product name	JIMSD_FORM_JP1PRODUCTNAME
60	Jobnet name	JIMSD_FORM_JP1JOBNETNAME
61	Job name	JIMSD_FORM_JP1JOBNAME
62	SNMP source	JIMSD_FORM_JP1SNMPSRC
63	Monitored node name	JIMSD_FORM_JP1NODENAME
64	Alarm name	JIMSD_FORM_JP1ALARMNAME
65	Serial number	JIMSD_FORM_IMEVENTNO
66	JP1/IM-M host name	JIMSD_FORM_IMHOSTNAME
67	Hardware information	JIMSD_FORM_LINKAIM
68	Related item ID	--
69	Related information name	JIMSD_FORM_LINKURL
70	Extended text 1	JIMSD_FORM_USERTEXT01
71	Extended text 2	JIMSD_FORM_USERTEXT02
72	Extended text 3	JIMSD_FORM_USERTEXT03
73	Extended text 4	JIMSD_FORM_USERTEXT04
74	Extended text 5	JIMSD_FORM_USERTEXT05
75	Extended text 6	JIMSD_FORM_USERTEXT06
76	Extended text 7	JIMSD_FORM_USERTEXT07
77	Extended text 8	JIMSD_FORM_USERTEXT08
78	Extended text 9	JIMSD_FORM_USERTEXT09
79	Extended text 10	JIMSD_FORM_USERTEXT10
80	Extended text 11	JIMSD_FORM_USERTEXT11
81	Extended text 12	JIMSD_FORM_USERTEXT12
82	Extended text 13	JIMSD_FORM_USERTEXT13
83	Extended text 14	JIMSD_FORM_USERTEXT14
84	Extended text 15	JIMSD_FORM_USERTEXT15
85	Extended text 16	JIMSD_FORM_USERTEXT16
86	Extended text 17	JIMSD_FORM_USERTEXT17
87	Extended text 18	JIMSD_FORM_USERTEXT18
88	Extended text 19	JIMSD_FORM_USERTEXT19
89	Extended text 20	JIMSD_FORM_USERTEXT20
90	Extended time 1	JIMSD_FORM_USERTIME01
91	Extended time 2	JIMSD_FORM_USERTIME02
92	Extended time 3	JIMSD_FORM_USERTIME03
93	Extended time 4	JIMSD_FORM_USERTIME04
94	Extended time 5	JIMSD_FORM_USERTIME05
95	Extended code 1	JIMSD_FORM_USERCODE01
96	Extended code 2	JIMSD_FORM_USERCODE02
97	Extended code 3	JIMSD_FORM_USERCODE03
98	Extended code 4	JIMSD_FORM_USERCODE04
99	Extended code 5	JIMSD_FORM_USERCODE05
100	Extended numerical data 1	JIMSD_FORM_USERINT01
101	Extended numerical data 2	JIMSD_FORM_USERINT02
102	Extended numerical data 3	JIMSD_FORM_USERINT03
103	Extended numerical data 4	JIMSD_FORM_USERINT04
104	Extended numerical data 5	JIMSD_FORM_USERINT05
105	Extended user information type 1	--
106	Extended user information 1	JIMSD_FORM_USEREXTTYPE01
107	Extended user information ID 1	--
108	Extended user information type 2	--
109	Extended user information 2	JIMSD_FORM_USEREXTTYPE02
110	Extended user information ID 2	--
111	Extended user information type 3	--
112	Extended user information 3	JIMSD_FORM_USEREXTTYPE03
113	Extended user information ID 3	--
114	Extended user information type 4	--
115	Extended user information 4	JIMSD_FORM_USEREXTTYPE04
116	Extended user information ID 4	--
117	Extended user information type 5	--
118	Extended user information 5	JIMSD_FORM_USEREXTTYPE05
119	Extended user information ID 5	--
120	Extended user link 1#5	JIMSD_FORM_REFINFO01
121	Extended user link 2#5	JIMSD_FORM_REFINFO02
122	Extended user link 3#5	JIMSD_FORM_REFINFO03
123	Extended user link 4#5	JIMSD_FORM_REFINFO04
124	Extended user link 5#5	JIMSD_FORM_REFINFO05

Legend:

--: Not applicable.

#1

If the history data of an Item contains a linefeed character, the character is converted to a half-width space when the history data is output to the file. If the history data of an Item contains a double quotation mark ("), the double quotation mark is replaced by two double quotation marks (") when the history data is output to the file.

#2

The process display name for the process work board containing the Item is output.

#3

The version number increases by one each time an Item is edited.

#4

When you execute the jssitemlist command with the -d option to output the data of Items, this body item becomes Deleter, not Editor.

#5

An extended user link is an Item ID when the type of the link is related Item. An extended user link is a server name, an IP address, or an property number when the type of the link is hardware information. An extended user link is a display name when the type of the link is related information.

To Page Top

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.

• Do not execute the following commands at the same time as the jssitemhistory command. If you do, the jssitemhistory command might fail.

  • jssformdef command

  • jssdelrec command

  • jssdbinit.bat command

  • jssdbrorg.bat command

  • jssdbreclaim.bat command

  • jssdbbackup.bat command

  • jssdbrecovery.bat command

  • jssitemstore command

  • jssitemstoredbexpand.bat command

  • jssitemstoredbsetup.bat command

  • jssrefaclsetup command

  • jssstoreitemdel.bat command

• If you want to execute multiple jssitemhistory commands with the -f option, specify a different Item history file name in the -o option for each command. If you specify the same file name for multiple jssitemhistory commands, the contents of the Item history file might become incomplete.

To Page Top

Remarks

• If you cancel the jssitemhistory command by using Ctrl+C while the command is being executed, the Item history 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 Item history that is output to the file does not contain character strings corresponding to the values of selection codes, the values of selection codes are output to the file without change.

• In the Item history file, date and time data before 1970/01/01 23:59:59 and after 2037/01/01 00:00:00 might not be correct.

• One jssitemhistory command can output a maximum of 65,530 past records of Items. If you want to output history of 65,531 or more Items, specify the -b option or the -r option in the jssitemhistory command to narrow down the target range, and execute the jssitemhistory command multiple times.

• If you attempt to output large amount of Item history to an Item history file, the work area in the Item management database might run short or the log files of the Item management database might run short. If that occurs, a KNAB24002-E error message with detailed code -722 or -1703 will appear. Reduce the number of elements of Items in the Item information entries file, and then re-execute the jssitemhistory command. The guideline for the total number of elements of Items you can enter in an Item information entries file is as follows depending on the size of the Item management database.

  • For the size-S database: Approximately 2,000 element

  • For the size-M database: Approximately 5,000 elements

  • For the size-L database: Approximately 5,000 elements

  • For the size-LL database: Approximately 5,000 elements

  • For the size-XL database: Approximately 5,000 elements

• If you use the jssitemhistory command to output Item information that includes deleted users, the IDs of the deleted users will not be output.

• If you use the jssitemhistory command to output a large amount of Item information, the database work space might be insufficient, and the message "KNAB24002-E: An error occurred in the database of JP1/Service Support. (-713)" might be output. If this occurs, adjust the start date and end date to narrow down the Item information, and then re-execute the command.

• If the information to be output includes characters that are mapped with UTF-8 but that are not mapped with the character set used in the operating environment, those characters are replaced with question marks (?) in the CSV file output.

To Page Top

Example

The following example shows how to output the history of the Items in the process work board with process work board ID HQsystem to a CSV file (c:\Item\Itemhistory.csv). The Items are limited to those that were updated between April 1, 2007 and June 30, 2007.

jssitemhistory -o c:\Item\Itemhistory.csv -r 2007/04/01-2007/06/30 -b HQsystem

To Page Top