SirAud invocation: Difference between revisions
No edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
Input: parms - Parms are either in an external file specified by | Input: parms - Parms are either in an external file specified by | ||
DDNAME, or are in a procedure in a M204 procfile. | DDNAME, or are in a procedure in a M204 procfile. | ||
Either way, the input must be in XML format as described | Either way, the input must be in XML format as described | ||
| Line 36: | Line 36: | ||
the extracted XML is saved. | the extracted XML is saved. | ||
parms and parmfile are mutually exclusive, as are journal and journalExtract. | parms and parmfile are mutually exclusive, as are journal and journalExtract. | ||
Input parameters: | Input parameters: | ||
allpr / nopr - produce either all or no reports. | allpr / nopr - produce either all or no reports. | ||
| Line 59: | Line 59: | ||
top | top | ||
input parameters are formatted as an XML doc, like this: | input parameters are formatted as an XML doc, like this: | ||
<SiraudInput top="10" from="3681504000010" to="3681849599990" Maxblk="10000" Skipblk="2"> | <SiraudInput top="10" from="3681504000010" to="3681849599990" Maxblk="10000" Skipblk="2"> | ||
| Line 68: | Line 68: | ||
</SiraudInput> | </SiraudInput> | ||
As with all XML documents, the content of the SiraudInput XML document is | <p class="note">As with all XML documents, the content of the SiraudInput XML document is | ||
HIGHLY CASE SENSITIVE. In general, if a parameter isn't found, it's regarded | HIGHLY CASE SENSITIVE. In general, if a parameter isn't found, it's regarded | ||
as missing. If the case is incorrect it will not be found. | as missing. If the case is incorrect it will not be found.</p> | ||
===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: | 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: | ||
Revision as of 21:22, 19 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 invoking 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 line in M204PROC. M204PROC is used in the following examples, but if you're running RKTools 7.5, you should substitute SIRIUS.
The program for running SirAud is SIRAUDREPORT; it accepts report parameters in XML format only, and operates on a JOURNAL data set that is not the active journal for the job. The command for invoking SirAud from Soul looks like this:
[IN [FILE|GROUP] xxxxxxxx] INCLUDE SIRAUDREPORT - [parms=DDNAME | FILE:PROCEDURENAME] - {[journal=DDNAME] | [journalextract=DDNAME|FILE:PROCEDURENAME]] - [outfile=SIRAUDO] [RAWXML|RAWXMLONLY]
Input: parms - Parms are either in an external file specified by
DDNAME, or are in a procedure in a M204 procfile.
Either way, the input must be in XML format as described
below.
journal - specifies the dd name of a journal file to analyze
journalExtract -
specifies 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 - Output destination for the SirAud reports. If rawxml
rawXmlOnly 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' - all reports are produced.
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
Skipblk
top
input parameters are formatted as an XML doc, like this:
<SiraudInput top="10" from="3681504000010" to="3681849599990" Maxblk="10000" Skipblk="2">
<report type="allpr"/>
<report type="noutblrp"/>
<report type="noutblsm"/>
<reportFormat linesPerPage="55"/>
</SiraudInput>
As with all XML documents, the content of the SiraudInput XML document is HIGHLY CASE SENSITIVE. In general, if a parameter isn't found, it's 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.