FUNPRMU parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 22: Line 22:
controls auditing of messages with the <var class="product">[[Fast/Unload User Language Interface]]</var>.
controls auditing of messages with the <var class="product">[[Fast/Unload User Language Interface]]</var>.
They are intended to augment the availability of auditing information, in such a way that the user or the system manager can
They are intended to augment the availability of auditing information, in such a way that the user or the system manager can
ensure that the information is available for a single request or all requests, without any changes to a User Language
ensure that the information is available for a single job or all jobs, without any changes to a User Language
program invoking <var>[[FastUnload (Recordset function)|FastUnload]]</var>, <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var>, or <var>[[$Funload]]</var>.
program invoking <var>[[FastUnload (Recordset function)|FastUnload]]</var>, <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var>, or <var>[[$Funload]]</var>.
Without the use of these parameters,
Without the use of these parameters,
some auditing information may be available from the <code>FUNAUDIT</code> DDname, but,
some auditing information may be available from the <code>FUNAUDIT</code> DDname, but,
for example, messages from a <var>FastUnload</var> request will not be in <code>FUNAUDIT</code> if the
for example, messages from a <var>FastUnload</var> job will not be in <code>FUNAUDIT</code> if the
<var>Report</var> parameter is used.
<var>Report</var> parameter is used.
   
   
Line 32: Line 32:
<dl>
<dl>
<dt>X'02'
<dt>X'02'
<dd>Indicates that "basic" <var class="product">Fast/Unload</var> messages are always audited, whether or not a request has a <var class="product">Fast/Unload</var> report argument.
<dd>Indicates that "basic"
<var class="product">Fast/Unload</var>
messages are always audited, regardless of the presence of
a <var class="product">Fast/Unload User Language Interface</var>
report argument.
<dt>X'04'
<dt>X'04'
<dd>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages, except "Field statistics"
<dd>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages, except "Field statistics"
and <var>REPORT</var> statement lines,
and <var>REPORT</var> statement lines,
are always audited, whether or not a request has a <var class="product">Fast/Unload</var> report argument.
are always audited, regardless of the presence of a
<var class="product">Fast/Unload User Language Interface</var>
report argument.
The X'02' bit need not be set if the X'04' bit is set.
The X'02' bit need not be set if the X'04' bit is set.
<dt>X'08'
<dt>X'08'
Line 47: Line 53:
   
   
For the X'08' bit:
For the X'08' bit:
<ul>
<ul>
<li>If both <var>FUNPARM</var> and <var>FUNPRMU</var> have the X'08' bit on,
<li>If both <var>FUNPARM</var> and <var>FUNPRMU</var> have the X'08' bit on,
then the X'02' and X'04' bits do not affect any output to <code>FUNAUDIT</code>.
then the X'02' and X'04' bits do not affect any output to <code>FUNAUDIT</code>.
<li>If either <var>FUNPARM</var> or <var>FUNPRMU</var> has the X'08' bit on and the other has it off,
and there is a <code>FUNAUDIT</code> DDname, then any extra auditing
selected by X'02' or X'04' goes both to <code>FUNAUDIT</code> and to the <var class="product">Model 204</var> audit trial.
</ul>
</ul>
In other words:
===Fast/Unload report processing===
<ul>
Every <var class="product">Fast/Unload User Language Interface</var> job has a "report", which contains at least the
<li>If the X'08' bit is <b>on in either</b> <var>FUNPARM</var> or <var>FUNPRMU</var>, then messages selected by the collective
line indicating the end of the job.
X'02' and X'04' bits will go to the <var class="product">Model 204</var> <b>audit trial</b>.
The User Language invocation (of <var>FastUnload</var>, for example) can designate a DDname or <var>Stringlist</var> or <var>$list</var>
<li>If the X'08' bit is <b>off in either</b> <var>FUNPARM</var> or <var>FUNPRMU</var>, then messages selected by the collective
destination for the report, or it can omit the destination, in which case the report is sent to the <code>FUNAUDIT</code> DDname,
X'02' and X'04' bits will go to <b><code>FUNAUDIT</code></b> if it is present.
if there is one, or otherwise to the <var class="product">Model 204</var> audit trail.
</ul>
Finally, setting any of the X'02', X'04', or X'08' bits of either <var>FUNPARM</var> or <var>FUNPRMU</var> to one will not cause messages to be removed from <code>FUNAUDIT</code> which occur there when all of those bits are zero.
The <var>FUNPARM</var> and <var>FUNPRMU</var> parameters
 
allow the <var>auditing</var> of some of the information from the report to be captured on <code>FUNAUDIT</code> and/or
the <var class="product">Model 204</var> audit trail, regardless of the designation of the report destination in the
various User Language invocations of the
<var class="product">Fast/Unload User Language Interface</var>.
The effect of these parameters is shown in the following table; it
is based on the values of the
parameters when User Language invokes a
<var class="product">Fast/Unload User Language Interface</var>
job.
<table>
<tr><td>If the report's destination is <code>FUNAUDIT</code></td>
<td><ul><li>If either <var>FUNPARM</var> or <var>FUNPRMU</var> has the <b>X'08'</b> bit <b>off</b> and the <b>X'04'</b> bit <b>on</b>, it is ensured that <code>FUNAUDIT</code> will contain the list of <var class="product">Fast/Unload</var> parameter settings and of the FUEL program.<li>Otherwise, <code>FUNAUDIT</code> is not affected by these parameters.</ul></td></tr>
<tr><td>If the report's destination is the <var class="product">Model 204</var> audit trail</td>
<td><ul><li>If either <var>FUNPARM</var> or <var>FUNPRMU</var> has the <b>X'04'</b> bit <b>on</b>, it is ensured that the <var class="product">Model 204</var> audit trail will contain the list of <var class="product">Fast/Unload</var> parameter settings and of the FUEL program.<li>Otherwise, the <var class="product">Model 204</var> audit trail is not affected by these parameters.</ul></td></tr>
<tr><td>Otherwise (the report's destination is a DDname - other than <code>FUNAUDIT</code>, a <var>Stringlist</var>, or a <var>$list</var>)</td>
<td><ul><li>If either <var>FUNPARM</var> or <var>FUNPRMU</var> has <b>either</b> of the <b>X'04'</b> or <b>X'02'</b> bits <b>on</b>, an "audit" stream is produced for the job, containing at least the job's "basic" <var class="product">Fast/Unload</var> messages.<li>If either <var>FUNPARM</var> or <var>FUNPRMU</var> has the <b>X'04'</b> bit <b>on</b>, this will also contain the list of <var class="product">Fast/Unload</var> parameter settings and of the FUEL program.<li>??</ul></td></tr>
</table>
Note that the X'01' bit is not used by <var>FUNPRMU</var>.
Note that the X'01' bit is not used by <var>FUNPRMU</var>.
[[Category:User parameters]]
[[Category:User parameters]]
[[Category:Parameters]]
[[Category:Parameters]]
[[Category:Fast/Unload User Language Interface]]
[[Category:Fast/Unload User Language Interface]]

Revision as of 20:21, 12 July 2012

This page is under construction and the feature being proposed is tentative - not even yet ready for βeta testing.

User-level Fast/Unload flags

Summary

Default value
X'00'
Parameter type
User
Where set
Any user
Related products
Fast/Unload User Language Interface
Introduced
Sirius Mods 8.1

Description

This parameter, together with the FUNPARM system parameter, controls auditing of messages with the Fast/Unload User Language Interface. They are intended to augment the availability of auditing information, in such a way that the user or the system manager can ensure that the information is available for a single job or all jobs, without any changes to a User Language program invoking FastUnload, FastUnloadTask, or $Funload. Without the use of these parameters, some auditing information may be available from the FUNAUDIT DDname, but, for example, messages from a FastUnload job will not be in FUNAUDIT if the Report parameter is used.

This is a bitmask parameter where the bits mean:

X'02'
Indicates that "basic" Fast/Unload messages are always audited, regardless of the presence of a Fast/Unload User Language Interface report argument.
X'04'
Indicates that all Fast/Unload messages, except "Field statistics" and REPORT statement lines, are always audited, regardless of the presence of a Fast/Unload User Language Interface report argument. The X'02' bit need not be set if the X'04' bit is set.
X'08'
If the X'02' or X'04' bit is on, the X'08' bit causes all messages thus selected to be sent to the Model 204 audit trail, whether or not the FUNAUDIT DDname is present. In the odd case that there is no Model 204 audit trail, the X'08' bit is ignored (treated as if it were zero).

For both of the FUNPRMU X'02' and X'04' bits, the same bit has the same meaning in the FUNPARM system parameter; the indicated effect takes place if either of the FUNPRMU or FUNPARM bits is on.

For the X'08' bit:

  • If both FUNPARM and FUNPRMU have the X'08' bit on, then the X'02' and X'04' bits do not affect any output to FUNAUDIT.

Fast/Unload report processing

Every Fast/Unload User Language Interface job has a "report", which contains at least the line indicating the end of the job. The User Language invocation (of FastUnload, for example) can designate a DDname or Stringlist or $list destination for the report, or it can omit the destination, in which case the report is sent to the FUNAUDIT DDname, if there is one, or otherwise to the Model 204 audit trail.

The FUNPARM and FUNPRMU parameters allow the auditing of some of the information from the report to be captured on FUNAUDIT and/or the Model 204 audit trail, regardless of the designation of the report destination in the various User Language invocations of the Fast/Unload User Language Interface.

The effect of these parameters is shown in the following table; it is based on the values of the parameters when User Language invokes a Fast/Unload User Language Interface job.

If the report's destination is FUNAUDIT
  • If either FUNPARM or FUNPRMU has the X'08' bit off and the X'04' bit on, it is ensured that FUNAUDIT will contain the list of Fast/Unload parameter settings and of the FUEL program.
  • Otherwise, FUNAUDIT is not affected by these parameters.
If the report's destination is the Model 204 audit trail
  • If either FUNPARM or FUNPRMU has the X'04' bit on, it is ensured that the Model 204 audit trail will contain the list of Fast/Unload parameter settings and of the FUEL program.
  • Otherwise, the Model 204 audit trail is not affected by these parameters.
Otherwise (the report's destination is a DDname - other than FUNAUDIT, a Stringlist, or a $list)
  • If either FUNPARM or FUNPRMU has either of the X'04' or X'02' bits on, an "audit" stream is produced for the job, containing at least the job's "basic" Fast/Unload messages.
  • If either FUNPARM or FUNPRMU has the X'04' bit on, this will also contain the list of Fast/Unload parameter settings and of the FUEL program.
  • ??

Note that the X'01' bit is not used by FUNPRMU.