FastUnloadTask (Recordset function) - Revision history

Dme at 16:13, 13 October 2016

2016-10-13T16:13:51Z

← Older revision		Revision as of 16:13, 13 October 2016
Line 9:		Line 9:
	slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie		slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie
	up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to a <var>Stringlist</var>.		up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to a <var>Stringlist</var>.

			<p class="note"><b>Note:</b> The <code>[[FastUnload (Recordset function)#asynch\|Asynch=True]]</code> argument of the <var>FastUnload</var> method provides for complete background execution of a Fast/Unload request.</p>

	<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object		<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object

ELowell at 17:10, 3 September 2015

2015-09-03T17:10:02Z

← Older revision		Revision as of 17:10, 3 September 2015
Line 1:		Line 1:
	{{Template:Recordset:FastUnloadTask subtitle}}		{{Template:Recordset:FastUnloadTask subtitle}}

	This method performs unloads using <var class="product">[[Fast/Unload]]</var> where		This method performs unloads using <var class="product">[[Fast/Unload]]</var> where
	the <var class="product">Fast/Unload</var> output is [[#See also\|processed programmatically]] as it is received.		the <var class="product">Fast/Unload</var> output is [[#See also\|processed programmatically]] as it is received.

Dme: /* See also */

2015-08-12T18:47:56Z

JAL: UL Interface becomes SOUL Interface

2015-03-16T20:59:11Z

UL Interface becomes SOUL Interface

← Older revision		Revision as of 20:59, 16 March 2015
Line 9:		Line 9:
	Its disadvantage is that, since <var class="product">SOUL</var> processing is likely to be		Its disadvantage is that, since <var class="product">SOUL</var> processing is likely to be
	slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie		slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie
	up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to		up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to a <var>Stringlist</var>.
	a <var>Stringlist</var>.

	<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object		<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object
Line 16:		Line 15:

	The <var>FastUnloadTask</var> function is only available to customers licensed for the		The <var>FastUnloadTask</var> function is only available to customers licensed for the
	<var class="product">Fast/Unload ~~User Language~~ Interface</var>.		<var class="product">[[Fast/Unload SOUL Interface]]</var>.

	The <var>FastUnloadTask</var> function also requires at least one <var>FastUnload</var> task to be		The <var>FastUnloadTask</var> function also requires at least one <var>FastUnload</var> task to be available in the Online in which it is running, which means that the
	available in the Online in which it is running, which means that the
	<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.		<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.

	For more information about <var class="product">Fast/Unload User Language Interface</var> environmental considerations, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/e/e2/FunrNew.pdf Fast/Unload Reference Manual]</var>.

	==Syntax==		==Syntax==
Line 44:		Line 40:

	<tr><th><var>AllMessages</var></th>		<tr><th><var>AllMessages</var></th>
	<td>A <var>[[Boolean enumeration]]</var>, providing functionality similar to the <var>$Funload</var> <var>ALLMSG</var> parameter: if <var>True</var>, all messages that would go in the <var class="product">Fast/Unload</var> report are sent to the report dataset, report <var>Stringlist</var>, or FUNAUDIT. Informational messages ordinarily suppressed by <var class="product">Fast/Unload ~~User Language~~ Interface</var> are included by this setting.		<td>A <var>[[Boolean enumeration]]</var>, providing functionality similar to the <var>$Funload</var> <var>ALLMSG</var> parameter: if <var>True</var>, all messages that would go in the <var class="product">Fast/Unload</var> report are sent to the report dataset, report <var>Stringlist</var>, or FUNAUDIT. Informational messages ordinarily suppressed by <var class="product">Fast/Unload SOUL Interface</var> are included by this setting.
	<p>		<p>
	<var>AllMessages</var> is the [[Notation conventions for methods#Named parameters\|required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>. That is, many informational messages are suppressed from the report output.</p></td></tr>		<var>AllMessages</var> is the [[Notation conventions for methods#Named parameters\|required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>. That is, many informational messages are suppressed from the report output.</p></td></tr>
Line 61:		Line 57:
	A value of 0 for <var>MaxTime</var> means that the request will never timeout.		A value of 0 for <var>MaxTime</var> means that the request will never timeout.
	<p>		<p>
	<var>MaxTime</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter. <var>FUNMAXT</var> is described in the [~~http:~~/~~/m204wiki.rocketsoftware.com/images/e/e2/FunrNew.pdf~~ Fast/Unload ~~Reference Manual~~]. </p>		<var>MaxTime</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter. <var>FUNMAXT</var> is also described in the [[Fast/Unload SOUL Interface#FUNMAXT\|FUNMAXT]] section of the [[Fast/Unload SOUL Interface]] page. </p>
	<p class="note">		<p class="note">
	'''Note:''' A request can timeout through no fault of its own if all the <var class="product">Fast/Unload</var> tasks are taken up by other long-running requests.</p></td></tr>		'''Note:''' A request can timeout through no fault of its own if all the <var class="product">Fast/Unload</var> tasks are taken up by other long-running requests.</p></td></tr>
Line 67:		Line 63:

	==Examples==		==Examples==
	See the [[FastUnloadTask class#FastUnloadTask example\|examples for the FastUnloadTask class]].		See the [[FastUnloadTask class#FastUnloadTask example\|examples for the <var>FastUnloadTask</var> class]].

	==See also==		==See also==
Line 83:		Line 79:
	{{Template:Recordset:FastUnloadTask footer}}		{{Template:Recordset:FastUnloadTask footer}}

	[[Category:Fast/Unload ~~User Language~~ Interface]]		[[Category:Fast/Unload SOUL Interface]]

JAL at 00:23, 11 October 2014

2014-10-11T00:23:51Z

← Older revision		Revision as of 00:23, 11 October 2014
Line 7:		Line 7:
	output: it avoids potentially large quantities of data from being		output: it avoids potentially large quantities of data from being
	moved to and from CCATEMP.		moved to and from CCATEMP.
	Its disadvantage is that, since <var class="product">~~User Language~~</var> processing is likely to be		Its disadvantage is that, since <var class="product">SOUL</var> processing is likely to be
	slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie		slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie
	up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to		up a <var class="product">Fast/Unload</var> task much longer than using <var>FastUnload</var>, which sends its output to
Line 22:		Line 22:
	<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.		<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.

	For more information about <var class="product">Fast/Unload User Language Interface</var> environmental considerations, see the <var class="~~product~~">[http://~~www~~.~~sirius-software~~.com/~~manlist~~/~~funr~~.pdf Fast/Unload Reference Manual]</var>.		For more information about <var class="product">Fast/Unload User Language Interface</var> environmental considerations, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/e/e2/FunrNew.pdf Fast/Unload Reference Manual]</var>.

	==Syntax==		==Syntax==
Line 61:		Line 61:
	A value of 0 for <var>MaxTime</var> means that the request will never timeout.		A value of 0 for <var>MaxTime</var> means that the request will never timeout.
	<p>		<p>
	<var>MaxTime</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter. <var>FUNMAXT</var> is described in the [http://~~www~~.~~sirius-software~~.com/~~manlist~~/~~funr~~.pdf Fast/Unload Reference Manual]. </p>		<var>MaxTime</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter. <var>FUNMAXT</var> is described in the [http://m204wiki.rocketsoftware.com/images/e/e2/FunrNew.pdf Fast/Unload Reference Manual]. </p>
	<p>		<p class="note">
	'''Note:''' A request can timeout through no fault of its own if all the <var class="product">[[Fast/Unload]]</var> tasks are taken up by other long-running requests.</p></td></tr>		'''Note:''' A request can timeout through no fault of its own if all the <var class="product">Fast/Unload</var> tasks are taken up by other long-running requests.</p></td></tr>
	</table>		</table>

	==Examples==		==Examples==
	See the [[FastUnloadTask class#FastUnloadTask example\|examples for the FastUnloadTask class]].		See the [[FastUnloadTask class#FastUnloadTask example\|examples for the FastUnloadTask class]].

	==See also==		==See also==
	The following functions provide interaction with the task created by <var>FastUnloadTask</var>:		The following functions provide interaction with the task created by <var>FastUnloadTask</var>:

Dme: /* See also */

2013-09-09T16:03:50Z

Dme at 15:16, 9 September 2013

2013-09-09T15:16:55Z

← Older revision		Revision as of 15:16, 9 September 2013
Line 18:		Line 18:
	<var class="product">Fast/Unload User Language Interface</var>.		<var class="product">Fast/Unload User Language Interface</var>.

	The <var>~~FastUnload~~</var> function also requires at least one <var>FastUnload</var> task to be		The <var>FastUnloadTask</var> function also requires at least one <var>FastUnload</var> task to be
	available in the Online in which it is running, which means that the		available in the Online in which it is running, which means that the
	<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.		<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.

JAL at 23:38, 6 November 2012

2012-11-06T23:38:00Z

← Older revision		Revision as of 23:38, 6 November 2012
Line 13:		Line 13:

	<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object		<var>FastUnloadTask</var> returns a <var>[[FastUnloadTask class\|FastUnloadTask]]</var> object
	that can be used to retrieve output from <var class="product">[[Fast/Unload]]</var>.		that can be used to retrieve output from <var class="product">Fast/Unload</var>.

	The <var>FastUnloadTask</var> function is only available to customers licensed for the		The <var>FastUnloadTask</var> function is only available to customers licensed for the
Line 20:		Line 20:
	The <var>FastUnload</var> function also requires at least one <var>FastUnload</var> task to be		The <var>FastUnload</var> function also requires at least one <var>FastUnload</var> task to be
	available in the Online in which it is running, which means that the		available in the Online in which it is running, which means that the
	FUNTSKN system parameter must be set to 1 or higher.		<var>[[FUNTSKN parameter\|FUNTSKN]]</var> system parameter must be set to 1 or higher.
	For more information about <var class="product">Fast/Unload User Language Interface</var> environmental considerations, see the [http://www.sirius-software.com/manlist/funr.pdf Fast/Unload Reference Manual].
			For more information about <var class="product">Fast/Unload User Language Interface</var> environmental considerations, see the <var class="product">[http://www.sirius-software.com/manlist/funr.pdf Fast/Unload Reference Manual]</var>.

	==Syntax==		==Syntax==
	{{Template:Recordset:FastUnloadTask syntax}}		{{Template:Recordset:FastUnloadTask syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~funtask~~</th>		<tr><th>%fastUnloadTask</th>
	<td>A reference to an instance of a <var>FastUnloadTask</var> object.		<td>A reference to an instance of a <var>FastUnloadTask</var> object.</td></tr>
	</td></tr>
	<tr><th>~~%rs~~</th>		<tr><th>recordset</th>
	<td>A reference to an instance of a <var>Recordset</var> object.		<td>A reference to an instance of a <var>Recordset</var> object.</td></tr>
	</td></tr>
	<tr><th><var>Input</var></th>		<tr><th><var>Input</var></th>
	<td>A <var>Stringlist</var> object that contains the <var class="product">Fast/Unload</var> FUEL program for the unload. <var>Input</var> is the [[Notation conventions for methods#Named parameters\|allowed name]] for the parameter.		<td>A <var>Stringlist</var> object that contains the <var class="product">Fast/Unload</var> FUEL program for the unload. <var>Input</var> is the [[Notation conventions for methods#Named parameters\|allowed name]] for the parameter.</td></tr>
	</td></tr>
	<tr><th><var>Parameters</var></th>		<tr><th><var>Parameters</var></th>
	<td>A string that contains the parameters that are to be passed to <var class="product">Fast/Unload</var>. <var>Parameters</var> is the ~~[[Notation conventions for methods#Named parameters\|~~allowed name]] for the parameter.		<td>A string that contains the parameters that are to be passed to <var class="product">Fast/Unload</var>. <var>Parameters</var> is the allowed name for the parameter.
	This is an optional parameter; if it is not specified, no parameters are passed to <var class="product">Fast/Unload</var>.		<p>
	</td></tr>		This is an optional parameter; if it is not specified, no parameters are passed to <var class="product">Fast/Unload</var>.</p></td></tr>

	<tr><th><var>AllMessages</var></th>		<tr><th><var>AllMessages</var></th>
	<td>A Boolean enumeration, providing functionality similar to the <var>$Funload</var> ALLMSG parameter: if <var>True</var>, all messages that would go in the <var class="product">Fast/Unload</var> report are sent to the report dataset, report <var>Stringlist</var>, or FUNAUDIT. Informational messages ordinarily suppressed by <var class="product">Fast/Unload User Language Interface</var> are included by this setting.		<td>A <var>[[Boolean enumeration]]</var>, providing functionality similar to the <var>$Funload</var> <var>ALLMSG</var> parameter: if <var>True</var>, all messages that would go in the <var class="product">Fast/Unload</var> report are sent to the report dataset, report <var>Stringlist</var>, or FUNAUDIT. Informational messages ordinarily suppressed by <var class="product">Fast/Unload User Language Interface</var> are included by this setting.
	<var>AllMessages</var> is the [[Notation conventions for methods#Named parameters\|required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>. That is, many informational messages are suppressed from the report output.		<p>
	</td></tr>		<var>AllMessages</var> is the [[Notation conventions for methods#Named parameters\|required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>. That is, many informational messages are suppressed from the report output.</p></td></tr>

	<tr><th><var>ReportToStringlist</var></th>		<tr><th><var>ReportToStringlist</var></th>
	<td>A Boolean enumeration value: <ul> <li>If <var>True</var>, the report data from <var class="product">Fast/Unload</var> will be retrieved via the <var>[[Report (FastUnloadTask function)\|Report]]</var> method on the <var>FastUnloadTask</var> object returned by this method. <li>If <var>False</var>, the report data is sent to FUNAUDIT, if present, by default. </ul>		<td>A <var>Boolean</var> <var>enumeration</var> value:
	<var>ReportToStringlist</var> is the ~~[[Notation conventions for methods#Named parameters\|~~required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>.		<ul>
	</td></tr>		<li>If <var>True</var>, the report data from <var class="product">Fast/Unload</var> will be retrieved via the <var>[[Report (FastUnloadTask function)\|Report]]</var> method on the <var>FastUnloadTask</var> object returned by this method.

			<li>If <var>False</var>, the report data is sent to FUNAUDIT, if present, by default.
			</ul>
			<var>ReportToStringlist</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to <var>False</var>.</td></tr>

	<tr><th><var>MaxTime</var></th>		<tr><th><var>MaxTime</var></th>
	<td>A numeric value that indicates the maximum number of seconds after initiation of the request that the request is given to complete. If the request has not even started running in a <var class="product">Fast/Unload</var> task, or if the task is running, but hasn't completed after the timeout period, the request is cancelled (resulting in a return code 32 from <var class="product">Fast/Unload</var>).		<td>A numeric value that indicates the maximum number of seconds after initiation of the request that the request is given to complete. If the request has not even started running in a <var class="product">Fast/Unload</var> task, or if the task is running, but hasn't completed after the timeout period, the request is cancelled (resulting in a return code 32 from <var class="product">Fast/Unload</var>).
	A value of 0 for <var>MaxTime</var> means that the request will never timeout.		A value of 0 for <var>MaxTime</var> means that the request will never timeout.
	<var>MaxTime</var> is the ~~[[Notation conventions for methods#Named parameters\|~~required name]] for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the FUNMAXT system parameter. FUNMAXT is described in the [http://www.sirius-software.com/manlist/funr.pdf Fast/Unload Reference Manual]. <br>'''Note:''' A request can timeout through no fault of its own if all the <var class="product">[[Fast/Unload]]</var> tasks are taken up by other long-running requests.		<p>
			<var>MaxTime</var> is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to the setting of the <var>[[FUNMAXT parameter\|FUNMAXT]]</var> system parameter. <var>FUNMAXT</var> is described in the [http://www.sirius-software.com/manlist/funr.pdf Fast/Unload Reference Manual]. </p>
	</td></tr></table>		<p>
			'''Note:''' A request can timeout through no fault of its own if all the <var class="product">[[Fast/Unload]]</var> tasks are taken up by other long-running requests.</p></td></tr>
			</table>

	==See also==		==See also==
	The following functions provide interaction with the task created by <var>FastUnloadTask</var>:		The following functions provide interaction with the task created by <var>FastUnloadTask</var>:
	<ul>		<ul>
	<li>[[GetNextRecord (FastUnloadTask function)\|GetNextRecord]]: retrieve the <var class="product">Fast/Unload</var> task's output, one record at a time		<li><var>[[GetNextRecord (FastUnloadTask function)\|GetNextRecord]]</var>: retrieve the <var class="product">Fast/Unload</var> task's output, one record at a time
	<li>[[Report (FastUnloadTask function)\|Report]]: retrieve the <var class="product">Fast/Unload</var> task's report into a <var>Stringlist</var>, after the task is done
	<li>[[ReturnCode (FastUnloadTask function)\|ReturnCode]]: retrieve the <var class="product">Fast/Unload</var> task's return code, after the task is done		<li><var>[[Report (FastUnloadTask function)\|Report]]</var>: retrieve the <var class="product">Fast/Unload</var> task's report into a <var>Stringlist</var>, after the task is done
	<li>[[State (FastUnloadTask function)\|State]]: ~~retrive~~ the state of the <var class="product">Fast/Unload</var> task
			<li><var>[[ReturnCode (FastUnloadTask function)\|ReturnCode]]</var>: retrieve the <var class="product">Fast/Unload</var> task's return code, after the task is done

			<li><var>[[State (FastUnloadTask function)\|State]]</var>: retrieve the state of the <var class="product">Fast/Unload</var> task
	</ul>		</ul>

	{{Template:Recordset:FastUnloadTask footer}}		{{Template:Recordset:FastUnloadTask footer}}

	[[Category:Fast/Unload User Language Interface]]		[[Category:Fast/Unload User Language Interface]]

Dme at 12:18, 19 July 2012

2012-07-19T12:18:38Z

← Older revision		Revision as of 12:18, 19 July 2012
Line 2:		Line 2:

	This method performs unloads using <var class="product">[[Fast/Unload]]</var> where		This method performs unloads using <var class="product">[[Fast/Unload]]</var> where
	the <var class="product">Fast/Unload</var> output is processed programmatically as it is received.		the <var class="product">Fast/Unload</var> output is [[#See also\|processed programmatically]] as it is received.

	The <var>FastUnloadTask</var> approach has this advantage over the <var>[[FastUnload (Recordset function)\|FastUnload]]</var> method which has a <var>Stringlist</var>		The <var>FastUnloadTask</var> approach has this advantage over the <var>[[FastUnload (Recordset function)\|FastUnload]]</var> method which has a <var>Stringlist</var>

Dme: /* See also */

2012-07-19T12:17:30Z

← Older revision		Revision as of 18:47, 12 August 2015
Line 66:		Line 66:

	==See also==		==See also==
			<ul>
			<li>The <var class="product">[[Fast/Unload]]</var> wiki pages.
			</ul>

	The following functions provide interaction with the task created by <var>FastUnloadTask</var>:		The following functions provide interaction with the task created by <var>FastUnloadTask</var>:
	<ul>		<ul>

← Older revision		Revision as of 16:03, 9 September 2013
Line 66:		Line 66:
	</table>		</table>

			==Examples==
			See the [[FastUnloadTask class#FastUnloadTask example\|examples for the FastUnloadTask class]].
	==See also==		==See also==
	The following functions provide interaction with the task created by <var>FastUnloadTask</var>:		The following functions provide interaction with the task created by <var>FastUnloadTask</var>:

← Older revision		Revision as of 12:17, 19 July 2012
Line 55:		Line 55:

	==See also==		==See also==
			The following functions provide interaction with the task created by <var>FastUnloadTask</var>:
			<ul>
			<li>[[GetNextRecord (FastUnloadTask function)\|GetNextRecord]]: retrieve the <var class="product">Fast/Unload</var> task's output, one record at a time
			<li>[[Report (FastUnloadTask function)\|Report]]: retrieve the <var class="product">Fast/Unload</var> task's report into a <var>Stringlist</var>, after the task is done
			<li>[[ReturnCode (FastUnloadTask function)\|ReturnCode]]: retrieve the <var class="product">Fast/Unload</var> task's return code, after the task is done
			<li>[[State (FastUnloadTask function)\|State]]: retrive the state of the <var class="product">Fast/Unload</var> task
			</ul>
	{{Template:Recordset:FastUnloadTask footer}}		{{Template:Recordset:FastUnloadTask footer}}
	[[Category:Fast/Unload User Language Interface]]		[[Category:Fast/Unload User Language Interface]]