AUDIT

Purpose

The AUDIT statement defines how changes to HCL Workload Automation for Z data is logged. You can specify this statement for a controller or standby controller. You can also use more than one AUDIT statement to define HCL Workload Automation for Z auditing actions.

When an access is logged, a record containing auditing information is written to the current log data set, which depends on the value you set for the AMOUNT parameter. The mapping of the records on the log data set is described in Diagnosis Guide and Reference.

When you request logging of accesses to JCL data, logging is performed if the JCL is present in, or is inserted into, the JCL repository.
Note:
  1. Changes to current plan, current-plan-extension, and event-triggering records are always logged for HCL Workload Automation for Z restart purposes. Read accesses to these resources are not logged, and you cannot prevent the logging of update accesses.
  2. If you set AMOUNT(DATA) or AMOUNT(KEY), auditing records are written to the job-tracking-log data set and this affects how often HCL Workload Automation for Z performs a current-plan-backup process. Keep this in mind when specifying a value for the BACKUP keyword of JTOPTS. Also consider auditing records when allocating the job-tracking-log data sets, especially if you specify AMOUNT(DATA).
  3. The AUDIT records contain a field to indicate whether or not they are related to a real data change. Based on that field, EQQAUDIT program reports only those records that actually changed from an external point of view. For example, when a dialog user selects a data item in a list through the M (Modify) row command and exits using the PF3 key, without changing the data item, the process rewrites related data records to keep any change that the scheduler performed for internal purposes. In this case, the scheduler creates an AUDIT record for a data item that the external user did not really change, however EQQAUDIT does not report that record. In particular, using the J row command always causes the JCL to be written to the JS file, even if the dialog user did not change the JCL.

The HCL Workload Automation for Z sample library contains a program that can format reports of job-tracking, track-log, and extended-auditing records. For more information, see HCL Workload Automation for Z auditing package.

AUDIT is defined in the member of the EQQPARM library as specified by the PARM parameter on the JCL EXEC statement.

Format


1  AUDIT?  ACCESS (
2.1! UPDATE
2.1 READ
1 )?  AMOUNT (
2.1! KEY
2.1 DATA
2.1 EXTENDED
1 )  FILE (
2.1 ALL
2.2.1 AD
2.2.1 CAL
2.2.1 JLIB
2.2.1 JS
2.2.1 JV
2.2.1 LT
2.2.1 OI
2.2.1 PER
2.2.1 RD
2.2.1 RG
2.2.1 VAR
2.2.1 WS
2.2.1 WSCL
1 )

Parameters

ACCESS(READ|UPDATE)
Defines when HCL Workload Automation for Z tracks accesses to the file. Specify UPDATE to track all changes to the file. Specify READ to track all accesses.
AMOUNT(DATA|EXTENDED|KEY)
Defines how much data is to be logged by HCL Workload Automation for Z for accesses to the file.

Specify KEY to log only the VSAM key (this is enough to identify the resource). Specify DATA to log the VSAM key and record.

Specify EXTENDED to use the extended auditing feature. In this case, all data about the database changes is logged in the EQQDBnn data sets (instead of EQQJTnn). The EQQDBnn data sets are created by the EQQPCS14 sample and provide the input for the extended auditing feature. The EXTENDED argument applies only to the following files:
  • AD
  • CAL
  • JV
  • OI
  • PER
  • RD
  • RG
  • WS
FILE(name of HCL Workload Automation for Z file)
Defines the name of the file for which auditing is being defined. A separate AUDIT statement is required to identify each file for which you want auditing information recorded. Specify one of these files:
AD
Application description
CAL
Calendar definition
JLIB
JCL in a job library
JS
JCL in the JS VSAM file
JV
JCL variable table
LT
Long-term-plan occurrence
OI
Operator instruction
PER
Period definition
RD
Special resource descriptions
RG
Run cycle group definition
VAR
JCL variable setting
WS
Workstation description
WSCL
All-workstations-closed definition
ALL
All files
 AUDIT FILE(ALL) ACCESS(UPDATE) AMOUNT(KEY)   1
 AUDIT FILE(JS) ACCESS(UPDATE) AMOUNT(DATA)   2
In this example of AUDIT statements:
1
HCL Workload Automation for Z tracks all changes to all files by logging the VSAM key.
2
HCL Workload Automation for Z tracks all changes to JCL for jobs and started tasks by logging the VSAM key and record.