FUNPARM parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
m (UL Interface becomes SOUL Interface)
Line 9: Line 9:
<dd>System manager resettable
<dd>System manager resettable
<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> 6.7
<dd><var class="product">[[Sirius Mods]]</var> 6.7
Line 15: Line 15:


==Description==
==Description==
This is a bitmask parameter that controls the behavior of the <var class="product">[[Fast/Unload User Language Interface]]</var>,
This is a bitmask parameter that controls the behavior of the <var class="product">[[Fast/Unload SOUL Interface]]</var>, where the bits mean:
where the bits mean:
<table class="thJustBold">
<dl>
<tr><th>X'01'</th>
<dt>X'01'
<td>Indicates that a synchronous <var class="product">[[Fast/Unload]]</var> request is not to be allowed while an updating transaction is active.
<dd>Indicates that a synchronous [[Fast/Unload]] request is not to be allowed while
This is to prevent a <var class="product">Fast/Unload</var> request that might take a long time to complete from being run while a user has resources enqueued for an updating
an updating transaction is active.
transaction. These resources would, of course, include the blocking of checkpoints if
This is to prevent a <var class="product">Fast/Unload</var> request that might take a long time to
complete from being run while a user has resources enqueued for an updating
transaction.
These resources would, of course, include the blocking of checkpoints if
subtransaction checkpoints are not being used.
subtransaction checkpoints are not being used.
 
<p>
If the X'01' bit is set, and a thread attempts a synchronous <var class="product">Fast/Unload User Language Interface</var>
If the X'01' bit is set, and a thread attempts a synchronous <var class="product">Fast/Unload SOUL Interface</var> request (either via <var>$Funload</var> or the <var>[[FastUnload (Recordset function)|FastUnload]]</var> method of the <var>Recordset</var> class)
request (either via <var>$Funload</var> or the <var>[[FastUnload (Recordset function)|FastUnload]]</var> method of the <var>Recordset</var> class)
in the middle of an updating transaction, the transaction will be cancelled with a message like the following: </p>
in the middle of an updating transaction, the transaction will be cancelled
with a message like the following:
<p class="code">CANCELLING REQUEST: MSIR.0561: $FUNLOAD: Synchronous request during
<p class="code">CANCELLING REQUEST: MSIR.0561: $FUNLOAD: Synchronous request during
                     update transaction in line 43, procedure FUNTEST,
                     update transaction in line 43, procedure FUNTEST,
                     file ALEXPROC  </p>
                     file ALEXPROC  </p></td></tr>
<dt>X'02'
 
<dd>Indicates that "basic"
<tr><th>X'02'</th>
<var class="product">Fast/Unload</var>
<td>Indicates that "basic" <var class="product">Fast/Unload</var> messages for all users are always audited, regardless of the presence of a <var class="product">Fast/Unload SOUL Interface</var> "report" argument.</td></tr>
messages for all users are always audited, regardless of the presence of
 
a <var class="product">Fast/Unload User Language Interface</var>
<tr><th>X'04'</th>
"report" argument.
<td>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages for all users, except "Field statistics", are always audited, regardless of the presence of a
<dt>X'04'
<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>
<dd>Indicates that <b>all</b> <var class="product">Fast/Unload</var> messages for all users, except "Field statistics",
 
are always audited, regardless of the presence of a
<tr><th>X'08'</th>
<var class="product">Fast/Unload User Language Interface</var>
<td>Indicates that "basic" <var class="product">Fast/Unload</var> messages for all users are always audited in the <var class="product">Model 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.
"report" argument.
<p>
The X'02' bit need not be set if the X'04' bit is set.
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>
<dt>X'08'
</table>
<dd>Indicates that "basic"
<var class="product">Fast/Unload</var>
messages for all users are always audited in the
<var class="product">Model 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.
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.
</dl>


For both of the <var>FUNPARM</var> X'02' and X'04' bits, the same bit has the same meaning (for an individual user) in the <var>[[FUNPRMU parameter|FUNPRMU]]</var> user parameter; the indicated effect takes place if either of the <var>FUNPRMU</var> or <var>FUNPARM</var> bits are on.
For both of the <var>FUNPARM</var> X'02' and X'04' bits, the same bit has the same meaning (for an individual user) in the <var>[[FUNPRMU parameter|FUNPRMU]]</var> user parameter; the indicated effect takes place if either of the <var>FUNPRMU</var> or <var>FUNPARM</var> bits are on.
Line 63: Line 48:


The X'02', X'04', and X'08' bits of this parameter, together with the same bits of <var>FUNPRMU</var>,
The X'02', X'04', and X'08' bits of this parameter, together with the same bits of <var>FUNPRMU</var>,
control the auditing of messages when using the <var class="product">Fast/Unload User Language Interface</var>.
control the auditing of messages when using the <var class="product">Fast/Unload SOUL Interface</var>.
These parameters can be used to augment the availability of auditing information, in such a way that the user or the system manager can
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 User Language
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>.
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> dataset, but that information may be inadequate:
some auditing information may be available from the <code>FUNAUDIT</code> dataset, but that information may be inadequate:
for example, messages from a <var>FastUnload</var> job 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.


The X'02', X'04', and X'08' bits are new in version 8.1 of the <var class="product">Sirius Mods</var>, and these bits are ignored without the corresponding feature introduced in version 4.7 of <var class="product">Fast/Unload</var>.
The X'02', X'04', and X'08' bits are new in version 8.1 of the <var class="product">Sirius Mods</var>, and these bits are ignored without the corresponding feature introduced in version 4.7 of <var class="product">Fast/Unload</var>.
Line 78: Line 62:
[[Category:System parameters]]
[[Category:System parameters]]
[[Category:Parameters]]
[[Category:Parameters]]
[[Category:Fast/Unload User Language Interface]]
[[Category:Fast/Unload SOUL Interface]]

Revision as of 21:18, 16 March 2015

Fast/Unload system flags

Summary

Default value
X'00'
Parameter type
System
Where set
System manager resettable
Related products
Fast/Unload SOUL Interface
Introduced
Sirius Mods 6.7

Description

This is a bitmask parameter that controls the behavior of the Fast/Unload SOUL Interface, where the bits mean:

X'01' Indicates that a synchronous Fast/Unload request is not to be allowed while an updating transaction is active.

This is to prevent a Fast/Unload request that might take a long time to complete from being run while a user has resources enqueued for an updating transaction. These resources would, of course, include the blocking of checkpoints if subtransaction checkpoints are not being used.

If the X'01' bit is set, and a thread attempts a synchronous Fast/Unload SOUL Interface request (either via $Funload or the FastUnload method of the Recordset class) in the middle of an updating transaction, the transaction will be cancelled with a message like the following:

CANCELLING REQUEST: MSIR.0561: $FUNLOAD: Synchronous request during update transaction in line 43, procedure FUNTEST, file ALEXPROC

X'02' Indicates that "basic" Fast/Unload messages for all users are always audited, regardless of the presence of a Fast/Unload SOUL Interface "report" argument.
X'04' Indicates that all Fast/Unload messages for all users, 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 all users 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.

For both of the FUNPARM X'02' and X'04' bits, the same bit has the same meaning (for an individual user) in the FUNPRMU user 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 Fast/Unload report processing discussion.

The X'02', X'04', and X'08' bits of this parameter, together with the same bits of FUNPRMU, control 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 FastUnload job will not be in FUNAUDIT if the Report parameter is used.

The X'02', X'04', and X'08' bits are new in version 8.1 of the Sirius Mods, and these bits are ignored without the corresponding feature introduced in version 4.7 of Fast/Unload.

Using the X'02', X'04', and X'08' bits of these parameters 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 discussion.