5.4.1 Contents of the operation log

Organization of this subsection

(1) Items output to the operation log
(2) Output timing
(3) Output format

(1) Items output to the operation log

The items listed below are output to the operation log. You can change the items to be output by editing the user property file (ucnp_user.properties).

Table 5‒2: Items output to the operation log
Item	Description	Whether output setting can be changed
Date and time	Date and time the operation log was output. The time zone depends on the Navigation Platform's server settings.	Y
Absolute time in milliseconds	Absolute time in milliseconds at which the operation log was output. This is the difference in milliseconds between the output time and 1970-01-01 at 00:00 in Coordinated Universal Time (UTC).	N
Session ID	Session ID of the user who switched the node.	Y
Operational Content execution ID	ID assigned to the operation that was performed during execution of an Operational Content. When execution of an Operational Content is suspended, the Operational Content execution ID is also the same before the execution was suspended and after the execution was resumed. The Operational Content execution ID can also be acquired from the parameters passed to I/O Plugins. If you want to see the correspondence between the values entered by the user during execution of an Operational Content and the values in the operation log, output the contents of input items for I/O Plugins and Operational Content execution IDs to, for example, a file.	N
User ID	User ID or JP1 user name of the user that switched the node.	N
Group ID	When using Active Directory for user authentication: ID of the group to which the user that switched the node belongs. If the user belongs to multiple groups or groups are in hierarchies, multiple group IDs are output in CSV file format. In other cases: An empty character string is output.	Y
Operational Content ID	ID of the Operational Content whose node was switched.	N
Operational Content name	Name of the Operational Content whose node was switched.	Y
Operational Content version ID	Version ID of the Operational Content whose node was switched.	N
Transition type	Type of node transition. There are eight transition types: `start`: Start of an Operational Flow. `show_next_page`: Transition to the next node by a method such as clicking the Next button. If this is the last Process Node in the Operational Flow (in which case the Back button is not displayed), the transition type is `show_complete_page` when the Next button is clicked. `show_previous_page`: Transition to the previous node by a method such as clicking the Back button. `show_complete_page`: Transition to the end point (Process Node^#1 or Terminal Node) of the Operational Flow by a method such as clicking the Next or Done button. `back_jump`: Direct transition to the previous node in the Operational Flow.^#2 `forward_jump`: Direct transition to the next node in the Operational Flow. `save`: Suspension of task by clicking the Suspend button. `load`: Resumption of a task using suspend information after the task was suspended.	N
Source node ID	Information about the source node. An empty character string is output in the following cases: An Operational Flow in which no Terminal Node is placed at the start point is started. Direct node transition is permitted and a transition is made from the status in which an Operational Flow is completed.	N
Source node name		Y
Actual target node ID	Information about the actual target node. The specified target node differs from the information that is output for this item in the following cases: An error occurred in the I/O Plugin and the actual target node differs from the specified target node. The Cancel button was clicked in the I/O Plugin execution confirmation dialog box. If an error occurs in the I/O Plugin on the first Process Node that is not connected to the start Process Node or the start Terminal Node at the start of the Operational Flow, an empty character string is output.	N
Actual target node name		Y
Specified target node ID	Information about the target node specified by the user. Information about the actual target node differs from the information that is output for this item in the following cases: An error occurred in the I/O Plugin and the actual target node differs from the specified target node. The Cancel button was clicked in the I/O Plugin execution confirmation dialog box.	N
Specified target node name		Y
Error flag	Flag indicating the results of I/O Plugins (User Plugins). The following explains the values: `OK`:^#3 The result of the I/O Plugin was successful or the I/O Plugin did not exist. `WARNING`:^#3 The result of the I/O Plugin was a warning. The `WARNING` error flag is output if the `ucnp.error.message` key is set in the `Map` return value by the `inputFromNode` method or the `outputToNode` method in the `IIoPluginController` interface of the I/O Plugin, `WARNING` is set in the `ucnp.error.type` key, and the result of the I/O Plugin is successful. `NG`: The result of the I/O Plugin was a failure (`IIoPluginController` interface). The `NG` error flag is output if the `ucnp.error.message` key is set in the `Map` return value by the `inputFromNode` method or the `outputToNode` method and `NG` is set in the `ucnp.error.type` key or the `inputFromNode` or the `outputToNode` method throws an unexpected exception. `CANCEL`: Cancel was selected in the I/O Plugin execution confirmation dialog box (the plugin was not run).	N
Input value check errors count	The number of times an error occurred in the Guide Part's input value check until node transition succeeded. If execution of an Operational Content was suspended, the number of times an error occurred in the Guide Part's input value check before suspension occurred is output to the operation log that is output when execution is suspended.	N
Plugin errors count	The number of times an error occurred in the I/O Plugin until node transition succeeded. If execution of an Operational Content was suspended, the number of times an error occurred in the I/O Plugin before suspension occurred is output to the operation log that is output when execution is suspended.	N
`ucnpOptions` parameter	Value specified in the `ucnpOptions` parameter. If the `ucnpOptions` parameter is not specified, an empty character string is output.	Y

Legend:

Y: Whether the item is to be output to the operation log can be changed by editing the ucnp.base.server.operationlog.user.analyze.info property setting (item for easy analysis when user-specific analyses are performed on the operation log).

N: Always output to the operation log (item that is output even when the ucnp.base.server.operationlog.user.analyze.info property is set to false).

#1

If you want to analyze accurately the time of the completion of an operation on an Operational Content in which a Process Node is placed at the end point of the Operational Flow, the Back button for the Process Node at the end point must be set to be hidden.

If you will be placing a Process Node at the end point, instruct the Content Manager, the Content Creator (when JP1/Base is used for user authentication) or the Content Editor to hide the Back button. For details about how to set the Back button to be hidden, see the manual JP1/Navigation Platform Content Editing Guide.

#2

If the ucnp.base.client.directjump.enable property is all, the type of direct transition is always back_jump.

#3

In the case of direct transition, the OK and WARNING I/O Plugin results might be intermixed. When there is a mixture of these two results, WARNING is output to the operation log.

To Page Top

(2) Output timing

The operation log is output when an Operational Flow is started in the Operational Content Execution Window and when a node transition occurs. If a direct transition occurs due to clicking of a Process Node, the operation log is output, but information about the nodes existing between the source node and the target node is not output.

To Page Top

(3) Output format

The operation log is output in tab-delimited format. This subsection provides an example of operation log output when a node transition is made by clicking the Next button.

Table 5‒3: Output items in the operation log and values in the example output
Output item	Value in the example output
Date and time	2012-09-19 at 17:19:41:109 milliseconds
User's user ID	`user1`
ID of the group to which the user belongs	`group`
Operational Content	ID: `268e3592-0133-1000-8002-00000ad23cbb-0` Name: `Content` `1`
Source Process Node	ID: `P001` Name: `Process` `Node` `A`
Actual target Process Node	ID: `P002` Name: `Process` `Node` `B`
Specified target Process Node	ID: `P003` Name: `Process` `Node` `C`
Operation during transition	Transition by clicking the Next button
Error flag	The plugin result was successful
Input value check errors count on the source node	`2`
Plugin errors count on the source node	`0`
`ucnpOptions` parameter value	`OptionA`

Example output of operation log

2012/09/19Δ17:19:41.109<tab>1348042781109<tab>00946E257CB395F59C9519BB77C3FF28CsR8JWB_2<tab>eb749199-0146-1000-8001-00000ac47c1d1<tab>user1<tab>group<tab>268e3592-0133-1000-8002-00000ad23cbb-0<tab>Content 1<tab>eb736f61-0146-1000-8000-00000ac47c1d<tab>show_next_page<tab>P001<tab>Process Node A<tab>P002<tab>Process Node B<tab>P003<tab>Process Node C<tab>OK<tab>2<tab>0<tab>OptionA

Legend:

Δ: Single-byte space

<tab>: Tab

To Page Top