Fast/Unload SOUL Interface - Revision history

Dme: /* Setting up the FUSI environment */

2016-11-21T21:48:15Z

Setting up the FUSI environment

← Older revision		Revision as of 21:48, 21 November 2016
Line 112:		Line 112:
	To use the <var class="product">FUSI</var>, the system manager must perform the following steps:		To use the <var class="product">FUSI</var>, the system manager must perform the following steps:
	<ol>		<ol>
	<li>If using a version of Model 204 prior to 7.5~~, include~~ the [[Sirius Mods]] in your <code>ONLINE</code> or <code>BATCH204</code> load module.		<li>If using a version of Model 204 prior to 7.5:
	</li>		<ul>
			<li>Include the [[Sirius Mods]] in your <code>ONLINE</code> or <code>BATCH204</code> load module; a load module with the Sirius Mods is necessary to invoke the FUSI.</li>
	<li>Concatenate the load library containing the <var class="product">Fast/Unload</var>		<li>Concatenate the load library containing the <var class="product">Fast/Unload</var>
	load module to the load library containing the <code>ONLINE</code> or <code>BATCH204</code> load module on the <code>STEPLIB</code> DD, or copy the <var class="product">Fast/Unload</var> load module into the load library containing the <code>ONLINE</code> or <code>BATCH204</code> load module.		load module to the load library containing the <code>ONLINE</code> or <code>BATCH204</code> load module on the <code>STEPLIB</code> DD, or copy the <var class="product">Fast/Unload</var> load module into the load library containing the <code>ONLINE</code> or <code>BATCH204</code> load module.
Line 125:		Line 125:
	Under CMS, the <var class="product">Fast/Unload</var> TEXT file must be on a disk accessed by the		Under CMS, the <var class="product">Fast/Unload</var> TEXT file must be on a disk accessed by the
	<var class="product">Model 204</var> <code>ONLINE</code> service machine.</p></li>		<var class="product">Model 204</var> <code>ONLINE</code> service machine.</p></li>
			</ul>
			</li>

	<li>Modify the JCL (or EXEC) used to run the <var class="product">Model 204</var> <code>ONLINE</code> or <code>BATCH204</code> ~~so that it invokes the custom load module from step one, and~~ so that it contains a		<li>Modify the JCL (or EXEC) used to run the <var class="product">Model 204</var> <code>ONLINE</code> or <code>BATCH204</code> so that it contains a
	DD card (or FILEDEF statement) for the <var class="product">Fast/Unload</var> audit trail.		DD card (or FILEDEF statement) for the <var class="product">Fast/Unload</var> audit trail.
	This audit trail has DDNAME <code>FUNAUDIT</code>.		This audit trail has DDNAME <code>FUNAUDIT</code>.

JAL: add link to F/U HPO

2016-03-29T20:56:58Z

add link to F/U HPO

← Older revision		Revision as of 20:56, 29 March 2016
Line 155:		Line 155:
	This causes the single user		This causes the single user
	to perform the work of the <var class="product">Fast/Unload</var> PST whenever a <var>$FunWait</var>, <var>$FunImg</var>, <var>$FunsStr</var>, or <var>$FunSkip</var> is executed.</p></li>		to perform the work of the <var class="product">Fast/Unload</var> PST whenever a <var>$FunWait</var>, <var>$FunImg</var>, <var>$FunsStr</var>, or <var>$FunSkip</var> is executed.</p></li>

			<li>If you want to exploit Model 204 zIIP support, see [[Fast/Unload overview#fuhpo\|Fast/Unload HPO]].</li>
	</ol>		</ol>

JAL: trim parameter info

2016-03-29T18:10:40Z

trim parameter info

← Older revision		Revision as of 18:10, 29 March 2016
Line 126:		Line 126:
	<var class="product">Model 204</var> <code>ONLINE</code> service machine.</p></li>		<var class="product">Model 204</var> <code>ONLINE</code> service machine.</p></li>

	<li>Modify the JCL (or EXEC) used to run the <var class="product">Model 204</var> <code>ONLINE</code> or <code>BATCH204</code> so that it invokes the custom load module from step one, and so that it contains a		<li>Modify the JCL (or EXEC) used to run the <var class="product">Model 204</var> <code>ONLINE</code> or <code>BATCH204</code> so that it invokes the custom load module from step one, and so that it contains a
	DD card (or FILEDEF statement) for the <var class="product">Fast/Unload</var> audit trail.		DD card (or FILEDEF statement) for the <var class="product">Fast/Unload</var> audit trail.
	This audit trail has DDNAME <code>FUNAUDIT</code>.		This audit trail has DDNAME <code>FUNAUDIT</code>.
	For initial testing purposes, this DD could simply specify <code>SYSOUT=*</code>.~~</li>~~		For initial testing purposes, this DD could simply specify <code>SYSOUT=*</code>.
	<p>See the [[#audFmt\|FUSI audit format below]].</p>		<p>See the [[#audFmt\|FUSI audit format below]].</p></li>

	<li>Modify the User 0 parm card to indicate the maximum number		<li>Modify the User 0 parm card to indicate the maximum number
Line 205:		Line 205:
	The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.		The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.

	===FUNMTASK===		===<b id="funmtask"></b>FUNMTASK===
	The <var>FUNMTASK</var> parameter specifies whether Fast/Unload Soul Interface (FUSI) requests are to be executed on a z/OS subtask or on one of these: the Model 204 maintask, an MP/204 subtask, or the zIIP support SRB.		The <var>FUNMTASK</var> parameter specifies whether Fast/Unload Soul Interface (FUSI) requests are to be executed on a z/OS subtask or on one of these: the Model 204 maintask, an MP/204 subtask, or the zIIP support SRB.

Line 220:		Line 220:
	The X'02', X'04', and X'08' bits (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <code>FUNAUDIT</code> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.</p>		The X'02', X'04', and X'08' bits (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <code>FUNAUDIT</code> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.</p>
	<p>		<p>
	For more detailed usage information, see the <var>[[FUNPARM parameter\|FUNPARM]]</var> page.		For more detailed usage information, see the <var>[[FUNPARM parameter\|FUNPARM]]</var> page. </p>

	===<b id="funmaxt"></b>FUNMAXT===		===<b id="funmaxt"></b>FUNMAXT===
	The <var>[[FUNMAXT ~~parameter\|FUNMAXT]]~~</var> system parameter specifies the maximum amount of time, in seconds, a <var class="product">FUSI</var> request is to be given to complete.		The <var>FUNMAXT</var> system parameter specifies the maximum amount of time, in seconds, a <var class="product">FUSI</var> request is to be given to complete.
	The timer begins when the <var class="product">FUSI</var> is requested,		The timer begins when the <var class="product">FUSI</var> is requested,
	by <var>$Funload</var> or by the <var>Recordset</var> ~~class~~ <var>~~FastUnload~~</var> or <var>~~FastUnloadTask~~</var> ~~method~~.		by <var>[[$Funload]]</var> or by the <var>[[FastUnload (Recordset function)\|FastUnload]]</var> and <var>[[FastUnloadTask (Recordset function)\|FastUnloadTask]]</var> methods the <var>Recordset</var> class.

	<var>FUNMAXT</var> is a numeric parameter with valid values from 0 to 36000.		<var>FUNMAXT</var> is a numeric parameter with valid values from 0 to 36000.
Line 233:		Line 233:
	indefinitely while queuing for busy <var class="product">Fast/Unload</var> tasks or for unintentionally long-running requests.		indefinitely while queuing for busy <var class="product">Fast/Unload</var> tasks or for unintentionally long-running requests.

	~~To override~~ <var>FUNMAXT~~</var> for specific requests, you can use either of these:~~		For more usage information, see the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> page.
	~~<ul>~~
	~~<li>The <var>MaxTime</var> named~~ parameter ~~on the <var>FastUnload</var> and <var>FastUnloadTask</var> methods in the~~
	~~<var>Recordset~~</var> ~~class~~. ~~</li>~~

	~~<li>The sixth parameter on <var>$Funload</var>:~~		==See also==
	~~<p class~~=~~"code"><nowiki>* Make sure request completes in one minute~~
	~~%rc~~ = ~~%rs:fastUnload(%listi, %listo, parameters~~=~~'NEBUFF~~=~~10', maxTime=60)~~
	~~...~~
	* Make sure request completes in one minute
	~~%rc = $funload('LABEL', %iList, %oList, , 'NEBUFF=10', 60)~~
	~~</nowiki></p></li>~~
	~~</ul>~~

	~~It is a reasonable strategy to set <var>FUNMAXT</var> to a fairly low value, then to~~
	~~selectively set it higher for requests that need more time.~~
	~~Of course, it can be very difficult to ensure that short-running requests~~
	~~complete quickly if the Online also has long-running requests that~~
	~~might tie up all the <var class="product">Fast/Unload</var> tasks.~~

	~~You improve the odds of quick completion if you specify more <var class="product">Fast/Unload</var> tasks~~
	~~(<var>FUNTSKN</var> bigger), but this might still not be enough:~~
	~~<ul>~~
	~~<li>All tasks might be tied up anyway, if there are many long-running requests.</li>~~

	~~<li>Some of the <var class="product">Fast/Unload</var> tasks might have trouble getting~~
	~~dispatched, because there are more of them than CPUs to run them. </li>~~
	~~</ul>~~

	~~==See also==~~
	===Fast/Unload SOUL Interface topics===		===Fast/Unload SOUL Interface topics===
	{{Template:Fast/Unload SOUL Interface topic list}}		{{Template:Fast/Unload SOUL Interface topic list}}

JAL: trim parameter info

2016-03-29T16:35:48Z

trim parameter info

← Older revision		Revision as of 16:35, 29 March 2016
Line 203:		Line 203:

	==<b id="sprmuli"></b>System parameters for the FUSI==		==<b id="sprmuli"></b>System parameters for the FUSI==

	The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.		The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.

	===FUNMTASK===		===FUNMTASK===
	The <var>[[FUNMTASK ~~parameter\|FUNMTASK]]~~</var> parameter specifies whether Fast/Unload Soul Interface (FUSI) requests are to be executed on a z/OS subtask or on one of these: the Model 204 maintask, an MP/204 subtask, or the zIIP support SRB.		The <var>FUNMTASK</var> parameter specifies whether Fast/Unload Soul Interface (FUSI) requests are to be executed on a z/OS subtask or on one of these: the Model 204 maintask, an MP/204 subtask, or the zIIP support SRB.

			For usage details, see the <var>[[FUNMTASK parameter\|FUNMTASK]]</var> page.

	===<b id="funparm"></b>FUNPARM===		===<b id="funparm"></b>FUNPARM===
	The <var>[[FUNPARM ~~parameter\|FUNPARM]]~~</var> system parameter		The <var>FUNPARM</var> system parameter is a standard <var class="product">Model 204</var> bitmask-style parameter.
	is a standard <var class="product">Model 204</var> bitmask-style parameter.		<p>
	Setting the X'01' bit specifies that a synchronous		Setting the X'01' bit specifies that a synchronous
	<var class="product">Fast/Unload</var> request is <i>not</i> to be allowed while an updating transaction is active.		<var class="product">Fast/Unload</var> request is <i>not</i> to be allowed while an updating transaction is active.
	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.		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 the <var>FUNPARM</var> X'01' bit is set, and a thread attempts a synchronous <var class="product">FUSI</var>~~
	~~request (with <var>$Funload</var> or the <var>FastUnload</var> method of the <var>Recordset</var> class)~~
	~~in the middle of an updating transaction, the transaction is cancelled with a message like the following:~~
	~~<p class="code">CANCELLING REQUEST: MSIR.0561: $FUNLOAD: Synchronous request during~~
	~~update transaction in line 43, procedure~~
	~~FUNTEST, file ALEXPROC~~
	</p>		</p>
	<p>		<p>
	The X'02', X'04', and X'08' bits of <var>FUNPARM</var> control the <var class="product">Model 204</var> auditing of <var class="product">Fast/Unload</var> messages. As described in [[FUNPRMU_parameter#Fast/Unload report processing\|Fast/Unload report processing]], <var>FUNPARM</var> (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <~~var~~>FUNAUDIT</~~var~~> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.</p>		The X'02', X'04', and X'08' bits (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <code>FUNAUDIT</code> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.</p>
	<p>		<p>
	~~The X'02'~~, ~~X'04', and X'08' bits of~~ <var>FUNPARM</var> ~~are supported as of version 4.7 of <var class="product">Fast/Unload</var>~~.		For more detailed usage information, see the <var>[[FUNPARM parameter\|FUNPARM]]</var> page.
	~~</p>~~

	~~<div id="funmaxt"></div>~~
	~~===FUNMAXT===~~
	~~<!--Caution: <div> above-->~~

			===<b id="funmaxt"></b>FUNMAXT===
	The <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter specifies the maximum amount of time, in seconds, a <var class="product">FUSI</var> request is to be given to complete.		The <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter specifies the maximum amount of time, in seconds, a <var class="product">FUSI</var> request is to be given to complete.
	The timer begins when the <var class="product">FUSI</var> is requested,		The timer begins when the <var class="product">FUSI</var> is requested,
Line 247:		Line 235:
	To override <var>FUNMAXT</var> for specific requests, you can use either of these:		To override <var>FUNMAXT</var> for specific requests, you can use either of these:
	<ul>		<ul>
	<li>The <var>MaxTime</var>		<li>The <var>MaxTime</var> named parameter on the <var>FastUnload</var> and <var>FastUnloadTask</var> methods in the
	named parameter on the <var>FastUnload</var> and <var>FastUnloadTask</var> methods in the
	<var>Recordset</var> class. </li>		<var>Recordset</var> class. </li>

	<li>The sixth parameter on <var>$Funload</var>:		<li>The sixth parameter on <var>$Funload</var>:
	<p class="code"><nowiki>* Make sure request completes in one minute		<p class="code"><nowiki>* Make sure request completes in one minute
	%rc = %rs:fastUnload(%listi, %listo, -		%rc = %rs:fastUnload(%listi, %listo, parameters='NEBUFF=10', maxTime=60)
	parameters='NEBUFF=10', maxTime=60)
	...		...
	* Make sure request completes in one minute		* Make sure request completes in one minute

JAL: /* System parameters for the FUSI */ add FUNMTASK

2016-03-24T00:30:09Z

System parameters for the FUSI: add FUNMTASK

← Older revision		Revision as of 00:30, 24 March 2016
Line 206:		Line 206:
	The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.		The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.

	<~~div~~ id="funparm"></~~div~~>		===FUNMTASK===
	~~===~~FUNPARM===		The <var>[[FUNMTASK parameter\|FUNMTASK]]</var> parameter specifies whether Fast/Unload Soul Interface (FUSI) requests are to be executed on a z/OS subtask or on one of these: the Model 204 maintask, an MP/204 subtask, or the zIIP support SRB.
	~~<!--Caution: <div> above-->~~

			===<b id="funparm"></b>FUNPARM===
	The <var>[[FUNPARM parameter\|FUNPARM]]</var> system parameter		The <var>[[FUNPARM parameter\|FUNPARM]]</var> system parameter
	is a standard <var class="product">Model 204</var> bitmask-style parameter.		is a standard <var class="product">Model 204</var> bitmask-style parameter.

JAL: /* Setting up the FUSI environment */ v4.7 w/ 204 7.5

2016-03-23T16:31:54Z

Setting up the FUSI environment: v4.7 w/ 204 7.5

← Older revision		Revision as of 16:31, 23 March 2016
Line 108:		Line 108:

	==Setting up the FUSI environment==		==Setting up the FUSI environment==
	<p class="note"><b>Note:</b> Using the <var class="product">FUSI</var> with Model 204 version 7.4 requires <var class="product">Fast/Unload</var> version 4.6 or higher. </p>		<p class="note"><b>Note:</b> Using the <var class="product">FUSI</var> with Model 204 version 7.4 requires <var class="product">Fast/Unload</var> version 4.6 or higher. Version 4.7 or higher is required for full exploitation of Model 204 version 7.5.</p>

	To use the <var class="product">FUSI</var>, the system manager must perform the following steps:		To use the <var class="product">FUSI</var>, the system manager must perform the following steps:

JAL: replace "e.g."

2015-10-06T18:58:37Z

replace "e.g."

← Older revision		Revision as of 18:58, 6 October 2015
Line 163:		Line 163:

	===<b id="audFmt"></b>FUSI audit format===		===<b id="audFmt"></b>FUSI audit format===
	If <var>FUNAUDIT</var> is allocated to the ~~online~~, it will contain messages		If <var>FUNAUDIT</var> is allocated to the Online, it will contain messages
	(~~e.g.~~, starting a Fast/Unload task for a request, or completing		(for example, starting a Fast/Unload task for a request, or completing
	a request) in the following format:		a request) in the following format:

	<p class="~~output~~"><nowiki>Col Len Data		<p class="code"><nowiki>Col Len Data
	--- --- --------------------------		--- --- --------------------------
	1 1 Carriage control character		1 1 Carriage control character
Line 181:		Line 181:
	</nowiki></p>		</nowiki></p>

	If <var>FUNAUDIT</var> is not allocated to the ~~online~~, the messages are instead		If <var>FUNAUDIT</var> is not allocated to the Online, the messages are instead
	produced in the Model 204 audit trail as RK messages with the		produced in the Model 204 audit trail as RK messages with the
	following format:		following format:

	<p class="~~output~~"><nowiki>Col Len Data		<p class="code"><nowiki>Col Len Data
	--- --- --------------------------		--- --- --------------------------
	1 4 'FUN:'		1 4 'FUN:'
Line 199:		Line 199:

	In the above a "request" is a Fast/Unload request, which corresponds		In the above a "request" is a Fast/Unload request, which corresponds
	to a single invocation of <var>$Funload</var> or ~~either~~ the		to a single invocation of <var>$Funload</var> or of the
	<var>FastUnload</var> or <var>FastUnloadTask</var> ~~methods~~.		<var>FastUnload</var> or the <var>FastUnloadTask</var> method.

	==<b id="sprmuli"></b>System parameters for the FUSI==		==<b id="sprmuli"></b>System parameters for the FUSI==
Line 223:		Line 223:
	FUNTEST, file ALEXPROC		FUNTEST, file ALEXPROC
	</p>		</p>
	<p>The X'02', X'04', and X'08' bits of <var>FUNPARM</var> control the <var class="product">Model 204</var> auditing of <var class="product">Fast/Unload</var> messages. As described in [[FUNPRMU_parameter#Fast/Unload report processing\|Fast/Unload report processing]], <var>FUNPARM</var> (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <var>FUNAUDIT</var> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.		<p>
			The X'02', X'04', and X'08' bits of <var>FUNPARM</var> control the <var class="product">Model 204</var> auditing of <var class="product">Fast/Unload</var> messages. As described in [[FUNPRMU_parameter#Fast/Unload report processing\|Fast/Unload report processing]], <var>FUNPARM</var> (and the <var>[[FUNPRMU parameter\|FUNPRMU]]</var> user parameter) allow the auditing of some of the messages from the <var class="product">FUSI</var> job report to be captured on <var>FUNAUDIT</var> and/or the <var class="product">Model 204</var> audit trail, regardless of the report destination specified in the SOUL invocation of the <var class="product">FUSI</var>.</p>
			<p>
	The X'02', X'04', and X'08' bits of <var>FUNPARM</var> are supported as of version 4.7 of <var class="product">Fast/Unload</var>.		The X'02', X'04', and X'08' bits of <var>FUNPARM</var> are supported as of version 4.7 of <var class="product">Fast/Unload</var>.
	</p>		</p>

Dme at 09:33, 6 October 2015

2015-10-06T09:33:54Z

@@ Line 163: / Line 163: @@
 ===<b id="audFmt"></b>FUSI audit format===
-<div id="sprmuli"></div>
+<p class="output"><nowiki>Col  Len   Data
 ==<b id="sprmuli"></b>System parameters for the FUSI==

Dme: /* System parameters for the FUSI */

2015-10-06T09:27:33Z

System parameters for the FUSI

← Older revision		Revision as of 09:27, 6 October 2015
Line 166:		Line 166:
	<div id="sprmuli"></div>		<div id="sprmuli"></div>

	==System parameters for the FUSI==		==<b id="sprmuli"></b>System parameters for the FUSI==
	~~<!--Caution: <div> above-->~~

	The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.		The parameters described in the following subsections provide useful controls for <var class="product">FUSI</var> requests.

Dme: /* Setting up the FUSI environment */

2015-10-06T09:26:54Z

Setting up the FUSI environment

← Older revision		Revision as of 09:26, 6 October 2015
Line 130:		Line 130:
	This audit trail has DDNAME <code>FUNAUDIT</code>.		This audit trail has DDNAME <code>FUNAUDIT</code>.
	For initial testing purposes, this DD could simply specify <code>SYSOUT=*</code>.</li>		For initial testing purposes, this DD could simply specify <code>SYSOUT=*</code>.</li>
			<p>See the [[#audFmt\|FUSI audit format below]].</p>

	<li>Modify the User 0 parm card to indicate the maximum number		<li>Modify the User 0 parm card to indicate the maximum number
Line 160:		Line 161:
	Communication with <var class="product">Fast/Unload</var> is achieved by the <var class="product">SOUL</var> $functions or methods		Communication with <var class="product">Fast/Unload</var> is achieved by the <var class="product">SOUL</var> $functions or methods
	that are provided when your site purchases the <var class="product">FUSI</var> product.		that are provided when your site purchases the <var class="product">FUSI</var> product.

			===<b id="audFmt"></b>FUSI audit format===

	<div id="sprmuli"></div>		<div id="sprmuli"></div>