FUNPRMU parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (misc formatting)
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page is [[under construction]] and the feature being proposed is tentative - not even yet ready for <span style="color:red">&#x3B2;eta</span> testing.
{{Template:FUNPRMU parameter subtitle}}
 
<span class="pageSubtitle">User-level Fast/Unload flags</span>
==Summary==
==Summary==
<dl>
<dl>
Line 11: Line 10:
<dd>Any user
<dd>Any user
<dt>Related products
<dt>Related products
<dd>[[Fast/Unload|Fast/Unload User Language Interface]]
<dd>[[Fast/Unload|Fast/Unload SOUL Interface]]
<dt>Introduced
<dt>Introduced
<dd><var class="product">Sirius Mods</var> 8.1
<dd><var class="product">[[Sirius Mods]]</var> 8.1 (for the most part, this parameter is ignored without the corresponding feature introduced in version 4.7 of <var class="product">[[Fast/Unload]]</var>)
</dl>
</dl>
==Description==
==Description==
This is a bitmask parameter that controls auditing of messages with the <var class="product">Fast/Unload User Language Interface</var>,
This parameter, together with the <var>[[FUNPARM parameter|FUNPARM]]</var> system parameter,
where the bits mean:
controls the auditing of messages when using the <var class="product">[[Fast/Unload SOUL Interface]]</var>.
<dl>
These parameters can be used to augment the availability of auditing information, in such a way that the user or the system manager can
<dt>X'02'
ensure that information is available for a single job or all jobs, without changes to any SOUL program invoking <var>[[FastUnload (Recordset function)|FastUnload]]</var>, <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var>, or <var>[[$Funload]]</var>.
<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.
Without the use of these parameters, some auditing information may be available from the <var>FUNAUDIT</var> dataset, but that information may be inadequate:
<dt>X'04'
for example, messages from a job initiated by the <var>FastUnload</var> method will not be in <var>FUNAUDIT</var> if its <var>Report</var> parameter is used.
<dd>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages, except lines issued by the <var>REPORT</var> statement and the "Field statistics" lines, are always audited, whether or not a request has a <var class="product">Fast/Unload</var> report argument.
The X'02' bit need not be set if the X'04' bit is set.
This is a bitmask parameter where the bits mean:
<dt>X'08'
<table class="thJustBold">
<dd>If the X'02' or X'04' bit is on, this bit causes all messages thus selected to be sent to the <var class="product">Model 204</var> audit trail, whether or not the <code>FUNAUDIT</code> DDname is present. When this bit is on, then the X'02' and X'04' bits do not affect any output to <code>FUNAUDIT</code>.
<tr><th>X'02'</th>
<td>Indicates that "basic" <var class="product">Fast/Unload</var> messages for this user are always audited, regardless of the presence of a <var class="product">Fast/Unload SOUL Interface</var> "report" argument.</td></tr>
 
<tr><th>X'04'</th>
<td>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages for this user, except "Field statistics", are always audited, regardless of the presence of a <var class="product">Fast/Unload SOUL Interface</var> "report" argument. The X'02' bit need not be set if the X'04' bit is set.</td></tr>
 
<tr><th>X'08'</th>
<td>Indicates that "basic" <var class="product">Fast/Unload</var> messages for this user are always audited in the <var class="product">Model&nbsp;204</var> audit trail, whether or not the <code>FUNAUDIT</code> DD name is present. If the X'04' bit is on, <b>all</b> messages are audited there as well.
<p>
In the odd case that there is no <var class="product">Model 204</var> audit trail, the X'08' bit is ignored, but auditing is performed as if the X'02' bit were on, whether it is or not.
</p></td></tr>
</table>
<p class="note">'''Note:''' The X'01' bit is not used by <var>FUNPRMU</var>.</p>
 
For both of the <var>FUNPRMU</var> X'02' and X'04' bits, the same bit has the same meaning in the <var>FUNPARM</var> system parameter; the indicated effect takes place if either of the <var>FUNPRMU</var> or <var>FUNPARM</var> bits are on.
That is also true for the X'08' bit, although there are some additional details for the X'08' bit which generally you don't need
to concern yourself with, but are explained as part of the more detailed
discussion in [[#Fast/Unload report processing|Fast/Unload report processing]], below.
 
Using the X'02', X'04', and X'08' bits of the <var>FUNPRMU</var> user parameter and the <var>FUNPARM</var> system parameter is fairly straightforward, and the above description should be adequate to use them. A complete description of the processing triggered by these bits is presented in the "Fast/Unload report processing" section, next.
===Fast/Unload report processing===
Every <var class="product">Fast/Unload SOUL Interface</var> job has a "report," which may contain many <var class="product">Fast/Unload</var> messages (it contains at least the
<code>FUNL0004</code> message line indicating the end of the job).
Each SOUL invocation (of <var>FastUnload</var>, for example) can designate a DD name or <var>Stringlist</var> or <var>$list</var> destination for the report. Or the invocation can omit the destination, in which case the report is sent to the <var>FUNAUDIT</var> dataset,
if there is one, or otherwise to the <var class="product">Model 204</var> audit trail.
The <var>FUNPARM</var> and <var>FUNPRMU</var> parameters allow the <b>auditing</b> of some of the messages from the report to be captured on <var>FUNAUDIT</var> and/or
the <var class="product">Model&nbsp;204</var> audit trail, regardless of the designation of the report destination in the various SOUL invocations of the <var class="product">Fast/Unload SOUL Interface</var>.
The effect of these parameters is based on their values at the time that SOUL invokes a
<var class="product">Fast/Unload SOUL Interface</var> job; they are explained for each form of report destination in the following table:
<table>
<tr><td>If the report's destination is <code>FUNAUDIT</code></td>
<td><ul>
<li>If <b>either</b> <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>, the <var>AllMessages</var> argument is set to <code>True</code> (or for <var>$Funload</var>, the <code>ALLMSG</code> option is added) and the <code>LIST</code> option is added, so that <code>FUNAUDIT</code> contains the list of <var class="product">Fast/Unload</var> parameter settings and the FUEL program listing. </li>
 
<li>Otherwise, <code>FUNAUDIT</code> is not affected by these parameters, but audited information is present in the <var class="product">Model&nbsp;204</var> audit trail if either parameter has the X'08' bit on.</li>
</ul></td></tr>
 
<tr><td>If the report's destination is the <var class="product">Model&nbsp;204</var> audit trail</td>
<td><ul>
<li>If <b>either</b> <var>FUNPARM</var> or <var>FUNPRMU</var> has the <b>X'04'</b> bit <b>on</b>, the <var>AllMessages</var> argument is set to <code>True</code> (or for <var>$Funload</var>, the <code>ALLMSG</code> option is added) and the <code>LIST</code> option is added, so the <var class="product">Model&nbsp;204</var> audit trail contains the list of <var class="product">Fast/Unload</var> parameter settings and the FUEL program listing. </li>
 
<li>Otherwise, the <var class="product">Model 204</var> audit trail is not affected by these parameters, and they do not provide extra auditing for this invocation.</li></ul></td></tr>
 
<tr><td>Otherwise (the report's destination is a<var>Stringlist</var> or <var>$list</var> or a data set with a DD name other than <code>FUNAUDIT</code>)</td>
<td><ul>
<li>If <b>either</b> <var>FUNPARM</var> or <var>FUNPRMU</var> has <b>any</b> of the <b>X'08'</b>, <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>
 
<li>If <b>either</b> <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 the FUEL program listing. </li>


If the X'08' bit is <b>not</b> on, and there as a <code>FUNAUDIT</code> DDname, then any extra auditing selected by X'02' or X'04' goes to <code>FUNAUDIT</code> and no <var class="product">Fast/Unload</var> messages are sent to the <var class="product">Model 204</var> audit trial.
<li>If <b>both</b> <var>FUNPARM</var> and <var>FUNPRMU</var> have the <b>X'08'</b> bit <b>off</b>, the audit stream is sent to <code>FUNAUDIT</code> (if that DD name is present; otherwise the stream is sent to the <var class="product">Model 204</var> audit trail). </li>


In the odd case that there is no <var class="product">Model 204</var> audit trail, the X'80' bit is ignored (treated as if it were zero).
<li>If <b>both</b> <var>FUNPARM</var> and <var>FUNPRMU</var> have the <b>X'08'</b> bit <b>on</b>, the audit stream is sent to the <var class="product">Model 204</var> audit trail. </li>
</dl>


For each of the <var>FUNPRMU</var> bits X'02', X'04', and X'08', the same bit has the same meaning in the <var>[[FUNPARM parameter|FUNPARM]]</var> system parameter;  the indicated effect takes place if either of the <var>FUNPRMU</var> or <var>FUNPARM</var> bits is on.
<li>If <b>one</b> of <var>FUNPARM</var> and <var>FUNPRMU</var> has the <b>X'08'</b> bit <b>on</b> and the <b>other</b> has it <b>off</b>, the audit stream is sent:
<ul>
<li>Only to the <var class="product">Model 204</var> audit trail, if there is no <code>FUNAUDIT</code> DD name present. </li>


Note that the X'01' bit is not used by <var>FUNPRMU</var>.
<li>Both to the <var class="product">Model 204</var> audit trail and to <code>FUNAUDIT</code>, if the parameter that has the X'08' bit off also has the X'04' or X'02' bit on.
<li>Otherwise (the parameter that has the X'08' bit off also has both the X'04' and X'02' bits off), only to the <var class="product">Model 204</var> audit trail.</li></ul>
</li></ul>
</td></tr>
</table>
[[Category:User parameters]]
[[Category:User parameters]]
[[Category:Parameters]]
[[Category:Parameters]]
[[Category:Fast/Unload User Language Interface]]
[[Category:Fast/Unload SOUL Interface]]

Latest revision as of 20:50, 16 April 2015

Fast/Unload user flags

Summary

Default value
X'00'
Parameter type
User
Where set
Any user
Related products
Fast/Unload SOUL Interface
Introduced
Sirius Mods 8.1 (for the most part, this parameter is ignored without the corresponding feature introduced in version 4.7 of Fast/Unload)

Description

This parameter, together with the FUNPARM system parameter, controls the auditing of messages when using the Fast/Unload SOUL Interface. These parameters can be used to augment the availability of auditing information, in such a way that the user or the system manager can ensure that information is available for a single job or all jobs, without changes to any SOUL program invoking FastUnload, FastUnloadTask, or $Funload. Without the use of these parameters, some auditing information may be available from the FUNAUDIT dataset, but that information may be inadequate: for example, messages from a job initiated by the FastUnload method will not be in FUNAUDIT if its Report parameter is used.

This is a bitmask parameter where the bits mean:

X'02' Indicates that "basic" Fast/Unload messages for this user are always audited, regardless of the presence of a Fast/Unload SOUL Interface "report" argument.
X'04' Indicates that all Fast/Unload messages for this user, except "Field statistics", are always audited, regardless of the presence of a Fast/Unload SOUL Interface "report" argument. The X'02' bit need not be set if the X'04' bit is set.
X'08' Indicates that "basic" Fast/Unload messages for this user are always audited in the Model 204 audit trail, whether or not the FUNAUDIT DD name is present. If the X'04' bit is on, all messages are audited there as well.

In the odd case that there is no Model 204 audit trail, the X'08' bit is ignored, but auditing is performed as if the X'02' bit were on, whether it is or not.

Note: The X'01' bit is not used by FUNPRMU.

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 are on. That is also true for the X'08' bit, although there are some additional details for the X'08' bit which generally you don't need to concern yourself with, but are explained as part of the more detailed discussion in Fast/Unload report processing, below.

Using the X'02', X'04', and X'08' bits of the FUNPRMU user parameter and the FUNPARM system parameter is fairly straightforward, and the above description should be adequate to use them. A complete description of the processing triggered by these bits is presented in the "Fast/Unload report processing" section, next.

Fast/Unload report processing

Every Fast/Unload SOUL Interface job has a "report," which may contain many Fast/Unload messages (it contains at least the FUNL0004 message line indicating the end of the job). Each SOUL invocation (of FastUnload, for example) can designate a DD name or Stringlist or $list destination for the report. Or the invocation can omit the destination, in which case the report is sent to the FUNAUDIT dataset, if there is one, or otherwise to the Model 204 audit trail.

The FUNPARM and FUNPRMU parameters allow the auditing of some of the messages 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 SOUL invocations of the Fast/Unload SOUL Interface.

The effect of these parameters is based on their values at the time that SOUL invokes a Fast/Unload SOUL Interface job; they are explained for each form of report destination in the following table:

If the report's destination is FUNAUDIT
  • If either FUNPARM or FUNPRMU has the X'08' bit off and the X'04' bit on, the AllMessages argument is set to True (or for $Funload, the ALLMSG option is added) and the LIST option is added, so that FUNAUDIT contains the list of Fast/Unload parameter settings and the FUEL program listing.
  • Otherwise, FUNAUDIT is not affected by these parameters, but audited information is present in the Model 204 audit trail if either parameter has the X'08' bit on.
If the report's destination is the Model 204 audit trail
  • If either FUNPARM or FUNPRMU has the X'04' bit on, the AllMessages argument is set to True (or for $Funload, the ALLMSG option is added) and the LIST option is added, so the Model 204 audit trail contains the list of Fast/Unload parameter settings and the FUEL program listing.
  • Otherwise, the Model 204 audit trail is not affected by these parameters, and they do not provide extra auditing for this invocation.
Otherwise (the report's destination is aStringlist or $list or a data set with a DD name other than FUNAUDIT)
  • If either FUNPARM or FUNPRMU has any of the X'08', 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 the FUEL program listing.
  • If both FUNPARM and FUNPRMU have the X'08' bit off, the audit stream is sent to FUNAUDIT (if that DD name is present; otherwise the stream is sent to the Model 204 audit trail).
  • If both FUNPARM and FUNPRMU have the X'08' bit on, the audit stream is sent to the Model 204 audit trail.
  • If one of FUNPARM and FUNPRMU has the X'08' bit on and the other has it off, the audit stream is sent:
    • Only to the Model 204 audit trail, if there is no FUNAUDIT DD name present.
    • Both to the Model 204 audit trail and to FUNAUDIT, if the parameter that has the X'08' bit off also has the X'04' or X'02' bit on.
    • Otherwise (the parameter that has the X'08' bit off also has both the X'04' and X'02' bits off), only to the Model 204 audit trail.