SirTune report generation

From m204wiki
Revision as of 21:03, 9 June 2017 by JAL (talk | contribs) (mention M204PROC)
Jump to navigation Jump to search

The report generation portion of SirTune consists of two SOUL programs which are distributed in the RKTools SIRIUS file (prior to RKTools version 7.7) or the M204PROC file (as of RKTools 7.7).

The SOUL reporting programs of SirTune are:

SIRTUNEREPORT The "outer" SirTune report program.
SHARED_REPORT Report methods used by SIRTUNEREPORT.

To run SIRTUNEREPORT from a procedure file other than SIRIUS or M204PROC, move both these procedures to the new file, and update the single INCLUDE statement in SIRTUNEREPORT. A few UTABLE and environmental settings are executed at the top of SIRTUNEREPORT. These can be adjusted for performance or functional reasons at the client site.

SIRTUNEREPORT requires two input files, and it accepts an optional output file. These files, described below, may be specified as DD cards or ALLOCATE statements on the job running SIRTUNEREPORT:

TUNERPTI Input cards that specify the SirTune reports and other run characteristics.

This file may contain older style input, with REPORT, RANGE, RESOLUTION, and other statements, or it may contain newer-style input in XML format. If old-style card images are input, a subroutine in SIRTUNEREPORT converts them to XML. For detailed information about this input, see SirTune Report Generator configuration.

TUNERPTI is a required file.

The file format of TUNERPTI is not critical: Since input lines should be shorter than 80 characters, a fixed 80-character file works fine.

TUNERPTD This is the input data to SIRTUNEREPORT.

TUNERPTD is a required file.

This is the same file as SIRTUNED in the SirTune data collection run.

Sample data sets from multiple runs may be concatenated. In fact, sample data sets from multiple runs may even be concatenated sequentially into a single data set (with IEBGENER under MVS, or COPYFILE or an equivalent under CMS) and provided as a single data set to SIRTUNEREPORT.

When multiple sample data sets are concatenated in any way, the DATASET statement (DATaset list) must be provided in TUNERPTI to have TUNERPTR use any but the first sample data set in the concatenation.

TUNERPTO This is the output file for the SIRTUNEREPORT reports.

The SOUL code is currently set to output 72 characters per line, so a fixed or fixed-block file with 80-character records is recommended.

TUNERPTO is an optional file. If it is not present, report output is redirected to standard output; generally, CCAPRINT.

The names of these files are hard-coded in SIRTUNEREPORT, but they may be changed if you run SIRTUNEREPORT from another procedure file and decide to customize it. The names are chosen to differentiate them from the SIRTUNEx names used during SirTune data collection.

Generally, SIRTUNEREPORT is run as a standalone batch job, though it is perfectly acceptable, if perhaps a little resource-intensive, to dynamically allocate the TUNERPTx files and run it from inside an Online.

A basic TUNERPTR job under MVS would look like this:

get non-BATCH204 example!!

//TUNE JOB (0,0),CLASS=A,MSGCLASS=X //TUNERPT EXEC PGM=BATCH204,REGION=4096K, // PARM='SYSOPT=134,LIBUFF=1000,LOBUFF=1000',TIME=250 //CCASTAT DD DSN=M204.CCASTAT,DISP=SHR //CCATEMP DD DSN=M204.TEMP1,DISP=SHR //CCAJRNL DD DSN=M204.CCAJRNL,DISP=SHR //SIRIUS DD DSN=ULSPF700.SIRIUS,DISP=SHR //TUNERPTI DD DSN=SIRTUNER.REPORT.INPUT,DISP=SHR //TUNERPTD DD DSN=SIRTUNER.DATA.INPUT,DISP=SHR //TUNERPTO DD DSN=SIRTUNER.REPORT.OUTPUT,DISP=SHR //CCAPRINT DD SYSOUT=*,OUTLIM=50000 //CCAIN DD * NFILES=5,NDCBS=5,NDIR=5,MAXBUF=50,NGROUP=5,NORQS=4,LIBUFF=132, X LOBUFF=320,LPDLST=2400,LQTBL=1350,LSTBL=2000,LNTBL=1200 LOGON me mepassword O SIRIUS INCLUDE SIRTUNEREPORT /* //

Under CMS, a similar Batch204 EXEC can be used to invoke SIRTUNEREPORT.

get non-BATCH204 example!!

Compatibility notes:

  • As of release 7.2 of the Sirius mods, SirTune reports can only be generated using a SOUL program invoking a call to the SirTuneReport method of the Dataset class, as implemented in the SIRTUNEREPORT SOUL program described in SirTune Report Generator configuration and SirTune reports.
  • Due to format changes in the sample data set, only releases 1.6 and later of SIRTUNER can process a SirTune version 7.0 and later sample data set.
  • Due to format changes in the sample data set in SirTune version 1.5, earlier releases of SIRTUNER cannot process a SirTune 1.5 or higher sample data set.

Generating reports prior to Sirius Mods 7.2: MVS

For pre-7.2 versions of the Sirius Mods, the report generation portion of SirTune consists of a single load module called SIRTUNER. To have SIRTUNER generate a report for a particular ONLINE job, code JCL that invokes SIRTUNER with appropriate DD cards.

Note: Due to format changes in the sample data set, only releases 1.6 and later of SIRTUNER can process a SirTune version 7.0 and later sample data set.

Note: Due to format changes in the sample data set in SirTune version 1.5, earlier releases of SIRTUNER cannot process a SirTune 1.5 or higher sample data set.

The DD names used by SIRTUNER are:

SIRTUNED This DD should point to a sample data set generated by SirTune. It corresponds to the SIRTUNED DD for the data collection part of SirTune.

Sample data sets from multiple runs may be concatenated. In fact, sample data sets from multiple runs may even be concatenated sequentially into a single data set (with IEBGENER or an equivalent) and provided as a single data set to SIRTUNER.

When multiple sample data sets are concatenated in any way, the DATASET statement must be provided in SIRTUNEI to have SIRTUNER use any but the first sample data set in the concatenation.

SIRTUNEOThis DD is the data set that should receive SIRTUNER error messages or reports. It must have an LRECL greater than or equal to 80.
SIRTUNEI This optional DD contains SIRTUNER statements that alter the SIRTUNER defaults. These statements allow control over which reports are produced and the time interval over which sample data is to be summarized. For a list of available statements, see SirTune Report Generator configuration.

SIRTUNEI can have any format (RECFM=F or RECFM=V).

The following is an example of JCL used to generate a report with SIRTUNER:

//TUNER JOB (0),CLASS=C,MSGCLASS=A //SIRTUNER EXEC PGM=SIRTUNER,REGION=8M //STEPLIB DD DSN=SIRIUS.LOAD,DISP=SHR //SIRTUNEI DD * REPORT STATE WDISK EVAL /* //SIRTUNED DD DSN=SIRTUNE.SAMPLE.DATA,DISP=SHR //SIRTUNEO DD SYSOUT=* //

Generating reports prior to Sirius Mods 7.2: CMS

For pre-7.2 versions of the Sirius Mods, the report generation portion of SirTune consists of a single load module: SIRTUNER. To have SIRTUNER generate a report for a particular ONLINE job, code an EXEC that invokes SIRTUNER with appropriate FILEDEF commands.

Note: Due to format changes in the sample data set, only releases 1.6 and later of SIRTUNER can process a SirTune version 7.0 and later sample data set.

Note: Due to format changes in the sample data set in SirTune version 1.5, earlier releases of SIRTUNER cannot process a SirTune 1.5 or higher sample data set.

SIRTUNER can run under CMS or CMS/XA. Under CMS/XA, most of the storage used by SIRTUNER is "above the line," so virtual storage constraints should not be an issue.

The DD names used by SIRTUNER are:

SIRTUNED This DD should point to a sample data set generated by SirTune. It corresponds to the SIRTUNED DD for the data collection part of SirTune.

Sample data sets from multiple runs may be concatenated. In fact, sample data sets from multiple runs can be concatenated sequentially into a single data set (with COPYFILE or an equivalent) and provided as a single data set to SIRTUNER.

When multiple sample data sets are concatenated in any way, the DATASET statement must be specified in SIRTUNEI to have SIRTUNER use any but the first sample data set in the concatenation.

SIRTUNEO This DD is the data set that should receive SIRTUNER error message or reports. It must have an LRECL greater than or equal to 80.
SIRTUNEI This optional DD contains SIRTUNER statements that alter the SIRTUNER defaults. These statements allow control over which reports are produced and the time interval over which sample data is to be summarized. For a list of available statements, see SirTune Report Generator configuration.

SIRTUNEI must have fixed format, that is, RECFM=F or RECFM=FB.

The following sample EXEC can be used to generate a report with SIRTUNER:

/* */ address command "FILEDEF SIRTUNEI DISK SIRTUNER INPUT A" "FILEDEF SIRTUNEO DISK SIRTUNER LISTING A" "FILEDEF SIRTUNED DISK PRODONLN DATA W", "(LRECL 512 BLOCK 4000 RECFM VB" "SIRTUNER" exit rc

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SirTune_report_generation&oldid=103381"