...
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.
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:
Inclusion of the Audit Log view and in particular the Reasons field is intended to provide users of the JOC Cockpit with more relevant information about actions taken than is recorded in the History.
- Any new entries will be added to this the Audit Log file, i.e. the file will not be overwritten.
- The Audit Log is visible toJOC Cockpit to:
- JOC Cockpit users 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 Administrators with access to the DBMS used by the JOC Cockpit and JobScheduler Master(s) or the file system where the Audit Log file is written.
- JOC Cockpit users Users with the appropriate permissions. The specification of user permissions is described in the Authentication and Authorization - Configuration article.
- The Audit Log is read-only for all JOC Cockpit users - only the JobScheduler Web Services and System Administrators that have access to the file system can modify the log.
- Entries to the Audit log can only be made when an operation that changes the state of a JobScheduler Object is initiated in the JOC Cockpit or other application accessing the JobScheduler Web Services
- It lies in the responsibility of the administrator system administrators to check compliance requirements such as the retention period for information contained in this file.
- Maintenance of an Audit Log requires the administrator system administrators to comply with applicable law and corporate governance.
...
Users carrying out operations are able to add an explanatory reason for each operation. These reasons are then saved with the Audit Log and can be read by all other JOC Cockpit users with the necessary permissions. The 'Write Enter a Reason' form is shown after each operation is initiated and can be seen in the following screenshot:
Two types of comment Reasons may be mandatory and two forms of reasons are possible:
- Predefined Reasons which are selected from a drop-down list and
- Individual Reasons as shown in the above screenshot.
Mandatory Reasons
A The force_comments_for_audit_log flag can be set in the in the joc.properties file as shown in the following code box:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
### 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 reasons.
- The "\" at the marks the end of a line.
...
Modifying Reasons Settings
...