F.3 Operation log output format
The following describes the format of operation log output, output elements, and examples.
- Organization of this subsection
(1) Operation log output format
An output operation log consists of CALFHM indicating the operation log format, an operation log revision number, and the output elements.
CALFHM x.x,output-element-1=value-1,output-element-2=value-2,...,output-element-n=value-n
(2) Output destination
Operation logs are output to either of the following destinations.
- For a physical host environment:
-
IM-SS-path\log\public\accesslog
- For a cluster environment:
-
shared-folder\log\public\accesslog
(3) Output elements
There are two types of output elements: common output elements and specific output elements. The following describes these elements:
-
Common output elements
These elements are output by all JP1 products that can output operation logs.
-
Specific output element
These elements are unique to each JP1 product that can output operation logs.
(a) Common output elements
The following table describes the values output for the common output elements and their meanings.
No. |
Output element |
Value |
Contents |
|
---|---|---|---|---|
Element name |
Output attribute |
|||
1 |
Common specification identifier |
-- |
CALFHM |
Identifier of the operation log format |
2 |
Common specification revision number |
-- |
1.0 |
Revision number used to manage operation logs |
3 |
Sequence number |
seqnum |
Sequence number |
Sequence number of the operation log |
4 |
Message ID |
msgid |
KNABxxxx-x |
Message ID for each product |
5 |
Date and time |
date |
YYYY-MM-DDThh:mm:ss.sssTZD# |
Date and time that the operation log was output, and the time zone |
6 |
Source program name |
progid |
JP1IMSS |
Name of the program in which the event occurred |
7 |
Source component name |
compid |
Server |
Name of the component in which the event occurred |
8 |
Source process ID |
pid |
process-ID |
ID of the process in which the event occurred |
9 |
Source location |
ocp:host |
host-name |
Name of the host on which the event occurred |
10 |
Event type |
ctgry |
ContentAccess |
Identifier used to classify the event output to the operation log |
11 |
Event result |
result |
Success |
Result of the event |
12 |
Subject identification information |
subj:uid |
user-ID |
Information for the user who generated the event |
- Legend:
-
--: No attribute names are output.
- #
-
YYYY is the year, MM is the month, DD is the day, hh is the hour, mm is the minute, ss is the second, and sss is the millisecond.
T separates the date from the time.
TZD is a time zone identifier. One of the following is output.
+hh:mm: Indicates a positive time difference of hh:mm from the UTC time.
-hh:mm: Indicates a negative time difference of hh:mm from the UTC time.
Z: Indicates the same time as the UTC time.
(b) Specific output elements
The following table describes the values output for the specific output elements and their meanings.
No. |
Output element |
Value |
Contents |
|
---|---|---|---|---|
Element name |
Output attribute |
|||
1 |
Object information |
obj |
Item |
Information about the Item that generated the event |
obj:rid |
related-Item-serial-number |
|||
2 |
Operation information |
-- |
|
Information about the user operation that generated the event |
3 |
Optional description |
msg |
any-message |
Message describing the event |
- Legend:
-
--: No attribute names are output.
(4) Operation log output example
The following is an example of an operation log that is output when an Item is escalated from the window.
CALFHM 1.0, seqnum=66, msgid=KNAB16004-I, date=2013-11-20T09:14:47.499+09:00, progid=JP1IMSS, compid=Server, pid=1844, ocp:host=IMSSHOST, ctgry=ContentAccess, result=Success, subj:uid=jp1admin, obj=Item, obj:rid=0000000011, op=Escalation, msg="The Item was escalated. (escalation destination Item ID = processworkboard12-00004, escalation source Item ID = processworkboard11-00011, Item version number = 9)"