...
Users of the JOC Cockpit with the necessary permissions can view the Audit Log in the JOC Cockpit by clicking the Audit Log link in the JOC Cockpit main menu as shown in the screenshot below. This view and, in particular, the Reasons, Time Spent and Ticket Link information , is intended to provide users with more relevant operational information than is available from the History.
...
The Audit Log contains information about changes to JobScheduler objects initiated from the JOC Cockpit and by other applications using the JobScheduler Web Services. It does not include changes made to objects using the JobScheduler Object Editor, JOE, or changes made directly to objects on the file system using, for example, a text editor.
Compliance, Reporting and Operational Features
...
- Created: the point in time when the action was performed.
- Account: the user account that caused the action.
- Request URL: the Web Service URL that was invoked by the JOC Cockpit. The URLs represent the object type and action, e.g. /orders/start.
- Job Chain, Order ID, Job: identifies the object for which the action was performed.
- Reasons: (can be mandatory or optional - see below) an explanation of why an action was carried out. Reasons are created either by selecting an item from a list of predefined reasons (configurable) or individual - i.e. free text input. A maximum of 2000 characters can be added to a free text reason.
- Time Spent: (optional) the number of minutes required for the action (including time for impact analysis) can be added.
- Ticket Link: (optional) a URL can be added that points to a ticket system, e.g. the SOS Ticket System, to identify the underlying ticket for the intervention.
...
Reasons for Actions
Users carrying out actions are able to add an explanatory notes - Reasons - for each action. These notes are entered as part of the specification of an action and then saved in the Audit Log. They can then be read by all other JOC Cockpit users with that have the necessary permissions. The form for the 'Start Order At' action is shown as an example in the following screenshot:
...
Either predefined or individual reasons can be set when force_comments_for_audit_log = true is set.
Optional Reasons
Users can configure in their profiles If Reasons are not mandatory - i.e. the force_comments_for_audit_log flag is set to false - users can configure whether they wish to be offered the option of entering reasons Reasons for the actions they carry out. This is configured in Users' profiles as shown in the next screenshot:
...
If this option is not set and reasons Reasons are not mandatory, which is are the default settingsettings, then users Users will not be presented with the Enter a Reason function when the Start Job At or Start Order At functionsstarting Orders or Jobs.
Behavior of Start Order now and Start Task now
The behavior of the Start Order now and Start Task now functions depends on whether or not Action Notes are enabled in the user's Profile setting and whether Action Note Reasons are mandatory or optional (i.e. whether force_comments_for_audit_log = true or false).
| Enable Reasons for Audit Log (Profile Setting) | mandatory | optional |
|---|---|---|
| Not selected | 'Enter notes for this Actiona Reason' form opens | Order/Task starts immediately |
| Selected | 'Enter notes for this Actiona Reason' form opens | 'Enter a Reason' form opens |
Predefined Reasons
A predefined set of reasons is delivered with the JOC Cockpit.
Predefined reasons Reasons are found in the ./joc_home/jetty_base/resources/joc directory, in the joc.properties file.
The predefined reasons are Reasons are listed in the following code box:
...
Individual Reasons can be entered in the text field as shown in the screenshot abovenear the top of this page.
UTF-8 characters are allowed.
...
The arrow at the left hand side of each entry in the Audit Log view table allows more detailed information about the request submitted to the JobScheduler Web Services . The - the Request Body. This opens in a new row in the Audit Log as shown in the following screenshot and includes information about the Job Scheduler which the Order is to be processed on, as well as the Order Parameters and starting time (processing starting from State 20, starting immediately, etc), :
The Advanced
...
Filters
Filters are available to allow selected entries from the Audit Log to be displayed.
In addition to the preset All, Today, Last hour, etc. filters listed at the top of the Audit Log view there is an Advanced Filter function which is opened with the Advanced Filter button at the top right of the view. Clicking this button opens the Advanced Filter function. Note that the preset Filters (All, Today, Last hour, etc.) work in parallel with the Advanced Filter. This means that if the Today preset last filter selected overwrites any previous filters. For example, if the Today preset filter is selected and then From 09:00:00 To 18:00:00 then all Audit Log entries started between 09:00 and 18:00 will be shown for all the days covered by the Audit Log.
The Search
...
Field
The Search button field allows a search of the results of the preset or Advanced Filters to be carried out.
...
The filtered table as shown in Audit Log view is exported as a Microsoft Excel® compatible .xls file. The next screenshot shows the an exported file (opened in Open Office Calc).
Note that the PARAMS part of records (see the Audit Log Sample section above) are not included in the export.
Note that the export function only takes the Audit Log entries that are shown in the Audit Log view. In order to export an Audit Log with, for example 900 entries, all 900 entries have to be loaded into the Audit Log view and the pagination set to 1000 as shown in the next screenshot:
In order to export an Audit Log of, for example, 2500 entries, the Max. number of entries per page setting in the User Profile should first be increased - in this case 3000 would be sufficient.
Note that this value should be reset after the export has been carried out as it may otherwise considerably slow down loading of other list views such as the History.
Audit Log Housekeeping & Archiving
...