Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Audit Logs Export' section added

...

Excerpt

The Audit Log allows compliance and operations reporting requirements for job scheduling activities to be met by providing a an automatic and secure record of all actions that users of the JobScheduler Web Service - including JOC Cockpit users and external applications - perform on job-related objects. The Audit Log lists the relevant JobScheduler objects - Jobs, Job Chains, Orders, etc. - and any actions that modify their status.

The Audit Log is written by the JobScheduler Web Service as shown in the JOC Cockpit - Architecture page.

...

The Audit Log is maintained for all job-related objects such as Jobs, Job Chains, Orders, etc., whose statuses are modified by users carrying out actions such as starting, stopping or pausing an Order or Job Chain. It uses a format that is human and machine readable and fulfills the following main functions:

  • provide a compliance-conform record in a simple file format that can be archived and handed over to a compliance officer,
  • provide operational records of job scheduling activities for reporting purposes,
  • provide an operational record of that is readily accessible to operating staff,
  • provide a second source of operational information should if the database used to store operational records is not be available.

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 a text editor. 

...

  • The Audit Log is written automatically by the JobScheduler Web Services:
    • Entries to the Audit log are made when an action that changes the state of a JobScheduler Object is initiated in the JOC Cockpit or other application accessing the JobScheduler Web Services.
    •  There is no mechanism for switching off the Audit Log.
  • The Audit Log is written in two locations simultaneously:
    • In the DBMS used by the JobScheduler Web Services: 
      • This instance is used by the JOC Cockpit to allow operators to view the Audit Log information.
      • It is also used by the JOC Cockpit to generate an a Microsoft Excel®-compatible export file for reporting purposes.
    • In the Audit Log file:
      • It is intended that this instance is archived and used as a compliance record. System Administrators can make a copy of this instance available to operating staff if the DBMS should not be available. 
      • The Audit Log file is named JOCAuditLog.log and saved in the ./logs folder.
  • All new entries will be added to the Audit Log - neither the log file not the DMBS records are overwritten.
    • System administrators have to arrange an archiving and housekeeping system for the Audit Log file according to relevant compliance laws and corporate governance.
    • It is the responsibility of system administrators to check compliance requirements such as the retention period for the information contained in the Audit Log file.
  • The Audit Log is visible in the JOC Cockpit to:
  • The Audit Log is read-only for all JOC Cockpit users - only System Administrators that have access to both the file system and to the database can modify the log. 

Key to the Audit Log Entries

...

Users carrying out actions are able to add an explanatory notes 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 the necessary permissions. The form for the 'Start Order At' action is shown as an example in the following screenshot:
Image Modified 

Action Notes are made up of three elements as shown in the screenshot above:

...

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 Request Body row shown in the following screenshot includes 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 Audit Log includes the Web Service URL, which allows the object type and operation to be identified. For example, ./orders/resume translates to the action of resuming an order that is identified by its order ID and Job Chain path, as specified in the PARAMS part of each log entry.

Audit Log Export

The Audit Log Export function, which is activated with the button with the arrow shown in the next screenshot, allows the Audit Log to be exported in a reporting-friendly format either in whole or filtered.

Image Added

The filtered table as shown in Audit Log view is exported as a Microsoft Excel® compatible .xls file. The next screenshot shows the file opened in Open Office Calc.

Image Added

Note that the PARAMS part of records (see the Audit Log Sample section above) are not included in the export.

Audit Log Housekeeping & Archiving

As already noted the JOC Cockpit adds to the Audit Log on an ongoing basis.

...