View source for Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)

<div class="toclimit-3">
==Overview of the journal data sets==
<p>
This topic discusses the journal data sets you can create and use in <var class="product">Model&nbsp;204</var>, how to manage them, and the utilities you can use to report on and analyze the <var class="product">Model&nbsp;204</var> information collected. The system manager can set up the following journal data sets, which are not part of <var class="product">Model&nbsp;204</var> installation.</p>
<p>
The data sets are CCAJRNL, CCAAUDIT, and CCAJLOG. You set each up as:</p>
<ul>
<li>A ddname in z/OS</li>

<li>A FILEDEF in z/VM</li>

<li>A DLBL in z/VSE</li>
</ul>
 
===CCAJRNL===
<p>
The complete repository of <var class="product">Model&nbsp;204</var> system activity and data that would be used in recovery is CCAJRNL. The CCAJRNL file collects all update information used to reconstruct the database during recovery and all other activity history, such as messages and statistics, in an unformatted, therefore unreadable, binary format.</p>
 
===CCAAUDIT and CCAJLOG===
<p>
You can also create a CCAAUDIT and/or a CCAJLOG file to track information. CCAAUDIT and CCAJLOG are comprised of the same <var class="product">Model&nbsp;204</var> audit trail data, however, differently. The activity history or audit trail is comprised of:</p>
<ul>
<li>Important characteristics of a run</li>

<li>All error messages encountered during a run</li>

<li>All communications with the operator's console</li>

<li>Input lines from Online terminals</li>

<li>HLI calls</li>

<li>Utilization statistics</li>

<li>Information specifically directed to the journal/audit trail by users </li>
</ul>
 
====Watching your system in action: CCAAUDIT====
<p>
The CCAAUDIT file, also known as the audit trail, logs information about a <var class="product">Model&nbsp;204</var> run and prints the information in readable format for the terminal screen while processes are running or to paper.</p>
 
====Improving recovery performance: CCAJLOG====
<p>
The CCAJLOG file off loads the audit trail information into itself, so that the CCAJRNL contains only the information required for RESTART recovery. Recovery performance is improved, because the audit trail information does not have to be read and rejected for recovery.</p>

===Version-specific journals===
<p>
Journals created by <var class="product">Model&nbsp;204</var> prior to V7R1.0 cannot by processed in V7R1.0. The reverse is also true: journals created in V7R1.0 cannot be processed by an earlier version of <var class="product">Model&nbsp;204</var>.</p>
 
==Using Model 204 journal files==
<p>
<var class="product">Model&nbsp;204</var> system managers and file managers use the journal files in some of the following ways:</p>
<table>
<tr class="head">
<th>Task </th>
<th>Journal used </th>
<th>Utility/command used</th>
</tr>
 
<tr>
<td>Generate an audit trail that can be viewed during processing </td>
<td>CCAAUDIT</td>
<td>&nbsp;</td>
</tr>
 
<tr>
<td>Generate an audit trail for printing out later </td>
<td nowrap>CCAJRNL, CCAJLOG </td>
<td>Audit204 utility</td>
</tr>
 
<tr>
<td>Regenerate a file to complete media recovery</td>
<td>CCAJRNL <br>(ddname CCAGEN) </td>
<td>REGENERATE command</td>
</tr>
 
<tr>
<td>Recover <var class="product">Model&nbsp;204</var> following a system failure </td>
<td>CCAJRNL <br>(ddname CCARF) </td>
<td>RESTART command</td>
</tr>
 
<tr>
<td>Extract a report </td>
<td>CCAJRNL</td>
<td>UTILJ utility</td>
</tr>
 
<tr>
<td>Performance tuning by analyzing statistics </td>
<td>CCAJRNL</td>
<td>Audit204 utility or site written analysis program</td>
</tr>
</table>
<p>
The <var class="product">Model&nbsp;204</var> system manager is expected to create the CCAJRNL file at their site for recovery purposes. The <var class="product">Model&nbsp;204</var> file manager may be responsible for using the CCAJRNL file to regenerate data files.</p>

==Creating and generating CCAJRNL==
<p>
A journal is generated if: </p>
<ul>
<li>The <var>SYSOPT</var> parameter includes the 128 specification.
<p>
You must set <var>BLKSIZE</var> for CCAJRNL to not less than 6749 on up to 32K. Buffers are written to CCAJRNL either when a transaction is committed or when the buffer fills. Frequent commits may result in many short blocks/buffers being written to CCAJRNL.</p>
</li>

<li>A CCAJRNL is defined with BLKSIZE set to the minimum, 6749, for:
<ul>
<li>z/OS, a DD statement</li>

<li>z/VM, a FILEDEF</li>
</ul></li>
</ul>
<p>
Statistics generated in an audit trail line are presented in [[Using system statistics#User statistics entries (Type 9)|User statistics entries (Type 9)]]. </p>
<p>
The use of CCAJRNL in recovery procedures is explained in [[System and media recovery#Recovery data sets and job control|Recovery data sets and job control]]. </p>
<p>
How to use CCAJRNL to regenerate a data set is discussed
in [[Media recovery]].</p>
<p>
CCAJRNL may take multiple extents and may span multiple volumes, since it is read forward-only. Its size cannot be limited in a way similar to the CHKPOINT data set (see [[Checkpoints: Storing before-images of changed pages#Limiting the size of CHKPOINT|Limiting the size of CHKPOINT]]), because CCAJRNL records all update activity in an Online, which may be required in a subsequent REGENERATE or RESTART process.</p>
 
===CCAJRNL as single data set or stream===
<p>
You can define CCAJRNL as a single data set or as a stream. Using a <var>[[DEFINE STREAM command|DEFINE STREAM]]</var> command, you incorporate multiple journal data sets. </p>
<ul>
<li>For parallel and ring structures, see [[Configuring checkpoint and journal data streams#Example 1: Ring/parallel journal stream|Example 1: Ring/parallel journal stream]].</li>

<li>For GDG structure, see [[Configuring checkpoint and journal data streams#Perpetual journaling for z/OS|Perpetual journaling for z/OS]].  </li>
</ul>
 
==SWITCH STREAM command==
<p>
The <var>[[SWITCH STREAM command|SWITCH STREAM]]</var> command switches a stream to the next member of a parallel, ring, concatenated, or Generation Data Group (GDG) stream. You can issue the <var>SWITCH STREAM</var> command for the following streams: CCAJLOG, CCAJRNL, CHKPOINT, or CHKPNTS. </p>
 
===Using the SWITCH STREAM command===
<p>
When the <var>SWITCH STREAM</var> command is issued, the following messages are produced:</p>
<p class="code">M204.2712: STREAM <i>streamname</i> IS BEING SWITCHED
M204.2712: STREAM <i>streamname</i> SWITCHED VIA COMMAND
</p>
<ul>
<li>When switching a journal stream, CCAJRNL or CCAJLOG, the currently active data set in that stream is closed. The next data set defined to the stream is opened when the next write to that stream is required. </li>

<li>When switching a checkpoint stream, CHKPOINT or CHKPNTS, the currently active data set in that stream is closed after the next record is written to that data set.</li>
</ul>
<p>
If not in an extended quiesce, Rocket Software recommends that you follow a <code>SWITCH STREAM CCAJRNL</code> command with a <var>CHECKPOINT</var> command to ensure that you have a checkpoint in the current journal. </p>
<p>
The <var>SWITCH STREAM command</var> is sometimes useful for CCAJLOG and rarely required for CHKPOINT or CHKPNTS.</p>

===Journal block header information for SWITCH STREAM===
<p>
Some journal analysis utilities require additional journal information at sites that embrace GDG streams and the <var>SWITCH STREAM</var> command as a means to keep their Onlines up for long periods. <var class="product">Model&nbsp;204</var> includes this additional information in the header for each journal block. </p>
<p>
To ensure that the required information is present in the first block of each journal data set created by the <var>SWITCH STREAM</var> command, the header has been expanded. This expansion makes the journal up to 4% larger than in previous releases.</p>
<p class="note"><b>Note:</b> Due to these changes in journal record layouts, CCAJRNL and CHKPOINT/CHKPNT data sets are not compatible with previous releases of <var class="product">Model&nbsp;204</var>.</p>
<p>
For the complete description of the header entry formats in the journal block, see [[Using system statistics#Header entries (Type 0)|Header entries (Type 0)]].</p>
<p>
In pre-7.4.0 versions of Rocket <var class="product">Model&nbsp;204</var>, each Online environment might produce a single merged journal daily. If an Online was bounced during the day, then the various journals for the day were merged into a single daily journal. Usually the daily merged journal contained records from only one run. The single merged journal could be used to automate media recovery, rather than manually assemble the recovery job journal concatenation.</p>
<p>
Using the <var>SWITCH STREAM</var> command, a site can still prepare a daily merged journal. However, when the <var>SWITCH STREAM</var> command is used, each journal merged does not begin with the initialization of the Online. This means that no Type 12 records or M204.0061 initialization messages are included. Although <var class="product">Model&nbsp;204</var> recovery, including media recovery, can successfully process these merged journals, various journal analysis utilities cannot.</p>
 
===Using a SWITCH STREAM CCAJRNL command during extended quiesce===
<p>
In pre-7.1.0 releases, if you used the checkpoint quiesce feature, a switch to the next journal member at checkpoint quiesce could occur only when CCAJRNL was defined as a ring stream.</p>
<p>
However, a switch at checkpoint quiesce may be desirable for all stream configurations of CCAJRNL: ring, parallel, concatenated, and GDG. The switch marks the point where the CCAJRNL data collected thus far is not needed in subsequent <var>REGENERATE</var> processing against files backed up during the quiesce. If file backups or dumps are taken during the checkpoint quiesce, only CCAJRNL data collected after checkpoint quiesce is useful for <var>REGENERATE</var> processing against those files.</p>
<p>
A checkpoint is automatically taken if you issue a <code>SWITCH STREAM CCAJRNL</code> command while you are in extended quiesce, as shown in the following table:</p>
<table>
<caption>SWITCH command within extended quiesce</caption>
 
<tr class="head">
<td>Step </td>
<td>Command issued </td>
<td>Purpose</td>
</tr>
 
<tr>
<td align="right">1 </td>
<td>CHECKPOINT SET EXTENDED QUIESCE </td>
<td>Enables extended quiesce</td>
</tr>
 
<tr>
<td align="right">2 </td>
<td>CHECKPOINT or automated checkpoint</td>
<td>
<p>
The next checkpoint, automated or command initiated, begins the extended quiesce</p>
<p>
When the checkpoint is successful, the extended quiesce is entered. While in extended quiesce, you cannot issue a <var>CHECKPOINT</var> command. However, you can issue a <var>SWITCH STREAM</var> command, such as the following:</p>
</td>
</tr>
 
<tr>
<td align="right">3</td>
<td>SWITCH STREAM CCAJRNL </td>
<td>When the checkpoint is successful, extended quiesce processing can begin for backups, SnapShots, or any activity that does not involve updating.</td>
</tr>
 
<tr>
<td align="right">4</td>
<td nowrap>CHECKPOINT END EXTENDED QUIESCE</td>
<td>Concludes extended quiesce. Should recovery be required due to a failure during extended quiesce, journals created prior to the <var>SWITCH STREAM</var> command will not be required, as the last checkpoint resides in the current CCAJRNL member.</td>
</tr>
</table>
<p>
This automated checkpoint functionality of <var>SWITCH STREAM CCAJRNL</var> applies only during checkpoint quiesce. The automated checkpoint functionality is not supported for CCAJLOG, CHKPOINT, or CHKPNTS.</p>
 
===SWITCH STREAM limitations===
<p>
In order for a stream to be switched, there must be a target data set to switch to. If there is no target data set, the following message is issued:</p>
<p class="code">M204.2712: MEMBER <i>membername</i> IS INELIGIBLE FOR SWITCHING
</p>
<p>
Consider the following example:</p>
<p class="code">DEFINE STREAM CCAJRNL WITH SCOPE=SYSTEM PARALLEL=(JRNL1,JRNL2) MINAVAIL=2
DEFINE DATASET JRNL1  WITH SCOPE=SYSTEM DSN=CCAJRNL.JRNL1 OLD
DEFINE STREAM  JRNL2  WITH SCOPE=SYSTEM GDG=J2 CONTROL=J2CTL
DEFINE DATASET J2     WITH SCOPE=SYSTME DSN=CCAJRNL.GDGBASE.JRNL2 CATALOG -
                      GEN=+1 CYL PRI 500
DEFINE DATASET J2CTL  WITH SCOPE=SYSTEM DSN=CCAJRNL.GDGBASE.JRNL2.CTL OLD
</p>
<p>
Since data set <code>JRNL1</code> has no target data set for a switch, when the <code>JRNL1</code> data set is marked full, the number of available parallel stream members (<var>MINAVAIL</var>) drops to one, since only <code>JRNL2</code> now has space available. Since the number of available members is now less than <var>MINAVAIL</var>, the Online would stop with a "CCAJRNL full" message.</p>
<p>
If before <code>JRNL1</code> fills, a <code>SWITCH STREAM CCAJRNL</code> command were issued, the following messages would be produced:</p>
<p class="code">M204.2712: MEMBER JRNL1 IS INELIGIBLE FOR SWITCHING
M204.2712: STREAM JRNL2 IS BEING SWITCHED
M204.2712: STREAM CCAJRNL - NOT ALL MEMBERS SWITCHED
</p>
<p>
Member <code>JRNL1</code> was not switched. However, if <code>JRNL1</code> has not filled, the parallel stream will remain open because the number of available members (<var>MINAVAIL</var>) is still 2. Stream <code>JRNL2</code> always has a target data set to switch to since it is a GDG. Nevertheless, whenever <code>JRNL1</code> fills, the minimum available members will be less than <var>MINAVAIL</var>, the stream will be closed, and the run will terminate.</p>
<p>
Because stream members are not locked before switch processing, and because all members are not switched at exactly the same time, the number of records in individual data sets of a parallel stream may not be identical. This is of no consequence to recovery or <var>REGENERATE</var>, but should be noted. However, the total number of records in each member is identical. </p>
<p>
Previously, you had to concatenate all journals into one data set or specify a concatenated <code>CCAGEN DD</code> statement.</p>
 
===SWITCH STREAM command for concatenated streams===
<p>
The same limitation exists for the last member in a concatenated stream. Since there is no additional member to switch to, the following message is issued:</p>
<p class="code">M204.2712: STREAM <i>streamname</i> IS INELIGIBLE FOR SWITCHING
</p>
<p>
If all members of a stream are switched, the following message is issued:</p>
<p class="code">M204.2712: STREAM CCAJRNL SWITCHED VIA COMMAND
</p>

===Handling streams without records===
<p>
You cannot switch a stream member that contains no records. So in the previous case, if the first G1 stream member has just become full and the newly opened (second) GDG member contains zero records, then a <code>SWITCH STREAM CCAJRNL</code> command is not processed.</p>
<p>
Since <code>J1</code> is ineligible, and <code>G1</code> (second member) is empty, no switch occurs. The messages issued are:</p>
<p class="code">M204.2712: MEMBER J1 IS INELIGIBLE FOR SWITCHING
M204.2712: MEMBER G1 IS EMPTY AND CANNOT BE SWITCHED
M204.2712: SWITCH WAS UNSUCCESSFUL
</p>
 
===Recovery parameters===
<p>
Use the following recovery parameters when generating a journal:</p>
<table>
<tr class="head">
<th>Parameter </th>
<th>Set </th>
<th>Specifies...</th>
<th>Comments</th>
</tr>
 
<tr>
<td>FRCVOPT </td>
<td>During file creation or with the <var>RESET</var> command </td>
<td>File recovery options</td>
<td>If the file is included in system or media recovery, do not use <code>FRCVOPT=X'04'</code>, which suppresses roll forward logging. </td>
</tr>
 
<tr>
<td>RCVOPT </td>
<td>On the JCL EXEC parameter or on User 0's parameter line </td>
<td>Type of information written to the journal</td>
<td>
<p>
X'08' writes the roll forward information that is required for system and media recovery to CCAJRNL.</p>
<p>
X'09' also causes preimages to be written to the CHKPOINT data set for roll back recovery. Use this setting if you want to enable full recovery.</p>
</td>
</tr>
</table>
 
===Writing error messages to the journal data set===
<p>
You can control which error messages or classes of error messages to store in CCAJRNL, CCAAUDIT, or CCAJLOG using <var>[[MSGCTL command|MSGCTL]]</var> command parameters.</p>
 
===ERRMSGL: Setting the length of saved error messages===
<p>
The <var>[[ERRMSGL parameter|ERRMSGL]]</var> parameter provides the ability to set the number of bytes to use for saved error messages &mdash; messages returned by <var>[[$Errmsg]]</var> and <var>[[$Fsterr]]</var>. You can set <var>ERRMSGL</var> to any value from 80 to 256 &mdash; that length includes a count byte. The value is rounded up to an 8-byte multiple. For example, if you set <code>ERRMSGL=99</code>, it will be rounded to 104, that value is reduced by 1 for the count byte, thus allowing up to 103 characters of an error message to be saved.
</p>
 
====Server size requirements for saved error messages====
<p>
Increasing <var>ERRMSGL</var> increases the requirement of the fixed table size of a server. This may necessitate an increase in you <var>SERVSIZE</var> settings. The size requirement for <var>ERRMSGL</var> is:</p>
<p class="code">3 * (ERRMSGL - 80)
</p>
<p>
For example, increasing <var>ERRMSGL</var> to its maximum of 256 would increase the fixed server requirement by <code>(3 * (256-80) -1)</code>, or 527 bytes. </p>
<p>
For a full update to the <var>SERVSIZE</var> formula, see [[Defining the runtime environment (CCAIN)#Calculating fixed table size|Calculating fixed table size]].</p>
 
==Using the CCAJRNL data set==
<p>
During a production Online run, roll forward recovery information is written to the CCAJRNL data set. Additionally, a substantial amount of unformatted audit trail data is also written. When recovery is required and after roll back recovery has completed, that data set (during recovery its ddname is CCARF) is read and the roll forward information is extracted and used to reapply all committed updates up to the time of the system failure.</p>

<p class="caption" style="width:468px">CCAJRNL collecting all roll forward and audit information</p>
<p class="figure">[[File:SM13ccaprint1_sep05.gif|468px]] </p>

==Performance efficiencies using CCAJRNL==
 
===Choosing whether to define CCAAUDIT===
<p>
<var class="product">Model&nbsp;204</var> operates more efficiently using CCAJRNL without CCAAUDIT, because it is not also generating a separate audit trail. If you need printed information and your site does not maintain CCAAUDIT, you can extract the audit trail from CCAJRNL in a separate step using AUDIT204. </p>
<p>
If you need printed run information immediately upon completion of the job and you also need Roll Forward or Accounting facilities, create both the journal (CCAJRNL) and the audit trail (CCAAUDIT). </p>
<p>
You can use CCAJRNL in place of CCAAUDIT when you do not need audit trail data immediately following run termination.</p>
 
===Allocating multiple journal buffers===
<p>
Setting <var>NJBUFF</var> to a value (<code>NSERVS + NSUBTKS + 1</code>) allocates multiple journal buffers and ensures that a free buffer is always available for the journal. In z/VM, the <var>NJBUFF</var> parameter is stacked in the EXEC that issues all the FILEDEFs.</p>
 
===Using the CCAJLOG data set===
<p>
If you allocate CCAJLOG, the unformatted audit trail data is written to it and only roll forward recovery data is written to CCAJRNL. Reducing the number of records written to CCAJRNL improves recovery performance and also reduces the likelihood of filling CCAJRNL, which would result in run termination.</p>
<ul>
<li>The number of buffers allocated for CCAJLOG is determined by the parameter, <var>[[NLBUFF parameter|NLBUFF]]</var>, which defaults to five. Only full blocks/buffers are written to CCAJLOG.</li>

<li>The size of these buffers is determined by the <var>BLKSIZE</var> parameter defined for the CCAJLOG data set which may be as large as 32K.</li>
</ul>
<p>
You can produce a formatted CCAAUDIT report from CCAJLOG using the AUDIT204 utility. In this case, the CCAJLOG is referenced via the ddname CCAJRNL. </p>

<p class="caption" style="width:466px">CCAJRNL collecting roll forward data; <br/>CCAJLOG collecting audit trail data</p>
<p class="figure">[[File:SM13ccaprint2_sep05.gif|466px]] </p>
 
====Defining the CCAJLOG stream====
<p>
You can define a CCAJLOG using any of the stream definitions: concatenate, parallel, ring, or GDG; see [[DEFINE STREAM command]].</p>

===M204JLOG assembler exit===
<p>
The assembler exit, M204JLOG, can be invoked if linked in. This exit is initiated when a <var>SWITCH</var> command is issued against a CCAJLOG GDG stream. The exit may be any AMODE and need not be reentrant.</p>
 
====Coding considerations====
<p>
On entry, the registers contain:</p>

:R4  = A(GDG LIOD)
:R9  = A(new switch control record) (see CRD dsect)
:R13 = A(OSW save area)
:R14 = return address
:R15 = base address
<p>
<var class="product">Model&nbsp;204</var> expects no output from the exit. All registers must be restored before return. If any <var class="product">Model&nbsp;204</var> data structures are modified by the exit, unpredictable results may occur.</p>
<blockquote class="note">
<p><b>Note:</b> If the user exit abends, <var class="product">Model&nbsp;204</var> issues an error and produces a snap. This leaves <var class="product">Model&nbsp;204</var> waiting for the switch to complete. At that point the switch will never complete, no further Online activity is possible, and the Online must be cancelled.</p>
<p>
In addition, while the M204JLOG user exit is running, <var class="product">Model&nbsp;204</var> cannot continue normal processing until a return from the exit is accomplished. For this reason, WAITs and I/Os inside the exit are strongly discouraged.</p>
</blockquote>
 
====Sample M204JLOG Assembler exit====
<p class="code">M204JLOG  CSECT
M204JLOG  AMODE 31
M204JLOG  TITLE 'TEST THE MODEL 204 CCAJLOG USER EXIT'
X10       EQU    10
X11       EQU    11
X12       EQU    12
X13       EQU    13
X14       EQU    14
X15       EQU    15
         STM   X14,X12,12(X13)    SAVE CALLERS REGISTERS
         LR    X12,X15            ESTABLISH BASE REGISTER
        USING  M204JLOG,X12
         LA    X10,SAVEAREA       GET A(LOCAL REGISTER SAVEAREA)
         ST    X10,8(,X13)        CHAIN OUR SAVEAREA TO CALLERS
         ST    X13,SAVEAREA+4     CHAIN CALLERS SAVEAREA TO OURS
         LA    X13,SAVEAREA       SET A(OUR SAVEAREA)
         WTO   'M204JLOG EXIT INVOKED, DOING SOMETHING'
<b></b>* ******************************************************************* *
<b></b>* * CUSTOMERS MAY PLACE CODE HERE TO DO WHATEVER THEY DESIRE.       * *
<b></b>* ******************************************************************* *
         WTO   'M204JLOG EXIT ENDING'
         L     X13,4(,X13)        RESTORE CALLERS SAVEAREA ADDRESS
         ST    X10,16(X13)        SET RETURN CODE (R15)
         LM    X14,X12,12(X13)    RESTORE CALLERS REGISTERS
         BR    X14                RETURN TO CALLER
         DS    0D
SAVEAREA DS    18F                REGISTER SAVE AREA
        LTORG
         END
</p>
 
===Model 204 roll forward recovery with CCAJLOG===
<p>
<var class="product">Model&nbsp;204</var> operates more efficiently during roll forward recovery, if you have defined CCAJLOG. This is because CCAJRNL now contains only roll forward recovery data; CCAJLOG contains unformatted CCAAUDIT data, which does not have to be read and ignored during the roll forward recovery since it has been removed from CCAJRNL.</p>
 
===Separating transaction (CCAJRNL) and auditing (CCAJLOG) information===
<p>
Splitting audit trail records &mdash; messages and statistics &mdash; out from CCAJRNL and writing them to CCAJLOG improves recovery performance by reducing the size of CCAJRNL. This also reduces the likelihood of filling CCAJRNL. However, it does shift the possibility to CCAJLOG and if either CCAJRNL or CCAJLOG fills, the run comes down.</p>
 
===Regenerating files using CCAJRNL and CCAJLOG===
<p>
Sending audit trail data to CCAJLOG also speeds up the <var>REGENERATE</var> processing, if that is required.</p>
 
===Considerations for CCAJLOG===
<p>
By specifying CCAJLOG in the JCL or dynamically at the start of CCAIN, all messages and statistics are written to CCAJLOG. All recovery-type records are written to CCAJRNL. </p>
<ul>
<li>If you do not specify CCAJLOG, a CCAJRNL is maintained that collects recovery records, messages, and statistics. </li>

<li>If CCAJLOG is specified but the open fails, the run terminates initialization.</li>

<li>If CCAJLOG fills during a run, the run is terminated.</li>
</ul>
<p>
Set the <var>[[NLBUFF parameter|NLBUFF]]</var> parameter to specify the number of buffers to use for CCAJLOG. If you do not specify a value for <var>NLBUFF</var>, a default value of five is allocated. </p>
 
===Using the journals correctly===
<p>
If you create both a CCAJRNL file and a CCAJLOG file, you must use the CCAJLOG file as input to AUDIT204. And, you must continue to use the CCAJRNL file as input to <var>REGEN</var> and <var>RESTART</var> commands; otherwise, <var class="product">Model&nbsp;204</var> issues one of the following messages:</p>
<p class="code">M204:2515: CCAJRNL DATASET IS INVALID FOR AUDIT 204 
M204:2515: CCAJLOG DATASET IS INVALID FOR {REGEN | RESTART}
</p>
<p>
If you create both a CCAJLOG and CCAJRNL and you use the CCAJRNL as input to AUDIT204, AUDIT204 issues the following message and stops processing:</p>
<p class="code">NON-MESSAGE DATASET IS INVALID FOR CCAJRNL
</p>
<p>
Although UTILJ can handle a CCAJLOG data set, the utility will, of course, find only message and statistics type records in CCAJLOG. So, if you ask for recovery journal entries, type 1-6, the output is empty, since they do not exist on the CCAJLOG.</p>
<p>
Because audit trail information is stored in CCAJLOG, if you have written a custom application for statistics reports, use CCAJLOG for input.</p>
 
==CCAJRNL data set record layout==
<p>
The journal data set is composed of variable length records. Each record consists of a header, one or more journal entries, and a trailer. The format of the journal data set is subject to change with each release of <var class="product">Model&nbsp;204</var>.    </p>
 
===Journal entry format===
<p>
Journal entries contain audit trail, statistical, and control information, or information used for recovery. Statistics are recorded in the journal as fullword hexadecimal counters. Space is allocated in a given journal statistics entry for all possible statistics, even if they are not being kept. The values for statistics that are not maintained, or do not have relevance to the current configuration of <var class="product">Model&nbsp;204</var>, are represented as hexadecimal zeros.</p>
<p>
Each entry has the same general format: </p>
<table>
<tr class="head">
<th>Bytes</th>
<th>Contents</th>
</tr>
 
<tr>
<td align="right"> 0-1</td>
<td>Length</td>
</tr>
 
<tr>
<td align="right"> 2</td>
<td>Entry type</td>
</tr>
 
<tr>
<td> 3-n</td>
<td>Data</td>
</tr>
</table>
<p>
Offset 0 is a 2-byte hexadecimal field containing the length of the entry. (The only exception to this rule is the header entry, where the length is the length of the entire journal block.)</p>
<p>
Offset 2 is a 1-byte field, which identifies the type of the entry: file, system, or user.</p>
<p>
Offset 3 is a variable-length data portion. The size and layout depends upon the type of entry.</p>
<p>
The following table summarizes the journal entry types, including formatting layouts and statistical information. Use the layout and statistics tables in [[Using system statistics]] for developing customized software to extract particular information from the journal data set. </p>
<table>
<caption>Summary of journal entry types</caption>
<tr class="head">
<th>Type</th>
<th>Journal record</th>
</tr>
 
<tr>
<td align="right"> X'00' </td>
<td>Header/Trailer</td>
</tr>
 
<tr>
<td align="right"> X'01' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'02' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'03' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'04' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'05' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'06' </td>
<td>Recovery entry</td>
</tr>
 
<tr>
<td align="right"> X'07' </td>
<td>Unused</td>
</tr>
 
<tr>
<td align="right"> X'08' </td>
<td>System statistics</td>
</tr>
 
<tr>
<td align="right"> X'09' </td>
<td>User statistics</td>
</tr>
 
<tr>
<td align="right"> X'0A' </td>
<td>File statistics</td>
</tr>
 
<tr>
<td align="right"> X'0B' </td>
<td>Discontinued audit trail text</td>
</tr>
 
<tr>
<td align="right"> X'0C' </td>
<td>Initialization entry</td>
</tr>
 
<tr>
<td align="right"> X'0D' </td>
<td>Possibly continued audit trail text</td>
</tr>
 
<tr>
<td align="right"> X'0E' </td>
<td>Timestamp</td>
</tr>
 
<tr>
<td align="right"> X'0F' </td>
<td>Merged journal brackets</td>
</tr>
</table>
 
===Number of lines in the journal data set===
<p>
The number of lines in the journal are controlled by the <var>CAUDIT</var>, <var>LAUDIT</var>, and <var>SYSOPT</var> parameters.  </p>
 
====CAUDIT parameter====
<p>
The <var>[[CAUDIT parameter|CAUDIT]]</var> parameter controls physical input lines from a terminal, procedure, some IFAM arguments, or full-screen input. <var>CAUDIT</var> operates at physical line (card) level. It controls the auditing of input lines after line editing has been performed, but before line continuation is interpreted. </p>
<p>
<var>CAUDIT</var> is set on any user parameter line at the beginning of CCAIN, and can be reset by a user with system manager privileges who logs in with that user number. (<var>CAUDIT</var> is generally used only by Technical Support staff in special instances.)</p>
 
====LAUDIT parameter====
<p>
The <var>[[LAUDIT parameter|LAUDIT]]</var> parameter controls logical input lines from a terminal or procedure, some IFAM arguments, and full screen information. <var>LAUDIT</var> is useful in reconstructing events that lead to a system crash. </p>
<p>
Set <var>LAUDIT</var> on any user parameter (<var>IODEV</var>) line or at the beginning of CCAIN. For example:</p>
<p class="code">PAGESZ=6184,NUSERS=1,NSERVS=1,NFILES=20,
LENQTBL=15,LAUDIT=5, ...
</p>
<p>
<var>LAUDIT</var> can be reset by a user with system manager privileges who logs in with that user number.
</p>
 
====SYSOPT parameter====
<p>
The <var>[[SYSOPT parameter|SYSOPT]]</var> 32 option controls output of information that relates to system initialization or to an IFAM function call.
</p>
 
===Sizing the journal buffer===
<p>
In z/OS and z/VM only, you can specify the <var>NJBUFF</var> parameter on the EXEC statement to make journal entries of one user without interrupting other current users. Valid settings are the default <code>NJBUFF=1</code> or, to ensure the availability of a free buffer:</p>
<p class="code">NJBUFF = NSERVS + NSUBTKS + 1
</p>
<p>
In z/OS only, if the setting of the NJBUFF parameter is greater than 1, the setting is automatically recalculated using the previous formula and the initial value of <var>NJBUFF</var> is used to define the number of concurrent I/O operations (NCP) for the journal data set. Sizing <var>NJBUFF</var> to the value calculated in the formula guarantees the optimal number of Network Control Programs (NCP) for the journal data set.</p>
<p>
If you use the <var>NJBUFF</var> option, specify <code>BLKSIZE=6749</code> as the minimum journal buffer size to allow a full page to be written to a single journal buffer. The contents of a buffer are automatically written to CCAJRNL before the buffer is completely full.</p>
<p>
Messages giving the number of journal buffers and the number of bytes allocated to the buffers are displayed at the end of the run.</p>
 
===Managing space requirements for all operating systems===
<p>
The space requirement for CCAJRNL is reduced, if CCAJLOG is enabled. However, CCAJRNL must still be sized to prevent B37, D37, or E37 abends, which will terminate the run and require recovery to get files to a state of logical and physical consistency. The same applies to CCAJLOG: If it fills, the run terminates and recovery is required. Generous secondary extents allocated to these data set also help avoid overflow problems.</p>
 
====Additional managing space requirement on z/OS====
<p>
At a z/OS site, the most comprehensive way to avoid data set full problems is to define both CCAJRNL and CCAJOG as generation data groups (GDGs). See [[Configuring checkpoint and journal data streams#Perpetual journaling for z/OS|Perpetual journaling for z/OS]].</p>
 
==Model 204 statistics==
<p>
A statistic is written to CCAAUDIT only if its value is nonzero. However, all statistics, even those with zero values, are written to CCAJRNL (or CCAJLOG). </p>
 
===Audit trail and journal statistics lines===
<p>
The statistics generated on audit trail lines are valuable in a study of the performance of an individual user or of the <var class="product">Model&nbsp;204</var> system as a whole. The effect of configuration changes within <var class="product">Model&nbsp;204</var> and with other jobs in the operating system can be determined by comparing statistics gathered in <var class="product">Model&nbsp;204</var> runs.</p>
<ul>
<li>Statistics described as percentages are multiplied by 10 (a value printed as 1000 represents 100 percent). </li>

<li>Statistics described as averages are multiplied by 1000 (1000 represents 1.000).</li>
</ul>
 
===Output lines===
<p>
Statistics for each user and file active during a particular run are written to the journal and audit trail files in output lines that begin with <code>ST $$$</code>. The output lines are written in groups of related lines that include: </p>
<ul>
<li>User lines, which you can monitor to identify active users and to help determine if individual applications are efficiently implemented</li>

<li>File lines</li>

<li>System lines, which you can watch &mdash; together with file lines &mdash; to signal shifting loads on the CPU, disks, and terminals </li>
</ul>
<p>
The type of line written &mdash; user, file, or system &mdash; is specified by the value of the first parameter after the journal header.</p>
 
===Identifying subtypes===
<p>
The subtype &mdash; final, partial, performance, or since-last &mdash; within each type is specified by the value of the second parameter after the journal header. In the audit trail, the subtype is indicated by <code>USERID=<i>user-id</i></code> (user statistics), <code>FILE=<i>filename</i></code> (file statistics), and <code>SYSTEM=<i>Model-204-version</i></code> (system statistics). </p>
<p>
Within each major type of statistics line, subtypes are produced under specified conditions: some are always produced, others are optional. Optional subtypes are produced if the appropriate parameters are set during system initialization. See [[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#Setting the NSUBTKS parameter|Setting the NSUBTKS parameter]]. </p>
 
==Monitoring statistics==
<p>
The <var class="product">Model&nbsp;204</var> statistics that you can monitor are introduced in [[Using system statistics]]. The statistics are presented in alphabetical order with their stated purpose, followed by tables that identify their position in various layouts.</p>
<p>
You can monitor statistics using one or more of the following methods:     </p>
<ul>
<li>Print out the audit trail. </li>

<li>View formatted or unformatted displays of all nonzero cumulative statistics for active users &mdash; individual, specified groups, and all users &mdash; and system activities.</li>

<li>Use the AUDIT204 or UTILJ utility program to extract and summarize statistics lines from the journal data set. See [[#AUDIT204 utility|the AUDIT204 utility]] and [[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]
</li>

<li>Write optional records to the System Management Facilities (SMF) data set; see [[Using system statistics#System Management Facilities|System Management Facilities]]. </li>
</ul>
 
===Setting the NSUBTKS parameter===
<p>
Gathering partial or performance statistics lines requires a <var class="product">Model&nbsp;204</var> pseudo subtask. <var class="product">Model&nbsp;204</var> uses pseudo subtasks to perform actions that must be done regularly but that cannot be assigned to a specific user. To accommodate partial and performance statistics lines you might need to increase the <var>NSUBTKS</var> parameter on User 0's parameter line, which controls the maximum number of [[Controlling system operations (CCAIN)#Pseudo subtasks|pseudo subtasks]] that can be allocated. </p>
 
===Setting parameters to collect certain statistics===
<p>
You must set various parameters to collect certain statistics. The following table lists the statistics and the corresponding parameter(s):</p>
<table>
<caption>Parameters to set to collect certain statistics</caption>
<tr class="head">
<th>Statistic </th>
<th>Parameter to set to nonzero</th>
</tr>
 
<tr>
<td>BLKCFRE </td>
<td>CFRJRNL and CFRLOOK</td>
</tr>
 
<tr>
<td>BLKI</td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>BLKO</td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>BLKRLK </td>
<td>CFRJRNL and CFRLOOK</td>
</tr>
 
<tr>
<td>LONGUPDTIME(MS)</td>
<td>MAXUD</td>
</tr>
 
<tr>
<td>LONGUPDTS</td>
<td>MAXUD</td>
</tr>
 
<tr>
<td>PNDGTIME</td>
<td>DKUPDTWT</td>
</tr>
 
<tr>
<td>REDY </td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>RUNG </td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>SMPLS</td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>SWPG</td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>USRS</td>
<td>RPTCNT and SMPLTIM</td>
</tr>
 
<tr>
<td>WTCFR </td>
<td>CFRJRNL and CFRLOOK</td>
</tr>
 
<tr>
<td>WTRLK </td>
<td>CFRJRNL and CFRLOOK</td>
</tr>
 
<tr>
<td>WTSV </td>
<td>RPTCNT and SMPLTIM</td>
</tr>
</table>
 
==Audit trail format==
<p>
Whether printed to your terminal from CCAAUDIT or CCAJRNL (or CCAJLOG) is processed by AUDIT204, the format of an audit trail line is:</p>
 
<p class="syntax"><span class="term">yydddhhmmss nnn sss xxxxx tt (...) audit-trail-text</span>
</p>
 
Where:
<ul>
<li><var class="term">yyddd</var> is  the Julian year and day.</li>

<li><var class="term">hhmmss</var> is the time of day in hours, minutes, and seconds.</li>

<li><var class="term">nnn</var> is a counter to distinguish lines produced in the same second.
</li>

<li><var class="term">sss</var> is the number of the server currently handling the user. (Leading zeros are suppressed.)</li>

<li><var class="term">xxxxx</var> is the 5-digit number of the user associated with the audit trail line. (Leading zeros are suppressed.)</li>

<li><var class="term">tt</var> is code for the type of audit trail line. The tt codes are shown in the
"Types of audit trail lines" table, below.</li>
</ul>
 
====Example====
<p class="code">05263092241 10 0 1 AD...M204.0763: BEGIN FILE INITIALIZATION:
</p>
<p>
The following table lists the code and purpose of the audit trail lines:</p>
<table>
<caption>Types of audit trail lines</caption>
<tr class="head">
<th>Code</th>
<th>Displays...</th>
</tr>
 
<tr>
<td>AD</td>
<td>Special information about the run, job step return code, status of <var class="product">Model&nbsp;204</var> files, user or the password table, the SNA Communications Server (formerly VTAM) Interface, or messages sent from an HLI program via the IFERR call.</td>
</tr>
 
<tr>
<td>CI</td>
<td>Physical input line from a user's terminal or some IFAM arguments.</td>
</tr>
 
<tr>
<td>CP</td>
<td>Physical input line from a procedure.</td>
</tr>
 
<tr>
<td>CS</td>
<td>Physical line of full-screen input (see LS below).</td>
</tr>
 
<tr>
<td>ER</td>
<td>Error message sent to the user.</td>
</tr>
 
<tr>
<td>LI</td>
<td>Logical input line from a user's terminal or some HLI arguments.</td>
</tr>
 
<tr>
<td>LP</td>
<td>Logical input line from a procedure.</td>
</tr>
 
<tr>
<td>LR</td>
<td>Read images from a terminal.</td>
</tr>
 
<tr>
<td>LS</td>
<td>Full-screen information. For a screen, each line lists one input value. For a menu, the line provides the menu selection number.</td>
</tr>
 
<tr>
<td>MS</td>
<td>Informational message sent to the user (not an error).</td>
</tr>
 
<tr>
<td>OI</td>
<td>Input line from the operator's console.</td>
</tr>
 
<tr>
<td>OO</td>
<td>Message sent to the operator's console.</td>
</tr>
 
<tr>
<td>RK</td>
<td>Special information that relates to system initialization or to the record of a call to the following types of function:
<ul>
<li>Connect<sup>&#9733;</sup></li>

<li>HLI</li>

<li>MQ/204</li>

<li>PQO</li>

<li>SQL</li>

<li>UL/DB2</li>
</ul>
</td></tr>
 
<tr>
<td>QT</td>
<td>Lines of SQL statement level processing </td>
</tr>
 
<tr>
<td>ST</td>
<td>Utilization statistics (see [[Using system statistics]]).</td>
</tr>
 
<tr>
<td>US</td>
<td>Line of special information directed to the audit trail by means of the SOUL <var>Audit</var> statement.</td>
</tr>
 
<tr>
<td>XX</td>
<td>Continuation of the previous line.</td>
</tr>
</table>

==Generating an audit trail==
 
===Overview of audit trail parameters===
<p>
An audit trail is generated if:   </p>
<ul>
<li>The <var>SYSOPT</var> parameter includes the 128 specification</li>

<li>CCAAUDIT DD statement</li>
</ul>
<p>
The <var>[[LAUDPROC parameter|LAUDPROC]]</var> parameter controls the length of procedure names that appear in since-last statistic lines of the audit trail. You can reset <var>LAUDPROC</var> to a low or high value. A low value conserves memory. A high value captures long procedure names. </p>
 
===z/VSE and the audit trail===
<p>
In a z/VSE environment, activate the audit trail by incorporating the following specifications into the JCL:</p>
<ul>
<li>You must set UPSI to <code>1xxxxxxx</code> (<code>SYSOPT=128</code>).</li>

<li>You must write the audit trail file to either a disk device or a print device:
<ul>
<li>Assign a disk device using a DLBL and EXTENT statement for file name <code>CCAUDIT</code> (retention 0 is recommended).</li>

<li>Assign a print device using symbolic unit <code>SYS008</code>. (You cannot assign <code>SYS008</code> to the same physical device as SYSLST.)
<p>
If the DLBL and EXTENT for CCAUDIT are provided in the JCL, the audit trail is written to disk regardless of the assignment of <code>SYS008</code>.</p></li>
</ul></li>
</ul>
<p>
The following example shows a job stream for an <var>ONLINE</var> configuration with the audit trail on disk:</p>
<p class="code">// JOB ONLINE
...
// DLBL CCAUDIT,'audit trail file-id',0
// EXTENT SYSnnn,balance of extent information
// ASSGN SYSnnn,X'cuu'
...
// UPSI 10000000
// EXEC ONLINE, SIZE=AUTO
...
/&amp;
</p>
<p>
After the audit trail has been written to disk, you can print it using the UTLA utility program supplied with the <var class="product">Model&nbsp;204</var> DBMS.</p>
<p>
Use the following JCL:</p>
<p class="code">// JOB UTLA PRINT MODEL 204 AUDIT TRAIL
// DLBL M204LIB,'M204.PROD.LIBRARY'
// EXTENT SYSnnn,...
// LIBDEF PHASE.SEARCH=M204LIB.V411
// DLBL CCAUDIT,'audit trail file-id'
// EXTENT SYSnnn,balance of extent information
// ASSGN SYSnnn,X'cuu'
// ASSGN SYS005,SYSLST
// EXEC UTLA,SIZE=AUTO
/&amp;
</p>
 
===z/VM and the audit trail===
<p>
In the z/VM/CMS environment, define CCAAUDIT as one of the following:</p>
<ul>
<li>CMS file:
<p class="code">FILEDEF CCAAUDIT DISK ONLN CCAAUDIT A</p></li>

<li>Service machine virtual printer:
<p class="code">FILEDEF CCAAUDIT PRINTER</p></li>
</ul>
 
==AUDIT204 utility==
<p>
The AUDIT204 utility program produces the following reports, all of which are written to CCAAUDIT:</p>
<ul>
<li>Complete or partial audit trail from a journal &mdash; CCAJRNL or CCAJLOG, as ddname CCAJRNL &mdash; produced by a <var class="product">Model&nbsp;204</var> run</li>

<li>Report based on statistics that appear on user logout and partial lines or file closed and partial lines</li>

<li>Statistical analysis of the evaluation of SOUL requests </li>
</ul>
<p>
The format of AUDIT204 reports is determined by AUDIT204 commands and parameters you enter in:</p>
<ul>
<li>z/OS CCAIN data stream</li>

<li>z/VM (CMS) AUDIT204 CCAIN file</li>

<li>DOS SYSIPT statement</li>
</ul>
<p>
The basic AUDIT204 input commands are:</p>
<table>
<tr class="head">
<th>AUDIT204 command </th>
<th>For... </th>
</tr>
 
<tr>
<td>ANALYZE </td>
<td>Statistical analysis of the evaluation of User Language requests </td>
</tr>
 
<tr>
<td>FORMAT </td>
<td>Printed audit trail</td>
</tr>
 
<tr>
<td>REPORT </td>
<td>Breakdown of user and file statistics lines containing optional price calculations</td>
</tr>
</table>
 
===Input to AUDIT204===
<p>
Input to AUDIT204 is free form, located in columns 1-71. The following rules apply:</p>
<ul>

<li>The command line may have one parameter and its subparameters.</li>

<li>Type each subsequent parameter on a separate line.</li>

<ul>
<li>Use blanks to separate subparameters.</li>
</ul>

<li>You can type parameters for a single command in any order.</li>

<li>You can add subparameters for some parameters (PRICE and RENAME) by naming the subparameters in the form of character strings:
<ul>
<li>If a name contains a blank or a single quotation mark, you must enclose the name in single quotation marks.</li>

<li>Use double quotation marks within the name.</li>

<li>Use blanks around the equal signs in the PRICE and RENAME parameters.</li>

<li>Use blanks to separate subparameters.</li>

<li>If more than one line is required for the subparameters, place a nonblank character in column 72 or repeat the parameter on a new line. </li>
</ul></li>

<li>Any characters appearing in columns 73-80 are ignored. </li>

<li>You can repeat any parameter. </li>

<li>Precede each comment by an asterisk (<tt>*</tt>) in column 1.</li>

<li>The effect of parameters containing lists of subparameters is cumulative. </li>

<li>The last value of parameters without subparameter lists is the value used. </li>
</ul>

===ANALYZE command===
<p>
The <var>ANALYZE</var> command produces a statistical analysis report on the evaluation of SOUL requests. The complete report comprises an analysis for each individual account and the system as a whole. </p>
<p>
Since-last evaluation lines calculate the mean and standard deviation for each since-last statistic:</p>
<table>
<tr class="head">
<th>Measure </th>
<th>Represents... </th>
</tr>
 
<tr>
<td>Mean </td>
<td>Center of a set of data points (usually referred to as the average value of the set), obtained by summing the values and dividing by the number of values.</td>
</tr>
 
<tr>
<td nowrap>Standard deviation </td>
<td>How spread out the data is around the center. In particular, it is useful to know whether the data is tightly clustered around the mean, or more dispersed. 
<p>
A small standard deviation indicates that any given value is likely to be close to the mean, and a large standard deviation implies that a value is more likely to be far away from the mean. </p>
</td>
</tr>
</table>
<p>
You can obtain more information about the mean and the standard deviation from any standard statistics textbook.</p>
 
====Syntax====
<p>
Use the following syntax for the <var>ANALYZE</var> command:</p>
<p class="syntax">ANALYZE [USERID | NOUSERID] [USERIDS <span class="term">userid1...useridn</span>]
</p>
<p>
or</p>
<p class="syntax">ANALYZE [ACCOUNT | NOACCOUNT] [ACCOUNTS <span class="term">account1...accountn</span>] 
        [<span class="term">parameters</span>]
</p>
 
Where:
<p>
Use the following parameters with the <var>ANALYZE</var> command:</p>
<table>
<tr class="head">
<th>Parameter </th>
<th>Specifies...</th>
</tr>
 
<tr>
<td><var>ACCOUNT</var>
or <var>NOACCOUNT</var></td>
<td>Whether or not to do an individual account analysis. The <var>ACCT</var> or <var>NOACCT</var> parameters are equivalent to <var>ACCOUNT</var> or <var>NOACCOUNT</var>, respectively. </td>
</tr>
 
<tr>
<td><var>ACCOUNTS</var> </td>
<td>Login account name(s) to list in the analysis report. 
<p>
Reports are produced only for the specified accounts and only the since-last evaluation lines for those accounts that are included in the systemwide report.</p>
<p>
Specifying <var>ACCOUNTS</var> sets the <var>ACCOUNT</var> parameter when neither <var>ACCOUNT</var> nor <var>NOACCOUNT</var> was specified.</p>
</td>
</tr>
 
<tr>
<td><var>OMIT <i>name1 name2</i>...</var> </td>
<td>Since-last statistic(s) to list, but omit from the analysis report. The report contains all since-last statistics that are not explicitly omitted.  Specifying file or user statistics will generate an error message and terminate the ANALYZE.</td>
</tr>
 
<tr>
<td nowrap><var>RENAME <i>name</i>=<i>newname</i></var> </td>
<td>New names to since-last statistics as column headings for an analysis report.</td>
</tr>
 
<tr>
<td><var>TIME [<i>yydddhhmmss</i> | <i>yydddhhmmss</i> | <i>cyydddhhmmss</i> | <i>cyyddhhmmss</i>]</var></td>
<td>Time range from which since-last evaluation lines are taken.</td>
</tr>
 
<tr>
<td><var>SYS</var> (the default)
<br>or <var>NOSYS</var> </td>
<td>Whether or not to do a systemwide analysis using since-last evaluation lines of accounts for which an individual analysis is done. </td>
</tr>
 
<tr>
<td><var>USERID</var> (the default)
<br>or <var>NOUSERID</var> </td>
<td>Performing or suppressing an individual user ID analysis. Totals for a systemwide analysis are still accumulated if <var>NOUSERID</var> is specified.</td>
</tr>
 
<tr>
<td><var>USERIDS</var> </td>
<td>User(s) for which analysis is requested.
<p>
The <var>USERIDS</var> keyword is required in addition to the <var>USERID</var> keyword. If neither <var>USERID</var> nor <var>NOUSERID</var> has been specified, specifying <var>USERIDS</var> sets the <var>USERID</var> parameter.</p>
<p>
Reports are produced only for the specified users and only the since-last evaluation lines for those users who are included in the systemwide report. </p>
<p>
AUDIT204 uses the values specified in the <var>USERID</var> parameter as a pattern and finds all values that match. For example, <code>USERIDS NANCY KATHY</code> is equivalent to <code>REPORT USERID USERIDS NANCY* KATHY*</code>.</p></td></tr>
</table>

===FORMAT command===
<p>
<var>FORMAT</var> prints an audit trail (CCAAUDIT) from CCAJRNL or CCAJLOG. </p>
 
====Syntax====
<p class="syntax">FORMAT TIME {<span class="term">yydddhhmmss/yydddhhmmss</span> | <span class="term">cyydddhhmmss/cyydddhhmmss</span>}
       TIMEHH 
       TYPE <span class="term">type1</span>
       USER <span class="term">usernum</span>
       USERID <span class="term">userid</span>
       YEARFORM {2 | 4}
</p>
 
Where:
<p>
You use the following parameters with the <var>FORMAT</var> command:</p>
<table>
<tr class="head">
<th>Parameter </th>
<th>Specifies...</th>
</tr>
 
<tr>
<td><var>TIME</var> </td>
<td>Time range to print. The format of the time specification corresponds to the time stamp printed with each audit trail line.
<p>
You can specify start and end times in either order. If either time is out of the range covered by the journal, it is corrected to match the actual start or end of the journal. </p>
<p>
If both specified times are before and after the period covered by the journal, nothing is printed.</p>
<ul>
<li><var class="term">yyddd</var> is the year and Julian date; <var class="term">cyyddd</var> is the century, year and Julian date (0=20th century, 1=21st century).</li>

<li><var class="term">hhmmss</var> is time based on a 24-hour clock. </li>
</ul>
<p><b>NOTE:</b> TIME may be specified with no time range or with a time range in the form noted above.  No time range selects the entire journal/jlog for printing.</p> 
</td></tr>

<tr>
<td><var>TIMEHH</var> </td>
<td>Indicates that timestamps, printed at the beginning of each line of output, should include hundredths of a second.  Requires no other arguments.  
<p><b>NOTE:</b> This parameter and the 78 version of AUDIT204 may be used against a 77 or 78 CCAJRNL or CCAJLOG.</p>
<p><b>NOTE:</b> TIMEHH may be specified with no time range or with a time range in the form noted above.  No time range selects the entire journal/jlog for printing.</p>  
</td>
</tr>

<tr>
<td><var>TYPE</var> </td>
<td>Type of lines to print, such as AD or MS (see the [[#Example|"Types of audit trail lines" table]]).</td>
</tr>
 
<tr>
<td><var>USER</var> </td>
<td>User for whom the printed audit trail lines are generated. Specify user numbers with or without leading zeros. </td>
</tr>
 
<tr>
<td><var>USERID</var> </td>
<td>One- to ten-character name that identifies the <var class="product">Model&nbsp;204</var> user about whom the printed audit trail lines are generated.</td>
</tr>
 
<tr>
<td><var>YEARFORM</var></td>
<td>Two- or four-digit year output. The default is 2.</td>
</tr>
</table>

====Example====
<p>
The options specified in the following example restrict the printing of the audit trail to <code>MS</code> (message) lines for <code>USER 01</code> created on September 22, 1998 between 10:41 A.M. and 10:45 A.M.:</p>
<p class="code">FORMAT TYPE MS, ER
TIME 98265104100/98265104500
USER 01
</p>
 
====Usage====
<p>
The <var>FORMAT</var> command can be used against a CCAJRNL or CCAJLOG data set. Examine the code examples that begin in [[#Samples of a z/OS job stream|Samples of a z/OS job stream]]. </p>

===REPORT command===
<p>
The <var>REPORT</var> command prints user and file statistics in a tabular format and computes costs by account or by file for billing purposes. AUDIT204 reports have a two-line header, as shown in the following example, that reflect the circumstances of your site.    </p>
<p class="code">AUDIT204 UTILITY - VERSION 7.6.0D
DATE/TIME OF RUN: 10/11/2016 12:25:50
</p>
 
====Syntax====
<p class="syntax">REPORT <span class="term">type</span> [<span class="term">parameters</span>]
</p>
 
Where:
<ul>
<li><var class="term">type</var> is a subcommand that specifies the type of report to print:
<table>
<tr class="head">
<th>Subcommand </th>
<th>Specifies printing a report from...</th>
</tr>
 
<tr>
<td><var>ACCOUNT</var> </td>
<td>User statistics lines for specific accounts </td>
</tr>
 
<tr>
<td><var>FILE</var> </td>
<td>File statistics for all files</td>
</tr>

<tr>
<td><var>FILE FILES <i>fname1 fname2</i> ...</var> </td>
<td>File statistics for files listed</td>
</tr>
 
<tr>
<td><var>USERID</var> </td>
<td>User statistics lines for all users</td>
</tr>

<tr>
<td><var>USERID USERIDS <i>user1 user2</i> ...</var> </td>
<td>User statistics lines for users listed</td>
</tr>
</table></li>

<li><var class="term">parameters</var> is one or  more of 
the following, which can be used with <var>USERID</var>, <var>ACCOUNT</var>, or <var>FILE</var>:
<table>
<tr class="head">
<th>Parameter </th>
<th>Specifies...</th>
</tr>
 
<tr>
<td><var>IND</var> (the default)
<br>or <var>NOIND</var> </td>
<td>Printing or not printing individual lines. Totals are still accumulated if <var>NOIND</var> is specified.</td>
</tr>
 
<tr>
<td><var>OMIT</var> </td>
<td>Statistic(s) to omit from the report. You must enter the actual name of the statistic, not what appears in a column header in a report. See [[Using system statistics#Description of statistics|Description of statistics]] for an alphabetical listing of statistics.</td>
</tr>
 
<tr>
<td><var>PARTIAL</var>
<br>or <var>NOPARTIAL</var> </td>
<td>Generation of partial or complete statistics lines. Use:
<ul>
<li><var>PARTIAL</var> when a report is generated from a journal that did not terminate successfully.</li>

<li><var>NOPARTIAL</var> to avoid processing overhead, when a complete journal is available.</li>
</ul>
</td></tr>
 
<tr>
<td><var>PRICE</var> </td>
<td>Dollar charge up to five decimal places to any statistic. Decimal point, and leading and trailing zeros are optional. For example:
<p class="code">PRICE CPU=0.05 DKRD=.03 DKWR=.035</p>
</td></tr>
 
<tr>
<td><var>RENAME</var> </td>
<td>Column heading names up to nine characters without truncation. The new name completely replaces the old name and must be used if name is specified on other parameters.</td></tr>
 
<tr>
<td><var>TIME</var> </td>
<td>Time range for statistics line reporting. One of the following formats is required:
<ul>
<li><var class="term">yydddhhmmss</var><b><tt>/</tt></b><var class="term">yydddhhmmss</var> </li>

<li><var class="term">cyydddhhmmss</var><b><tt>/</tt></b><var class="term">cyydddhhmmss</var> </li>
</ul>
</td></tr>
 
<tr><td nowrap><var>TOTAL</var> (the default)
<br>or <var>NOTOTAL</var> </td>
<td>Totalling or suppression of totalling for individual statistics and costs. </td>
</tr>
</table></li>
</ul>

====Example====
<p>
Totals are printed after individual statistics lines if both <var>IND</var> and <var>TOTAL</var> are in effect. Each line must contain only one parameter, as in the following examples:</p>
<p class="code">REPORT USERID NOIND
              PARTIAL
              TIME <i>yydddhhmmss/yydddhhmmss</i>
              RENAME <i>name=newname</i>
              NOTOTAL
              USERIDS <i>account</i>
 
REPORT FILE FILES <i>fname1 fname2 fname3 ...</i>
       OMIT <i>statistic</i>
       PRICE <i>statistic=xx.xx</i>
</p>
<p>
The subkeywords <var>ACCOUNTS</var>, <var>FILES</var>, and <var>USERIDS</var> can be used with <var>REPORT</var> subcommands <var>ACCOUNT</var>, <var>FILE</var>, and <var>USERID</var> as in the following examples:</p>
<p class="code">REPORT USERID USERIDS JAMES STEVE SANDRA
       ACCOUNT ACCOUNTS JAMES STEVE SANDRA
       FILE FILES CLIENTS VEHICLES DAILY
</p>
<p class="note"><b>Note:</b> The <var>REPORT</var> command for AUDIT204 can process only a single journal: CCAJRNL. You cannot use against a CCAJOG file.</p>

==Using the AUDIT204 utility==
 
===CCAJRNL and CCAJLOG data sets as input to utilities===
<p>
When you need a CCAAUDIT report, use the CCAJLOG data set as input to the AUDIT204 utility, under the ddname of CCAJRNL. You can also use CCAJLOG as input to the UTILJ utility, again under the ddname of CCAJRNL; however, the only useful report produced is a histogram of the number of blocks and block sizes that were written to the CCAJLOG data set.</p>
<p>
CCAJRNL is the input data set provided to roll forward recovery (ddname=CCARF), media recovery (ddname= CCAGEN), and UTILJ (ddname=CCAJRNL).</p>

<p class="caption" style="width:457px">Utilities using CCAJLOG and CCAJRNL data sets as input</p>
<p class="figure">[[File:SM13ccaprint3_sep.gif|457px]] </p>

===Journal stream configurations===
<p>
AUDIT204 can process only basic journal streams (single data sets). Members of concatenated, parallel, ring, or GDG streams must be processed one at a time.</p>
<p>
If there is a wraparound during the output processing of a ring stream, use the offload stream as input to AUDIT204. You can also use regular z/OS concatenation to print the contents of a concatenated stream.</p>
 
===z/OS JCL for AUDIT204===
<p>
The following considerations apply to z/OS JCL for AUDIT204:</p>
<ul>
<li>Use a SORTLIB DD statement to identify the library in which the sort program is stored, if necessary.</li>

<li>You might need sort work (SORTWKxx) data sets.</li>

<li>SORTIN, SORTOUT, and SYSOUT statements are necessary only for statistical reports. A sort program must be available:
<ul>
<li>SORTIN contains all the user and file statistics entries extracted from the journal. The size of the data set depends on the number of statistics entries extracted. Each user statistics entry is 198 bytes long. Each file entry is 82 bytes long. Partial statistics entries are not copied to SORTIN.</li>

<li>SORTOUT contains the sorted statistics entries from SORTIN. SORTOUT and SORTIN must be the same size.</li>

<li>SYSOUT is the SORT message data set.</li>
</ul></li>

<li>STATIN, STATOUT, and SYSOUT statements are necessary only for statistical analysis reports:
<ul>
<li>STATIN contains all the since-last evaluation statistics entries extracted from the journal. The size of the data set depends on the number of since-last evaluation statistics extracted. Each since-last evaluation statistics entry is 188 bytes long.</li>

<li>STATOUT contains the sorted statistics entries from STATIN. STATOUT and STATIN must be the same size. </li>

<li>Statistics work (STATWKxx) data sets might be needed when using the ANALYZE command, depending on the amount of data generated.</li>
</ul></li>

<li>CCAJRNL describes the data set containing the journal produced by a <var class="product">Model&nbsp;204</var> run.</li>

<li>AUDIT204 does not support streams. </li>

<li>CCAAUDIT contains the audit trail, statistics report, and statistical analysis report. If you request both the audit trail and statistics, the audit trail appears first.
<p>
The value of the BLKSIZE parameter in the CCAAUDIT DD statement is truncated at 4 more than a multiple of 137. A BLKSIZE value of 141 is the default and minimum value.</p>
<p>
Any LRECL and RECFM specifications are ignored; these parameter values are forced to be 137 and VBA, respectively.</p></li>
</ul>
 
===Samples of a z/OS job stream===
<p>
The following sample job streams run AUDIT204, These examples differ in the use of the journal processed, CCAJRNL or CCAJLOG, and the presence or absence of AUDIT204 commands: <var>ANALYZE</var>, <var>FORMAT</var>, and <var>REPORT</var>.</p>
 
====Where only CCAJRNL is defined, all AUDIT204 commands are valid====
<p class="code"> //AUDIT     EXEC  PGM=AUDIT204
 //STEPLIB   DD  DSN=M204.LOADLIB,DISP=SHR
 //SYSUDUMP  DD  SYSOUT=A
 //CCAJRNL   DD  DSN=M204.CCAJRNL,DISP=SHR
 //CCAAUDIT  DD  SYSOUT=A
 //SORTIN    DD  DSN=&amp;&amp;SORTIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //SORTOUT   DD  DSN=*.SORTIN,VOL=REF=*.SORTIN,DISP=(OLD,PASS)
 //STATIN    DD  DSN=&amp;&amp;STATIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //STATOUT   DD  DSN=*.STATIN,VOL=REF=*.STATIN,DISP=(OLD,PASS)
 //SYSOUT    DD  SYSOUT=A
 //CCAIN     DD  *
 FORMAT
 ANALYZE
 REPORT ACCOUNT
   .
   .  ---- <i>user options</i>
   .
 /*
</p>
 
====Where CCAJLOG is defined and you want to extract CCAAUDIT====
<p class="code"> //AUDIT     EXEC  PGM=AUDIT204
 //STEPLIB   DD  DSN=M204.LOADLIB,DISP=SHR
 //SYSUDUMP  DD  SYSOUT=A
 //CCAJRNL   DD  DSN=M204.CCAJLOG,DISP=SHR
 //CCAAUDIT  DD  SYSOUT=A
 //SORTIN    DD  DSN=&amp;&amp;SORTIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //SORTOUT   DD  DSN=*.SORTIN,VOL=REF=*.SORTIN,DISP=(OLD,PASS)
 //STATIN    DD  DSN=&amp;&amp;STATIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //STATOUT   DD  DSN=*.STATIN,VOL=REF=*.STATIN,DISP=(OLD,PASS)
 //SYSOUT    DD  SYSOUT=A
 //CCAIN     DD  *
 FORMAT
   .
   .  ---- <i>user options</i>
   .
 /*
</p>
 
====Where both CCAJRNL and CCAJLOG are defined and you want a statistical analysis====
<p class="code"> //AUDIT     EXEC  PGM=AUDIT204
 //STEPLIB   DD  DSN=M204.LOADLIB,DISP=SHR
 //SYSUDUMP  DD  SYSOUT=A
 //CCAJRNL   DD  DSN=M204.CCAJRNL,DISP=SHR
 //CCAAUDIT  DD  SYSOUT=A
 //SORTIN    DD  DSN=&amp;&amp;SORTIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //SORTOUT   DD  DSN=*.SORTIN,VOL=REF=*.SORTIN,DISP=(OLD,PASS)
 //STATIN    DD  DSN=&amp;&amp;STATIN,UNIT=SYSDA,SPACE=(TRK,nn),
 //              DISP=(NEW,DELETE)
 //STATOUT   DD  DSN=*.STATIN,VOL=REF=*.STATIN,DISP=(OLD,PASS)
 //SYSOUT    DD  SYSOUT=A
 //CCAIN     DD  *
 ANALYZE
 REPORT
   .
   .  ---- <i>user options</i>
   .
 /*
</p>
 
===z/VSE JCL for AUDIT204===
<p>
The following considerations apply to z/VSE: </p>
<ul>
<li>Under z/VSE, output is sent to SYSLST. </li>

<li>CCAJRNL can be on tape or disk. If CCAJRNL is on tape, SYS004 must be assigned to a tape drive.</li>

<li>Running AUDIT204 might require two sorts:
<ul>
<li><var>REPORT</var> command requires a SORTIN and a SORTOUT data set.</li>

<li><var>ANALYZE</var> command requires a STATIN and a STATOUT data set. </li>
</ul></li>

<li>SORTIN, SORTOUT, STATIN, and STATOUT are work files and must be on disk. </li>

<li>SORTWK1 data set is required.</li>

<li>Statistics work (STATWK1) data set might be needed when using the <var>ANALYZE</var> command, depending on the amount of data generated. </li>
</ul>
 
===Sample z/VSE job stream===
<p>
The following sample job stream runs AUDIT204:</p>
<p class="code">// JOB AUDIT204
// DLBL M204LIB,'M204.PROD.LIBRARY'
// EXTENT SYS<i>nnn</i>,...
// LIBDEF PHASE.SEARCH=M204LIB.V210
// DLBL CCAJRNL,'CCAJRNL' Note 1
// EXTENT SYS<i>nnn</i>,...
// DLBL SORTIN,'AUDIT204.SORTIN',0 Note 2
// EXTENT SYS<i>nnn</i>,...
// DLBL SORTOUT,'AUDIT204.SORTOUT',0 Note 2
// EXTENT SYS<i>nnn</i>,...
// DLBL STATIN,'AUDIT204.STATIN',0 Note 3
// EXTENT SYS<i>nnn</i>,...
// DLBL STATOUT,'AUDIT204.STATOUT',0 Note 3
// EXTENT SYS<i>nnn</i>,...
// DLBL SORTWK1,'SORTWK1',0 Note 4
// EXTENT SYS<i>nnn</i>,...
 
// EXEC AUDIT204,SIZE=(AUTO,<i>xx</i>K) Note 5
INCLUDE IFYLSQRT
<b></b>* <i>Insert AUDIT204 CCAIN commands here</i>
FORMAT
REPORT ACCOUNT
REPORT FILE
REPORT ACCOUNT ACCOUNTS MAGGIE MARY DAVE
/*
/&amp;
</p>
 
====Usage notes====
<ul>
<li>If you use tape instead of the DLBL and EXTENT for CCAJRNL, use the following JCL:
<p class="code">// TLBL CCAJRNL
// ASSGN SYS004,X'<i>cuu</i>'
</p></li>

<li>DLBL and EXTENT are necessary if you use either the <var>REPORT</var> or the <var>ANALYZE</var> command.</li>

<li>You must specify a SIZE parameter in the EXEC statement with AUTO and you need some additional storage for the sort program. To determine the amount of additional storage needed for the sort program, refer to IBM's <var class="book">SORT/MERGE Programmer's Guide</var>.</li>
</ul>
 
===(z/VM) CMS JCL for AUDIT204===
<p>
The CMS AUDIT204 utility program prints a <var class="product">Model&nbsp;204</var> journal file and produces a statistical report from information in a journal file:</p>
<ul>
<li>If a statistics report is produced, a SORT utility that can be invoked dynamically must be available for use.</li>

<li>AUDIT204 output is produced either as a printer spool file or in a CMS disk file. </li>
</ul>
<p>
The following EXEC initiates AUDIT204:</p>
 
<p class="syntax">AUDIT204 [<span class="term">datasetname</span>] [<span class="term">filename filetype</span>] <span class="term">filemode</span>
</p>
 
Where:
<ul>
<li><var class="term">datasetname</var> specifies the name of the journal data set on a variable-format disk, with the qualifiers separated by blanks. If no data set name is specified, it is presumed that the name of the journal data set is <code>M204.JOURNAL</code>.</li>
 
<li><var class="term">filename</var> and <var class="term">filetype</var>
specify the name and type of the journal file on a CMS-format, or a variable format for z/OS and z/VSE, disk.</li>
 
<li><var class="term">filemode </var> specifies the mode of the disk holding the journal file to be processed. The input to AUDIT204 contains the commands selected from those described earlier and is included in the AUDIT204 CCAIN. </li>
</ul>
 
===Searching multiple tapes for journal and off load data===
<p>
When a journal or offload data set is on multiple tapes, you do not need to mount all of them for AUDIT204 processing. You can process a subset of the tapes, as long as you mount them in the order in which they were originally generated.</p>
<p>
For example, suppose that your CCAJRNL data set consists of five tapes labeled <code>TAPE01</code> through <code>TAPE05</code>. You are sure that the information you want to analyze begins on the third tape or later. In this case you can save processing time by specifying only <code>TAPE03</code>, <code>TAPE04</code>, and <code>TAPE05</code> in the DD statement for the CCAJRNL data set.</p>
</div> <!-- end of div for toc limit -->
 
[[Category:System management]]
[[Category:Auditing and problem determination]]