SirAud invocation: Difference between revisions

Revision as of 15:30, 20 October 2016

SirAud SOUL

As of version 7.5 of Model 204, SirAud can be invoked from a standard Model 204 job, batch or Online, by including a Rocket-provided SOUL procedure. In RKTools version 7.5, the SOUL procedures live in the SIRIUS file; as of RKTools 7.7, the procedures live in the M204PROC file. M204PROC is used in the examples below; substitute SIRIUS if using RKTools 7.5.

SIRAUDREPORT is the program that runs SirAud. It accepts report parameters in XML format only, and it operates on a JOURNAL data set that is not the active journal for the job. The command for invoking SirAud from SOUL has this form:

[IN [FILE|GROUP] xxxxxxxx] INCLUDE SIRAUDREPORT - [parms=DDNAME | FILE:PROCEDURENAME] - {[journal = DDNAME] | [journalextract=DDNAME | FILE:PROCEDURENAME]] - [outfile=SIRAUDO] [RAWXML|RAWXMLONLY]

Input:

parms	Parameters, in an external file specified by DDNAME, or in a procedure in a Model 204 procedure file. In either location, the input must be in XML format as described below.
journal	The dd name of a journal file to analyze.
journalExtract	A file containing XML data already extracted from a model 204 journal. Input is either a dd name, or a procedure containing the XML extract, specified as procedure name separated by a colon form the file in which it resides.
outfile	The dd name of a sequential file to hold the output of this report run. If no outfile is specified, the report goes to standard output, which could be the terminal, a USE file, a USE procedure, or CCAPRINT.
rawXml or rawXmlOnly	Output destination for the SirAud reports. If rawxml is specified, both the rawxml and the report are saved in the specified file. If rawXmlOnly is specified, only the extracted XML is saved.

parms and parmfile are mutually exclusive, as are journal and journalExtract.

Input parameters:

allpr / nopr	produce either all or no reports.
filerp / nofilerp	produce/suppress the file report
perfrp / noperfrp	produce/suppress the performance report
procrp / noprocrp	produce/suppress the procedures report
subrp / nosubrp	produce/suppress the subsystem report
utblrp / noutblrp	produce/suppress the detailed utable report
utblsm / noutblsm	produce/suppress the summary utable report

The default report selection is allpr, which produces all reports. If all reports are suppressed, the output will consist of the environment reports and a summary of the Model 204 parameters from the selected journal.

from	starting date/time for journal analysis. Defaults to start of journal
to	ending date/time for journal analysis. Defaults to end of journal
Maxblk	Maximum number of journal blocks to process. Defaults to all blocks.
Skipblk	Number of initial journal blocks to skip processing. Defaults to zero. It can be useful to skip some initial journal blocks if the Model 204 job has some initialization processes that you'd like to exclude from the analysis.
top

Input parameters are formatted as an XML doc, like this:

As with all XML documents, the content of the SiraudInput XML document is highly case-sensitive. In general, if a parameter is not found, it is regarded as missing. If the case is incorrect, it will not be found.

Usage notes

So, for example, you could run SirAud by executing the following commands in the CCAIN of a batch job or at the command line from inside a Model 204 region:

IN FILE M204PROC INCLUDE SIRAUDREPORT PARMS=SIRAUDI JOURNAL=MYJRNL

In this example the XML-formatted parameters are in an external file (or DD Card) named SIRAUDI, and the journal to analyze is allocated to the job as MYJRNL.

A more detailed set of commands might look like this:

FREE EXTJRNL ALLOCATE EXTJRNL WITH OLD SEQUENTIAL SCOPE=SYSTEM DSN=ULSPFDAB.V77.SIRAUD.CCAJRNL VOLUME=SRS100 PUSHUTABLE LVTBL 1000+ LQTBL 4000 R MAXREP31 1024 MAXREP64 4096 OPEN FILE ALANPROC OPEN FILE M204PROC IN M204PROC INCLUDE SIRAUDREPORT PARMS=PARMPROC:SIRAUD_REPORT_PARMS JOURNAL=EXTJRNL RAWXML

In the above example, a journal file is allocated as EXTJRNL, and report parameters are retrieved from the procedure SIRAUD_REPORT_PARMS in file PARMPROC. Note that SIRAUDREPORT does not do any UTABLE or parameter setting.

Standalone SirAud (SirAud version 1.05)

Prior to RKTools 7.5, SirAud could only be invoked via the standalone SIRAUD program. As of late 2016 this approach is deprecated, but will still work.

Running SirAud under MVS

The following JCL will run SirAud under MVS:

//SIRAUDJ JOB (0),MSGCLASS=A,CLASS=A,NOTIFY=ME //SIRAUD EXEC PGM=SIRAUD,PARM='NFILES=10' //STEPLIB DD DSN=SIRAUD.LOAD,DISP=SHR //JOURNAL DD DSN=M204.CCAJRNL,DISP=SHR //SYSPRINT DD SYSOUT=A //* Omit following if reports selected by PARM: //PERFREPT DD SYSOUT=A //FILEREPT DD SYSOUT=A //PROCREPT DD SYSOUT=A //SUBREPT DD SYSOUT=A //UTBLREPT DD SYSOUT=A //UTBLSUMM DD SYSOUT=A //

Note: If you use any of the report selection parameters, omit the various report DD statements, excepting SYSPRINT. See ALLPR and NOPR for a discussion of the report selection parameters.

Running SirAud under CMS

A simple SIRAUD EXEC is provided to run SirAud. You must first issue a FILEDEF command for the JOURNAL file. You may want to insert a JOURNAL FILEDEF to identify the Model 204 journal file, or you may want to issue EXEC SIRAUD from a "wrapper" that contains the FILEDEF command for JOURNAL.

SirAud parameters are specified as options to the SIRAUD EXEC or as SYSIN file records (see SYSIN). Unlike the MVS JCL PARM= field, you do not specify an equal sign (=) between a parameter and the value you are specifying. For example:

SIRAUD (NFILES 10 NOSUBREPT

If you do not want to use the SIRAUD EXEC that is distributed with the product, SirAud must be invoked by the Model 204 CMS interface, because it uses the CMS interface's QSAM/BSAM simulation. The program name of SirAud as distributed is SIRAUD.

Note: Because SirAud uses the Model 204 CMS interface, any file can be on an OS format minidisk.

@@ Line 66: / Line 66: @@
 <tr><th>Maxblk</th>
-<td> </td></tr>
+<td>Maximum number of journal blocks to process. Defaults to all blocks.</td></tr>
 <tr><th>Skipblk</th>
-<td> </td></tr>
+<td>Number of initial journal blocks to skip processing. Defaults to zero. It can be useful to skip some initial journal blocks if the Model 204 job has some initialization processes that you'd like to exclude from the analysis.</td></tr>
 <tr><th>top</th><td>