Page History

...

The Audit Log is maintained for objects such as Jobs, Job Chains, Orders, etc., whose statuses are modified by users carrying out operations such as starting, stopping or pausing.

• Any new entries will be added to this file, i.e. the file will not be overwritten.
• The Audit Log is not visible to users but only to :
  • JOC Cockpit users with the appropriate permissions. The specification of user permissions is described in the Authentication and Authorization - Configuration article.
    • The default authorization permissions for the Audit Log which are configured for the JOC Cockpit are listed in the Permissions Matrix shown in the Authentication and Authorization - Permissions for the JOC Cockpit Web Service article.  
  • administrators with access to the
  file system where
  • DBMS used by the JOC Cockpit
  is installed
  • and JobScheduler Master(s).
• It lies in the responsibility of the administrator to check compliance requirements such as the retention period for information contained in this file.
• Maintenance of an Audit Log requires the administrator to comply with applicable law and corporate governance.

Operation Comments

Users carrying out operations are able to comment each operation. These comments are then saved with the Audit Log and can be read by all other JOC Cockpit users with the necessary permissions. The 'Write a Comment' form is shown after each operation is initiated and can be seen in the following screenshot:
Image Added 
Two types of comment are possible:

• Predefined Comments which are selected from a drop-down list and
• Individual Comments as shown in the above screenshot

Mandatory Comments

A  force_comments_for_audit_log flag can be set in the in the joc.properties file as shown in the following code box:

### This flag controls if the comment is required or not.
force_comments_for_audit_log = false

The joc.properties file is located in the ./joc_home/jetty_base/resources/joc directory.

Predefined Comments

A predefined set of comments is delivered with the JOC Cockpit.

Predefined comments are found in the ./joc_home/jetty_base/resources/joc directory, in the joc.properties file. 

The JOC Cockpit is provided with a default set of predefined comments as listed in the following code box:

### Pre-defined comments
comments =  System maintenance; \
            Repeat execution; \
            Business requirement; \
            Restart failed execution; \
            Re-instantiate stopped object; \
            Temporary stop; \
            Change of JobScheduler object; \
            Rerun with parameter changes; \
            Change of external dependency; \
            Application deployment and upgrade

Predefined Comment Syntax

• The ";" near the end of each line marks the end of the comments. The use of a semicolon here as a delimiter allows commas to be used in comments.
• The "\" at the marks the end of a line.

Modifying Predefined Comments 

System administrators are free to modify predefined comments to suit their own requirements.

The JOC Cockpit needs to be restarted after changes to the joc.properties file before changes will take effect.

Audit Log Location

The Audit Log is found in the ./joc_home/jetty_base/logs directory, in the JOCAuditLog.log file. If the file does not exist, it will be created with the first operation of a user who modifying the status of an object that is carried out by a user.

Audit Log Sample

The following sample shows a number of Web Service requests that have been performed by a user "ap":

...