$View - Revision history

JAL: add info re $Stat and UserStatistics class

2016-01-25T22:10:32Z

add info re $Stat and UserStatistics class

← Older revision		Revision as of 22:10, 25 January 2016
Line 193:		Line 193:

	===Usage===		===Usage===
			<ul>
			<li>In some cases (for example, CPU time), calculating the value of a statistic is a somewhat expensive operation, so <var>$View</var> does not force an update of its value.
	<p>		<p>
	The time related Since Last statistics fields, CNCT, CPU, SCHDCPU, and STCPU, are not valid during evaluation time.~~</p>~~		Since the <var>$Stat</var> function <i>does</i> update statistics when it is issued, you might try calling <var>$Stat</var> prior to invoking <var>$View</var>.</p>
			<p>
			In addition, the [[UserStatistics class]] allows collection of all user statistics at once, and it has methods for calculating differences between before and after snapshots and for converting statistics to XML or to audit-trail-style <code><i>stat</i>=<i>value</i></code> format. Like <var>$Stat</var>, a <var>UserStatistics</var> constructor forces updating of all the relevant statistics.</p></li>

			<li>The time-related Since Last statistics fields, CNCT, CPU, SCHDCPU, and STCPU, are not valid during evaluation time.
	<p>		<p>
	Specifying an invalid statistics field name returns a null value with the message:</p>		Specifying an invalid statistics field name returns a null value with the message:</p>
	<p class="code">M204.1463: INVALID PARAMETER: <i>fieldname</i></p>		<p class="code">M204.1463: INVALID PARAMETER: <i>fieldname</i></p>
			</li>
			</ul>

	==Syntax to view the size and use of journal and checkpoint streams==		==Syntax to view the size and use of journal and checkpoint streams==

JAL: more conversion cleanup

2015-01-09T00:17:41Z

more conversion cleanup

Show changes

Tbullock: Add column "Remarks" to table 27-6.

2014-08-15T16:52:18Z

Add column "Remarks" to table 27-6.

← Older revision		Revision as of 16:52, 15 August 2014
Line 73:		Line 73:
	</table>		</table>
	<p>For example:</p>		<p>For example:</p>
	<p class="code">$VIEW ('FIWHEN')		<p class="code">$VIEW ('FIWHEN')</p>
	</p>
	<p>returns:</p>		<p>returns:</p>
	<p class="code">FIWHEN 94.257 SEP 14 16.40.45. DATE AND TIME FISTAT WAS RESET		<p class="code">FIWHEN 94.257 SEP 14 16.40.45. DATE AND TIME FISTAT WAS RESET</p>
	</p>
	<b>Syntax for viewing statistics fields</b>		<b>Syntax for viewing statistics fields</b>
	<p>The first argument is the category, SLSTATS, SYSSTATS, or USRSTATS. The second argument is the name of the Statistic field to return. See the Rocket <var class="product">Model 204</var> System Managers Guide for the name of the statistics fields.</p>		<p>The first argument is the category, SLSTATS, SYSSTATS, or USRSTATS. The second argument is the name of the Statistic field to return. See the Rocket <var class="product">Model 204</var> System Managers Guide for the name of the statistics fields.</p>
	<p class="code">$VIEW(category, field-to-return)		<p class="code">$VIEW(category, field-to-return)</p>
	</p>		<p>Where the following categories and fields are valid:</p>
	<p>Where the following categories and fields are valid: </p>
	<table>		<table>
	<caption>Valid categories and fields with $VIEW</caption>		<caption>Valid categories and fields with $VIEW</caption>
	<tr class="head">		<tr class="head">
	<th>		<th>Category</th>
	Category</th>
	<th>Statistics field-to-return</th>		<th>Statistics field-to-return</th>
	<th>		<th>Equivalent-to or returns-value-of</th>
	Equivalent-to or returns-value-of</th>		<th>Remarks</th>
	</tr>		</tr>
	<tr>		<tr>
Line 96:		Line 92:
	<td>'USERID'</td>		<td>'USERID'</td>
	<td>[[$Userid]]</td>		<td>[[$Userid]]</td>
			<td>Padded with blank spaces to 10 bytes</td>
	</tr>		</tr>
	<tr>		<tr>
Line 101:		Line 98:
	<td>'ACCOUNT'</td>		<td>'ACCOUNT'</td>
	<td>[[$Account]]</td>		<td>[[$Account]]</td>
			<td>Padded to 10 bytes</td>
	</tr>		</tr>
	<tr>		<tr>
Line 106:		Line 104:
	<td>'SUBSYSTEM'</td>		<td>'SUBSYSTEM'</td>
	<td>$SUBSYS with no argument</td>		<td>$SUBSYS with no argument</td>
			<td>Padded to 10 bytes</td>
	</tr>		</tr>
	<tr>		<tr>
Line 111:		Line 110:
	<td>'LAST'</td>		<td>'LAST'</td>
	<td>LAST=field</td>		<td>LAST=field</td>
			<td>EVAL etc.</td>
	</tr>		</tr>
	<tr>		<tr>
Line 116:		Line 116:
	<td>'PROC-FILE'</td>		<td>'PROC-FILE'</td>
	<td>Current procedure file</td>		<td>Current procedure file</td>
			<td>Padded to 8 bytes</td>
	</tr>		</tr>
	<tr>		<tr>
	<td>'SLSTATS'</td>		<td>'SLSTATS'</td>
	<td>'PROC'</td>		<td>'PROC'</td>
	<td>Current procedure </td>		<td>Current procedure</td>
			<td>Variable length, or truncated to 21 bytes</td>
	</tr>		</tr>
	<tr>		<tr>
Line 126:		Line 128:
	<td>'sl statistics name'</td>		<td>'sl statistics name'</td>
	<td>Statistics field</td>		<td>Statistics field</td>
			<td> </td>
	</tr>		</tr>
	<tr>		<tr>
Line 131:		Line 134:
	<td>'system stat name'</td>		<td>'system stat name'</td>
	<td>Statistics field</td>		<td>Statistics field</td>
			<td> </td>
	</tr>		</tr>
	<tr>		<tr>
Line 136:		Line 140:
	<td>'DKBM stat name'</td>		<td>'DKBM stat name'</td>
	<td>Statistics field</td>		<td>Statistics field</td>
			<td> </td>
	</tr>		</tr>
	<tr>		<tr>
Line 141:		Line 146:
	<td>'user stat name'</td>		<td>'user stat name'</td>
	<td>Statistics field</td>		<td>Statistics field</td>
			<td> </td>
	</tr>		</tr>
	<tr>		<tr>
Line 146:		Line 152:
	<td>'conflict ctr name'</td>		<td>'conflict ctr name'</td>
	<td>Statistics field</td>		<td>Statistics field</td>
			<td> </td>
	</tr>		</tr>
	</table>		</table>
Line 151:		Line 158:
	<p>The time related Since Last statistics fields, CNCT, CPU, SCHDCPU, and STCPU, are not valid during evaluation time.</p>		<p>The time related Since Last statistics fields, CNCT, CPU, SCHDCPU, and STCPU, are not valid during evaluation time.</p>
	<p>Specifying an invalid statistics field name returns a null value with the message:</p>		<p>Specifying an invalid statistics field name returns a null value with the message:</p>
	<p class="code">M204.1463: INVALID PARAMETER: fieldname		<p class="code">M204.1463: INVALID PARAMETER: fieldname</p>
	</p>
	<b>Syntax to view the size and use of journal and checkpoint streams</b>		<b>Syntax to view the size and use of journal and checkpoint streams</b>
	<p>The format of $VIEW for the use and size of journal and checkpoint streams is:</p>		<p>The format of $VIEW for the use and size of journal and checkpoint streams is:</p>
	<p class="code">$VIEW('CCAJRNL'\|'CCAJLOG'\|'CHKPOINT'\|'CHKPNTS')		<p class="code">$VIEW('CCAJRNL'\|'CCAJLOG'\|'CHKPOINT'\|'CHKPNTS')</p>
	</p>
	<p>Specify the following:</p>		<p>Specify the following:</p>
	<p class="code">%STRING = $VIEW('CCAJRNL'\|'CCAJLOG'\|'CHKPOINT'\|'CHKPNTS')		<p class="code">%STRING = $VIEW('CCAJRNL'\|'CCAJLOG'\|'CHKPOINT'\|'CHKPNTS')</p>
	</p>
	<p>$VIEW returns a string that describes the usage of the specified stream with the following character format:</p>		<p>$VIEW returns a string that describes the usage of the specified stream with the following character format:</p>
	<table>		<table>
	<tr>		<tr>
	<td>Describes </td>		<td>Describes</td>
	<td>LENGTH </td>		<td>LENGTH</td>
	<td>Displays</td>		<td>Displays</td>
	</tr>		</tr>

Mlarocca: Mlarocca moved page $VIEW to $View: Lower case change

2014-07-31T18:53:35Z

Mlarocca moved page $VIEW to $View: Lower case change

← Older revision	Revision as of 18:53, 31 July 2014
(No difference)

Mlarocca at 18:02, 31 July 2014

2014-07-31T18:02:25Z

← Older revision		Revision as of 18:02, 31 July 2014
Line 95:		Line 95:
	<td>'SLSTATS'</td>		<td>'SLSTATS'</td>
	<td>'USERID'</td>		<td>'USERID'</td>
	<td>[[$~~USERID~~]]</td>		<td>[[$Userid]]</td>
	</tr>		</tr>
	<tr>		<tr>

Dme at 20:04, 11 June 2014

2014-06-11T20:04:14Z

← Older revision		Revision as of 20:04, 11 June 2014
Line 100:		Line 100:
	<td>'SLSTATS'</td>		<td>'SLSTATS'</td>
	<td>'ACCOUNT'</td>		<td>'ACCOUNT'</td>
	<td>[[$~~ACCOUNT~~]]</td>		<td>[[$Account]]</td>
	</tr>		</tr>
	<tr>		<tr>

Alex: Automatically generated page update

2013-04-20T13:18:36Z

Automatically generated page update

New page

The $VIEW function returns:
<ul>
<li>The value of a parameter (system, file, or user) to the request</li>
</li>
<li>File parameters</li>
While $VIEW works for all viewable parameters in local context, it does not work for some file parameters in remote context.
</li>
<li>Size and use of journal and checkpoint streams</li>
</li>
</ul>
Syntax to view a parameter value
The format of the $VIEW function to view parameter values is: 
$VIEW(parameter[,name])

where:
<ul>
<li>parameter is a character string that represents the name of a viewable <var class="product">Model 204</var> parameter or other information. For example:</li>
$VIEW('ERASE')

returns a value of @ if the ERASE parameter is set to the character @. If the parameter name is invalid or the user is not authorized to display parameter values for the file, a null string is returned.
</li>
<li>name overrides the default file or group context for the function. The format for this argument is:</li>
[[FILE | [PERM | TEMP] GROUP] name | $CURFILE

| $UPDATE] [AT location]

If this argument is omitted or null, the default context is the context of the statement containing the function. Thus, a default context is required for this function.
You can specify $CURFILE as the name argument in place of a file/group name. 
</li>
</ul>
Viewing file-specific information
In addition to viewable parameters, the following file-specific information can also be viewed with $VIEW:
<table>
<tr class="head">
<th>Name used with $VIEW</th>
<th>Description</th>
</tr>
<tr>
<td>DTSLBOPR</td>
<td>
Date and time transaction was backed out during roll forward (for TBO files)
Date and time partial transaction was applied during roll forward (for non-TBO files)
</td>
</tr>
<tr>
<td>DTSLCHKP</td>
<td>Date and time of last checkpoint rolled back to. Will be blank if the file has also been rolled forward.</td>
</tr>
<tr>
<td>DTSLRCVY</td>
<td>Date and time of last recovery</td>
</tr>
<tr>
<td>DTSLUPDT</td>
<td>Date and time of last update</td>
</tr>
<tr>
<td>DTSLDKWR</td>
<td>Date and time of last DKWR</td>
</tr>
<tr>
<td>DTSLRFWD</td>
<td>Date and time of last roll forward</td>
</tr>
<tr>
<td>FIWHEN</td>
<td>Date and time FISTAT was reset</td>
</tr>
<tr>
<td>FIWHO</td>
<td>Terminal ID that reset FISTAT</td>
</tr>
</table>
For example:
$VIEW ('FIWHEN')

returns:
FIWHEN 94.257 SEP 14 16.40.45. DATE AND TIME FISTAT WAS RESET

Syntax for viewing statistics fields
The first argument is the category, SLSTATS, SYSSTATS, or USRSTATS. The second argument is the name of the Statistic field to return. See the Rocket <var class="product">Model 204</var> System Managers Guide for the name of the statistics fields.
$VIEW(category, field-to-return)

Where the following categories and fields are valid: 
<table>
<caption>Valid categories and fields with $VIEW</caption>
<tr class="head">
<th>
Category</th>
<th>Statistics field-to-return</th>
<th>
Equivalent-to or returns-value-of</th>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'USERID'</td>
<td>[[$USERID]]</td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'ACCOUNT'</td>
<td>[[$ACCOUNT]]</td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'SUBSYSTEM'</td>
<td>$SUBSYS with no argument</td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'LAST'</td>
<td>LAST=field</td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'PROC-FILE'</td>
<td>Current procedure file</td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'PROC'</td>
<td>Current procedure </td>
</tr>
<tr>
<td>'SLSTATS'</td>
<td>'sl statistics name'</td>
<td>Statistics field</td>
</tr>
<tr>
<td>'SYSSTATS'</td>
<td>'system stat name'</td>
<td>Statistics field</td>
</tr>
<tr>
<td>'SYSSTATS'</td>
<td>'DKBM stat name'</td>
<td>Statistics field</td>
</tr>
<tr>
<td>'USRSTATS'</td>
<td>'user stat name'</td>
<td>Statistics field</td>
</tr>
<tr>
<td>'USRSTATS'</td>
<td>'conflict ctr name'</td>
<td>Statistics field</td>
</tr>
</table>
Usage
The time related Since Last statistics fields, CNCT, CPU, SCHDCPU, and STCPU, are not valid during evaluation time.
Specifying an invalid statistics field name returns a null value with the message:
M204.1463: INVALID PARAMETER: fieldname

Syntax to view the size and use of journal and checkpoint streams
The format of $VIEW for the use and size of journal and checkpoint streams is:
$VIEW('CCAJRNL'|'CCAJLOG'|'CHKPOINT'|'CHKPNTS')

Specify the following:
%STRING = $VIEW('CCAJRNL'|'CCAJLOG'|'CHKPOINT'|'CHKPNTS')

$VIEW returns a string that describes the usage of the specified stream with the following character format:
<table>
<tr>
<td>Describes </td>
<td>LENGTH </td>
<td>Displays</td>
</tr>
<tr>
<td>In use DDNAME</td>
<td align="right">8</td>
<td>Alphanumeric characters</td>
</tr>
<tr>
<td>Percentage used </td>
<td align="right">4</td>
<td>Integer with percentage sign</td>
</tr>
<tr>
<td>Maximum size </td>
<td align="right">9</td>
<td>Number of tracks</td>
</tr>
<tr>
<td>Current size </td>
<td align="right">9</td>
<td>Number of tracks</td>
</tr>
<tr>
<td>Unused spaces </td>
<td align="right">2</td>
<td>Number of tracks</td>
</tr>
<tr>
<td>VOLSER </td>
<td align="right">6</td>
<td>Alphanumeric characters</td>
</tr>
<tr>
<td>Separating back slash </td>
<td align="right">1</td>
<td>A back slash</td>
</tr>
<tr>
<td>Data set name</td>
<td>Variable</td>
<td>Data set name</td>
</tr>
<tr>
<td>Separating back slash</td>
<td align="right">1</td>
<td>A back slash</td>
</tr>
<tr>
<td>Generation number </td>
<td>Variable</td>
<td>Generation number with a leading plus sign</td>
</tr>
</table>
You must ensure that the %variable being used to hold the requested information is defined as STRING LEN 80 or greater, for example:
%STRING IS STRING LEN 80

BEGIN
%STRING = $VIEW('CCAJRNL')
PRINT %STRING
END

CCAJRNL 0% 37 0 0SU000\OHIO1.ONLINE.JOURNAL

[[Category:SOUL $functions]]