Print, Audit trail report

The Audit Trail Report produced by the batch print job consists of the following parts:

• Audit trail contents, which are printed in a formatted or hexadecimal format or a combination of both
• Summary information

Audit Trail Report - Formatted Print Mode, Part 1 through Audit Trail Report - Hexadecimal Print Mode, Part 2 are samples of the formatted and hexadecimal formats of the audit trail report.

Each page of the audit trail report begins with page headings that consist of the File-AID for IMS/ISPF release number, the data set and DBD names of the database that was updated, the page number, and the date and time the report was generated.

Following the page headings on page one are the audit trail dataset name, the date and time the database was opened for updating, and the TSO user ID that was used to perform the updates. The user’s TSO-PREFIX is also shown when it differs from the TSO-ID.

Preceding the segment images of each database update, as it appears on the report, are audit trail segment headings. These headings always consist of at least two lines and can consist of several lines. The first line contains a sequential number assigned to each database update and the edit sub-option (Formatted, Unformatted, or Character) that was in use when the update was made. At the end of the first segment heading line is the phrase "SEGMENT update-action ON date AT time." Update-action can be INSERTED (for an inserted or repeated segment), DELETED, or UPDATED. The date and time show when the segment update-action was taken.

The second segment heading line contains the segment name and optional description, the segment’s hierarchical level number in its database, and, for a multiple record type segment, the RCDTYPE 1 and 2 values. If either record type value contains non-displayable data, it appears in a three-line hexadecimal format.

The last segment heading lines show the fully concatenated key for that segment. The length of the fully concatenated key dictates the number of print lines shown. The key values for each segment type represented in the fully concatenated key are separated by commas. If any individual key value contains non-displayable data, the entire fully concatenated key appears in a three-line hexadecimal format.

File-AID for IMS/ISPF issues DL/I CHKP calls during your database edit session each time you enter the SAVE primary command and, automatically, after every n database updates when you establish a checkpoint interval through the RECOVERY primary command. CHKP calls are tracked by the audit trail feature and are reflected on the Audit Trail Report by a single segment heading line that is not followed by any segment images. The segment heading syntax is the same as previously described for the first segment heading line, except that CHECKPOINT OCCURRED ON date AT time appears at the end of the line.

The format used to print each segment image depends on what you specified in the Print format field on the Audit Trail Disposition screen (see Audit Trail Feature or Print Audit Trail Screen (Online Conversation)).

Formatted Report Contents

When an audit trail segment image is printed in the formatted mode, File-AID for IMS/ISPF uses the same segment/layout XREF and segment layout data sets you specified during the edit session where the audit trail was created. The first two columns shown for each segment image contain the level number/data-name and format of each field in the segment layout in a format similar to the File-AID for IMS/ISPF edit formatted sub-option.

The next two columns on the report are Before and After Field Value. The way these columns are formatted is determined by the segment update action shown on the first segment heading line.

When the update action is INSERTED, the After Field Value column contains the value of each field in the segment that was created. The Before Field Value column is always empty. When the update action is DELETED, the Before Field Value column contains the value of each field in the segment that was deleted. The After Field Value column is always empty. When the update action is UPDATED, the Before Field Value column contains the value of each field in the segment as it was before the change. The After Field Value column shows the new field value only for the fields that were changed. The After Field Value column is blank for unchanged fields.

Field values are shown in the Before and After Field Value columns in a format similar to the edit formatted sub-option (see to here for a description of the Field Value column), with one exception. In edit formatted, fields with invalid or unprintable data (given their field format) are represented by the word "INVALD." On the Audit Trail Report, invalid field contents are shown in a three-line hexadecimal format.

The rightmost column on the formatted Audit Trail Report is for informational messages. Following are the situations that generate a message:

• When an alphanumeric field is changed from a non-blank value to blanks (HEX 40s), the message "CHANGED TO SPACES" is printed. This message enables you to distinguish between fields that were not changed and those that were blanked out.
• When a field is changed from a valid value to an invalid value or when a field in an inserted segment contains an invalid value, the message "AFTER FIELD INVALID" is printed.
• When a field value is changed from an invalid value to a valid value or when a field in a deleted segment contains an invalid value, the message "BEFORE FIELD INVALID" is printed.
• When an unchanged field contains an invalid value, the message "FIELD INVALID" is printed.
• When a field is changed and both the before and after field values are invalid, the message "BOTH FIELDS INVALID" is printed.
• When a segment layout contains a COBOL occurs depending on clause or a PLI REFER option and the value of the object of the occurs depending on or REFER is changed, either “n BYTES ADDED” or “nBYTES DELETED” is printed at the end of the segment layout where “n” is the number of bytes that were added or deleted.

When a user updates an existing database segment, both a before and after image of the segment is written to the audit trail dataset. On the Audit Trail Disposition screen, you can specify that only the specific fields within the segment that were changed be printed on the Audit Trail Report (see to Audit Trail Feature or Print Audit Trail Screen). This action causes all unchanged fields within the segment to be excluded from printing.

Unchanged fields that are not printed are replaced by a dashed print line ending with the phrase "x LINES/y BYTES NOT PRINTED." x is the number of excluded print lines, and y is the number of bytes of segment data not printed.

For keyed segments, the fields that make up the key value are always printed. Additionally, all higher level group data-names leading down to printed, changed fields are also printed. All fields in inserted and deleted segment images are always printed.

In some situations, even though you request formatted printing of the audit trail dataset, File-AID for IMS/ISPF is unable to do so. In these cases, an error message is printed that indicates the problem, and the entire Audit Trail Report is printed in an unformatted, hexadecimal format. Following are some of the conditions that create this result:

• N was specified for the Use Layouts field on the EDIT - Data Base Specification screen during the edit session in which the audit trail dataset was created. Therefore, segment/layout XREF and segment layout information are unavailable to File-AID for IMS/ISPF, preventing formatted printing.
• The segment/layout XREF dataset, XREF member, or segment layout datasets specified for the edit session that created the audit trail cannot be found by File-AID for IMS/ISPF during the Audit Trail Report processing. As before, this condition prevents formatted printing.

File-AID for IMS/ISPF is sometimes unable to print a particular audit trail segment image in the formatted manner, which causes that segment image to be printed in the hexadecimal format preceded by one or more error messages that indicate the problem. Following are some of the conditions that cause File-AID for IMS to switch from formatted to hexadecimal format:

• The record type value in the before and/or after segment image could not be found in the segment/layout XREF.
• The segment layout for the before and/or after segment image could not be found in the segment layout datasets.
• The segment layout for the before and/or after segment image has syntax errors.
• The segment layout for the before and/or after segment image contains a COBOL occurs depending on clause or a PLI REFER option and the value for the object of the occurs depending on or REFER is non-numeric, outside the occurrence range defined in the segment layout, or causes the length of the segment to exceed the maximum segment length as defined in the database DBD.

Hexadecimal Report Contents

The Audit Trail Report is printed in hexadecimal format when H is specified in the Print Format field on the Audit Trail Disposition screen (see Audit Trail Feature or the sub-option 5.5, Print Audit Trail screen described earlier). All or part of the report can also appear in hexadecimal format in several error situations that occur during the processing of a formatted print request. These error situations are described in Formatted Report Contents.

When printing the Audit Trail Report in hexadecimal format, each segment image is displayed in a three-line format similar to the hexadecimal mode of the edit unformatted sub-option. The top line represents the character representation of the segment, the middle line represents the upper half-byte of each character in HEX, and the third line represents the lower half-byte of each character in HEX. When a character cannot be displayed, it is represented by a period on the top line.

Up to 100 positions of the segment are printed in each set of three lines. The Seg Positions column immediately to the left of the segment contents indicates the starting and ending positions in the segment represented by each set of three lines.

When the update action shown on the first segment heading line is INSERTED, the Before/After column to the left of the inserted segment’s image contains "After." When the update action shown is DELETED, the Before/After column contains "Before" for the deleted segment’s image. When the update action shown is UPDATED, the entire pre-change segment image is shown with "Before" in the Before/After column, followed by the entire post-change segment image with "After" in the Before/After column.

When showing the before and after images of a changed segment, the Audit Trail Report also indicates the segment positions that were changed. For both the before and after segment images, the positions that were changed are indicated by a bold-faced dash under each position. For each three-line set of print lines that contains changed segment positions, the bold-faced word CHANGE is printed to the left and below the print lines on the same line as the dashes.

If the segment updated during the edit session was variable length and you increased the length of the segment, the added segment positions are indicated by a bold-faced plus sign under each new position in the after segment image. If you decrease the length of a variable length segment, the deleted segment positions are indicated by plus signs under the before segment image. In both situations, the bold-faced word CHANGE appears to the left on the same line as the plus sign.

For keyed segments, the segment positions that make up the key value are indicated by a bold-faced asterisk under each position.

As when printing the Audit Trail Report in the formatted mode, you have the option of specifying on the Audit Trail Disposition screen that only the specific fields within an updated segment that you changed be printed in hexadecimal (see to Print Only Changed Fields or Print Audit Trail Screen). Because, when printed in hexadecimal, a segment’s contents are in 100-byte long increments, the changed segment positions are printed as part of a 100-byte increment. Each 100-byte increment within a segment that contains no changed data is excluded from printing.

Increments of 100 bytes that are not printed are replaced by a dashed print line that contains the phrase "x POSITIONS NOT PRINTED," where x is the number of segment positions not printed.

All positions in inserted and deleted segment images are always printed.

Summary Information

The following summary information is printed on the last page of the Audit Trail Report (Audit Trail Report - Hexadecimal Print Mode, Part 2):

• The name of the audit trail dataset that was printed.
• The description of the audit trail entered on the Audit Trail Disposition screen (Specify Disposition of Audit Trail Screen).
• The number of database segments that were inserted, deleted, or changed.
• The database dataset and DBD names.
• The DBD library dataset names.
• The segment layout library dataset names.
• The segment/layout XREF dataset name.
• The Audit Trail Report options used: print format, maximum number of lines printed per page, spacing before segment headers, and whether to print only changed fields on an update.
• The date and time when the edited database was closed.

• The CCSID either stored in the Audit Trail header record or the batch default specified at installation with the parameter variable CCSID_FOR_UNICODE_COVERSION_SERVICES in the Japanese Language Parameters, if no CCSID is stored in the Audit Trail header.

Audit Trail Report - Formatted Print Mode, Part 1

Audit Trail Report - Formatted Print Mode, Part 2

Audit Trail Report - Formatted Print Mode, Part 3

Audit Trail Report - Hexadecimal Print Mode, Part 1

Audit Trail Report - Hexadecimal Print Mode, Part 2