SirTune report generation: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (remove pre-Mods 7.2 info)
m (add headings, introduction)
Line 1: Line 1:
__NOTOC__
__NOTOC__
Prior to version 7.7 of RKTools, <var class="product">[[SirTune]]</var> reports can only be generated using a SOUL program invoking a call to the <var>[[SirTuneReport (Dataset function)|SirTuneReport]]</var> method of the <var>Dataset</var> class, as implemented in the <code>SIRTUNEREPORT</code> SOUL program described
in [[SirTune Report Generator configuration]] and [[SirTune reports]].
<p>
As of RKTools 7.7, the [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb]] browser interface is equipped to invoke and display <code>SIRTUNEREPORT</code> results. Using RKWeb for SirTune reports requires the same set up of input and output files as described on this page.</p>
==Report programs==
The report generation portion of <var class="product">SirTune</var> consists
The report generation portion of <var class="product">SirTune</var> consists
of two <var class="product">SOUL</var> programs which are distributed in the <var class="product">[[RKTools]]</var> <code>SIRIUS</code> file (prior to RKTools version 7.7) or the <code>M204PROC</code> file (as of RKTools 7.7).
of two <var class="product">SOUL</var> programs which are distributed in the <var class="product">[[RKTools]]</var> <code>SIRIUS</code> file (prior to RKTools version 7.7) or the <code>M204PROC</code> file (as of RKTools 7.7).
Line 15: Line 21:
A few <var>[[UTABLE command|UTABLE]]</var> and environmental settings are executed at the top of SIRTUNEREPORT. These can be adjusted for performance or functional reasons at the client site.
A few <var>[[UTABLE command|UTABLE]]</var> and environmental settings are executed at the top of SIRTUNEREPORT. These can be adjusted for performance or functional reasons at the client site.


==Report files==
SIRTUNEREPORT requires two input files, and it accepts an optional output
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:
file. These files, described below, may be specified as DD cards or ALLOCATE statements on the job running SIRTUNEREPORT:
Line 51: Line 58:
The names are chosen to differentiate them from the SIRTUNE<i>x</i> names used during <var class="product">SirTune</var> data collection.
The names are chosen to differentiate them from the SIRTUNE<i>x</i> names used during <var class="product">SirTune</var> data collection.


==Report job==
Generally, SIRTUNEREPORT is run as a standalone batch job, though
Generally, SIRTUNEREPORT is run as a standalone batch job, though
it is perfectly acceptable, if perhaps a little resource-intensive, to dynamically allocate the TUNERPT<i>x</i> files and run it from inside an Online.
it is perfectly acceptable, if perhaps a little resource-intensive, to dynamically allocate the TUNERPT<i>x</i> files and run it from inside an Online.


A basic TUNERPTR job under MVS would look like this:
A basic TUNERPTR job under MVS would look like this:
====get non-BATCH204 example!! ====
 
<p class="code">//TUNE JOB (0,0),CLASS=A,MSGCLASS=X
<p class="code">//TUNE JOB (0,0),CLASS=A,MSGCLASS=X
//TUNERPT  EXEC PGM=BATCH204,REGION=4096K,
//TUNERPT  EXEC PGM=BATCH204,REGION=4096K,
Line 78: Line 86:
</p>
</p>


Under CMS, a similar Batch204 EXEC can be used to invoke SIRTUNEREPORT.
Notes:
<ul>
<li>For RKTools 7.7 or higher, the <code>SIRIUS</code> file is replaced with the <code>M204PROC</code> file. </li>


====get non-BATCH204 example!! ====
<li>For an Online job instead of batch, the same SirTune files are allocated: TUNERPTI (report input parameters), TUNERPTD (reporting data), and an optional TUNERPTO (output destination replacing the screen default). The <var>OPEN</var> and <var>INCLUDE</var> commands do not change. </li>


Compatibility notes:
<li>Under CMS, a similar Batch204 EXEC can be used to invoke SIRTUNEREPORT. </li>
<ul>
<li>As of release 7.2 of the Sirius mods, <var class="product">SirTune</var> reports can only be generated
using a SOUL program invoking a call to the <var>[[SirTuneReport (Dataset function)|SirTuneReport]]</var> method of the <var>Dataset</var> class, as implemented in the <code>SIRTUNEREPORT</code> SOUL program described
in [[SirTune Report Generator configuration]] and [[SirTune reports]].</li>


<li>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.</li>
<li>Due to format changes in the sample data set, only versions 1.6 and later of SIRTUNER can process a SirTune version 7.0 and later sample data set. </li>


<li>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.</li>
<li>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. </li>
</ul>
</ul>


Revision as of 00:22, 10 June 2017

Prior to version 7.7 of RKTools, 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.

As of RKTools 7.7, the RKWeb browser interface is equipped to invoke and display SIRTUNEREPORT results. Using RKWeb for SirTune reports requires the same set up of input and output files as described on this page.

Report programs

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.

Report files

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.

Report job

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:

//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 /* //

Notes:

  • For RKTools 7.7 or higher, the SIRIUS file is replaced with the M204PROC file.
  • For an Online job instead of batch, the same SirTune files are allocated: TUNERPTI (report input parameters), TUNERPTD (reporting data), and an optional TUNERPTO (output destination replacing the screen default). The OPEN and INCLUDE commands do not change.
  • Under CMS, a similar Batch204 EXEC can be used to invoke SIRTUNEREPORT.
  • Due to format changes in the sample data set, only versions 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.

See also

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