Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Comments' > 'Reasons'

...

  • Any new entries will be added to this file, i.e. the file will not be overwritten.
  • The Audit Log is visible to:
  • 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

...

Reasons

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

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

Mandatory

...

Reasons

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

...

Either predefined or individual comments reasons can be set when force_comments_for_audit_log = true is set. 

Predefined

...

Reasons

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

Predefined comments reasons 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 reasons as listed in the following code box:

Code Block
languagexml
titlejoc.properties - Predefined Comments
### 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

...

Reasons 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 commentsreasons.
  • The "\" at the marks the end of a line.

 

Modifying

...

Reasons Settings

System administrators are free to modify predefined comments and reasons and the force_comments_for_audit_log flag to suit their own requirements.

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

...

Individual Reasons

Individual Comments Reasons can be entered in the text field as shown in the screenshot above. 

...