SirAud invocation - Revision history

JAL: minor

2017-06-01T22:52:57Z

minor

← Older revision		Revision as of 22:52, 1 June 2017
Line 50:		Line 50:

	<p class="code">FREE EXTJRNL		<p class="code">FREE EXTJRNL
	ALLOCATE EXTJRNL WITH OLD SEQUENTIAL SCOPE=SYSTEM DSN=ULSPFDAB.V77.SIRAUD.CCAJRNL VOLUME=SRS100		ALLOCATE EXTJRNL WITH OLD SEQUENTIAL SCOPE=SYSTEM DSN=ULSPFDAB.V77.SIRAUD.CCAJRNL
	PUSHUTABLE LVTBL 1000+ LQTBL 4000		VOLUME=SRS100 PUSHUTABLE LVTBL 1000+ LQTBL 4000
	R MAXREP31 1024 MAXREP64 4096		R MAXREP31 1024 MAXREP64 4096

Line 62:		Line 62:
	In the above example, a journal file is allocated as <code>EXTJRNL</code>, and report parameters are retrieved from the procedure <code>SIRAUD_REPORT_PARMS</code> in file <code>PARMPROC</code>.		In the above example, a journal file is allocated as <code>EXTJRNL</code>, and report parameters are retrieved from the procedure <code>SIRAUD_REPORT_PARMS</code> in file <code>PARMPROC</code>.

	<p class="note"><b>Note:</b> SIRAUDREPORT does no <var>UTABLE</var> or <var>RESET</var> parameter setting. </p></li>		<p class="note"><b>Note:</b> <code>SIRAUDREPORT</code> does no <var>UTABLE</var> or <var>RESET</var> parameter setting. </p></li>
	</ol>		</ol>

JAL: typo

2016-10-25T15:40:55Z

typo

← Older revision		Revision as of 15:40, 25 October 2016
Line 122:		Line 122:
	</SiraudInput> </p>		</SiraudInput> </p>

	<p class="note">As with all XML documents, the content of the <code>SiraudInput</code> XML document is <b>highly case-sensitive</b>. In general, if a parameter is not found, it is regarded as missing. If the case is incorrect, it will not be found.</p>		<p class="note"><b>Note:</b> As with all XML documents, the content of the <code>SiraudInput</code> XML document is <b>highly case-sensitive</b>. In general, if a parameter is not found, it is regarded as missing. If the case is incorrect, it will not be found.</p>

	==Standalone SirAud (SirAud version 1.05)==		==Standalone SirAud (SirAud version 1.05)==

JAL: add short descriptions of two non-named reports

2016-10-21T16:18:41Z

add short descriptions of two non-named reports

← Older revision		Revision as of 16:18, 21 October 2016
Line 72:		Line 72:
	<td>Produce all or no reports. The default is <var>allpr</var>, which produces all [[SirAud#SirAud reports\|these reports]].		<td>Produce all or no reports. The default is <var>allpr</var>, which produces all [[SirAud#SirAud reports\|these reports]].
	<p>		<p>
	If you specify <var>nopr</var>, all reports are suppressed, and the output consists of the environment report, a summary of the Model 204 parameters from the selected journal, and the interval report. </p></td></tr>		If you specify <var>nopr</var>, all reports are suppressed, and the output consists of the environment report (system settings in force in the Online), a summary of the Model 204 parameters from the selected journal, and the interval report (statistics per each 15-minute segment of the Online run). </p></td></tr>

	<tr><th>filerp \| nofilerp</th>		<tr><th>filerp \| nofilerp</th>
Line 87:		Line 87:

	<tr><th>utblrp \| noutblrp</th>		<tr><th>utblrp \| noutblrp</th>
	<td>Produce/suppress the detailed ~~<var>~~UTABLE~~</var>~~ report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#UTBLREPT\|detailed UTABLE report]]. </td></tr>

	<tr><th nowrap>utblsm \| noutblsm</th>		<tr><th nowrap>utblsm \| noutblsm</th>
	<td>Produce/suppress the summary ~~<var>~~UTABLE~~</var>~~ report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#UTBLSUMM\|summary UTABLE report]]. </td></tr>

	<tr><th>from</th>		<tr><th>from</th>

JAL: finish unfinished sentence

2016-10-21T00:04:59Z

finish unfinished sentence

← Older revision		Revision as of 00:04, 21 October 2016
Line 72:		Line 72:
	<td>Produce all or no reports. The default is <var>allpr</var>, which produces all [[SirAud#SirAud reports\|these reports]].		<td>Produce all or no reports. The default is <var>allpr</var>, which produces all [[SirAud#SirAud reports\|these reports]].
	<p>		<p>
	If you specify <var>nopr</var>, all reports are suppressed, and the output consists of the environment report, a summary of the Model 204 parameters from the selected journal, and ~~<b>???</b>~~. </p></td></tr>		If you specify <var>nopr</var>, all reports are suppressed, and the output consists of the environment report, a summary of the Model 204 parameters from the selected journal, and the interval report. </p></td></tr>

	<tr><th>filerp \| nofilerp</th>		<tr><th>filerp \| nofilerp</th>

JAL: misc formatting

2016-10-20T22:14:13Z

misc formatting

← Older revision		Revision as of 22:14, 20 October 2016
Line 60:		Line 60:
	</p>		</p>

	In the above example, a journal file is allocated as <code>EXTJRNL</code>, and report parameters are retrieved from the procedure <code>SIRAUD_REPORT_PARMS</code> in file <code>PARMPROC</code>.</li>		In the above example, a journal file is allocated as <code>EXTJRNL</code>, and report parameters are retrieved from the procedure <code>SIRAUD_REPORT_PARMS</code> in file <code>PARMPROC</code>.

			<p class="note"><b>Note:</b> SIRAUDREPORT does no <var>UTABLE</var> or <var>RESET</var> parameter setting. </p></li>
	</ol>		</ol>

	~~<p class="note"><b>Note:</b> SIRAUDREPORT does no <var>UTABLE</var> or <var>RESET</var> parameter setting. </p>~~

	===Specifying report parameters===		===Specifying report parameters===
Line 70:		Line 70:
	<table class="thJustBold">		<table class="thJustBold">
	<tr><th>allpr \| nopr </th>		<tr><th>allpr \| nopr </th>
	<td>Produce ~~either~~ all or no reports. </td></tr>		<td>Produce all or no reports. The default is <var>allpr</var>, which produces all [[SirAud#SirAud reports\|these reports]].
			<p>
			If you specify <var>nopr</var>, all reports are suppressed, and the output consists of the environment report, a summary of the Model 204 parameters from the selected journal, and <b>???</b>. </p></td></tr>

	<tr><th>filerp \| nofilerp</th>		<tr><th>filerp \| nofilerp</th>
	<td>Produce/suppress the file report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#FILEREPT\|file report]]. </td></tr>

	<tr><th>perfrp \| noperfrp</th>		<tr><th>perfrp \| noperfrp</th>
	<td>Produce/suppress the performance report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#PERFREPT\|performance report]]. </td></tr>

	<tr><th>procrp \| noprocrp</th>		<tr><th>procrp \| noprocrp</th>
	<td>Produce/suppress the procedures report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#PROCREPT\|procedures report]]. </td></tr>

	<tr><th>subrp \| nosubrp</th>		<tr><th>subrp \| nosubrp</th>
	<td>Produce/suppress the subsystem report. </td></tr>		<td>Produce/suppress the [[SirAud report contents#SUBREPT\|subsystem report]]. </td></tr>

	<tr><th>utblrp \| noutblrp</th>		<tr><th>utblrp \| noutblrp</th>
	<td>Produce/suppress the detailed ~~utable~~ report. </td></tr>		<td>Produce/suppress the detailed <var>UTABLE</var> report. </td></tr>

	<tr><th>utblsm \| noutblsm</th>		<tr><th nowrap>utblsm \| noutblsm</th>
	<td>Produce/suppress the summary ~~utable~~ report. </td></tr>		<td>Produce/suppress the summary <var>UTABLE</var> report. </td></tr>
	~~</table~~>

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

	~~<table class="thJustBold">~~
	<tr><th>from</th>		<tr><th>from</th>
	<td>Starting date/time for journal analysis. Defaults to start of journal.		<td>Starting date/time for journal analysis. Defaults to start of journal.
Line 113:		Line 111:

	<tr><th>top</th>		<tr><th>top</th>
	<td>Number of procedures to analyze in the procedure report. These ~~would be~~ the "top" resource-consuming procedures found in the journal. </td></tr>		<td>Number of procedures to analyze in the procedure report. These are the "top" resource-consuming procedures found in the journal. </td></tr>
	</table>		</table>

JAL: misc formatting and resolve conflict w/ Alan update

2016-10-20T21:44:46Z

misc formatting and resolve conflict w/ Alan update

Show changes

Alan at 20:08, 20 October 2016

2016-10-20T20:08:46Z

← Older revision		Revision as of 20:08, 20 October 2016
Line 29:		Line 29:
	</table>		</table>

	~~PARMS~~ and ~~parmfile~~ are mutually exclusive~~, as are JOURNAL and JOURNALEXTRACT~~.		JOURNAL and JOURNALEXTRACT are mutually exclusive.

	Input parameters:		Input parameters:

Alan at 19:09, 20 October 2016

2016-10-20T19:09:07Z

← Older revision		Revision as of 19:09, 20 October 2016
Line 2:		Line 2:
	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 <code>SIRIUS</code> file; as of RKTools 7.7, the procedures live in the <code>M204PROC</code> file. <code>M204PROC</code> is used in the examples below; substitute <code>SIRIUS</code> if using RKTools 7.5.		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 <code>SIRIUS</code> file; as of RKTools 7.7, the procedures live in the <code>M204PROC</code> file. <code>M204PROC</code> is used in the examples below; substitute <code>SIRIUS</code> if using RKTools 7.5.

	<code>SIRAUDREPORT</code> is the program that runs SirAud. It accepts report parameters in XML format only, and it operates on a <code>JOURNAL</code> data set that <em>is not</em> the active journal for the job. The command for invoking SirAud from SOUL has this form:		<code>SIRAUDREPORT</code> is the program that runs SirAud. It accepts report parameters in XML format only, and it operates on a <code>JOURNAL</code> data set that <em>is not</em> the active journal for the job (SirAud can <em>not</em> analyze the currently active journal). The command for invoking SirAud from SOUL has this form:

	<p class="syntax">[IN [FILE\|GROUP] <span class="term">fgname</span>] INCLUDE SIRAUDREPORT -		<p class="syntax">[IN [FILE\|GROUP] <span class="term">fgname</span>] INCLUDE SIRAUDREPORT -

Alan at 19:07, 20 October 2016

2016-10-20T19:07:00Z

← Older revision		Revision as of 19:07, 20 October 2016
Line 60:		Line 60:
	<table class="thJustBold">		<table class="thJustBold">
	<tr><th>from</th>		<tr><th>from</th>
	<td>starting date/time for journal analysis. Defaults to start of journal </td></tr>		<td>starting date/time for journal analysis. Defaults to start of journal. The format is a 13 digit number as output by $date2nm, like this: %from = $sir_date2nm('09-12-13 00:42:00:11', 'MM-DD-YY HH:MI:SS:XX').</td></tr>

	<tr><th>to</th>		<tr><th>to</th>
	<td>ending date/time for journal analysis. Defaults to end of journal </td></tr>		<td>ending date/time for journal analysis. Defaults to end of journal. The format is a 13 digit number as output by $date2nm, like this: %to = $sir_date2nm('09-12-13 12:42:00:00', 'MM-DD-YY HH:MI:SS:XX'). </td></tr>

	<tr><th>Maxblk</th>		<tr><th>Maxblk</th>

JAL: misc formatting

2016-10-20T18:46:35Z

misc formatting

← Older revision		Revision as of 18:46, 20 October 2016
Line 4:		Line 4:
	<code>SIRAUDREPORT</code> is the program that runs SirAud. It accepts report parameters in XML format only, and it operates on a <code>JOURNAL</code> data set that <em>is not</em> the active journal for the job. The command for invoking SirAud from SOUL has this form:		<code>SIRAUDREPORT</code> is the program that runs SirAud. It accepts report parameters in XML format only, and it operates on a <code>JOURNAL</code> data set that <em>is not</em> the active journal for the job. The command for invoking SirAud from SOUL has this form:

	<p class="~~code~~">[IN [FILE\|GROUP] ~~xxxxxxxx~~] INCLUDE SIRAUDREPORT -		<p class="syntax">[IN [FILE\|GROUP] <span class="term">fgname</span>] INCLUDE SIRAUDREPORT -
	[~~parms~~=~~DDNAME~~ \| ~~FILE~~:~~PROCEDURENAME~~] -		[PARMS= {<span class="term">ddname</span> \| <span class="term">procfile</span>:<span class="term">procname</span>} ] -
	{[~~journal~~ = ~~DDNAME~~] \| [~~journalextract~~=~~DDNAME~~ \| ~~FILE~~:~~PROCEDURENAME]~~] -		[JOURNAL=<span class="term">ddname</span>] \| [JOURNALEXTRACT= {<span class="term">ddname</span> \| <span class="term">procfile</span>:<span class="term">procname</span>} ] -
	[~~outfile~~=~~SIRAUDO~~] [RAWXML\|RAWXMLONLY]		[OUTFILE=<span class="term">ddname</span>] [RAWXML\|RAWXMLONLY]
	</p>		</p>

			Where:
	~~Input:~~
	<table class="thJustBold">		<table class="thJustBold">
	<tr><th>~~parms~~</th>		<tr><th>PARMS</th>
	<td>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. </td></tr>		<td>Parameters, in an external file specified by DD name, or in a procedure in a Model 204 procedure file. In either location, the input must be in XML format as described below. </td></tr>

	<tr><th>~~journal~~</th>		<tr><th>JOURNAL</th>
	<td>The dd name of a journal file to analyze. </td></tr>		<td>The DD name of a journal file to analyze. </td></tr>

	<tr><th>~~journalExtract~~</th>		<tr><th>JOURNALEXTRACT</th>
	<td>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. </td></tr>		<td>A file containing XML data already extracted from a Model 204 journal. The file is specified by its DD name or as a procedure that contains the XML extract. If a procedure, use a colon (<tt>:</tt>) to separate the procedure name from the file in which it resides. </td></tr>

	<tr><th>~~outfile~~</th>		<tr><th>OUTFILE</th>
	<td>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. </td></tr>		<td>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 <var>USE</var> file, a <var>USE</var> procedure, or CCAPRINT. </td></tr>

	<tr><th nowrap>~~rawXml~~ or ~~rawXmlOnly~~</th>		<tr><th nowrap>RAWXML or RAWXMLONLY</th>
	<td>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. </td></tr>		<td>Output destination for the SirAud reports. If <var>RAWXML</var> is specified, both the raw XML and the report are saved in the specified file. If <var>RAWXMLONLY</var> is specified, only the extracted XML is saved. </td></tr>
	</table>		</table>

	~~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: