FastUnloadTask (Recordset function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| 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"> | the <var class="product">Fast/Unload</var> output is 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> | ||
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 User Language processing is likely to be | Its disadvantage is that, since <var class="product">User Language</var> processing is likely to be | ||
slower than <var class="product"> | slower than <var class="product">Fast/Unload</var> processing, using <var>FastUnloadTask</var> is likely to tie | ||
up a <var class="product"> | 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>. | ||
| Line 21: | Line 21: | ||
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. | FUNTSKN 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 | 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]. | ||
==Syntax== | ==Syntax== | ||
{{Template:Recordset:FastUnloadTask syntax}} | {{Template:Recordset:FastUnloadTask syntax}} | ||
| Line 33: | Line 33: | ||
</td></tr> | </td></tr> | ||
<tr><th><b>Input=</b>inlist</th> | <tr><th><b>Input=</b>inlist</th> | ||
<td>A <var>Stringlist</var> object that contains the <var class="product"> | <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><b>Parameters=</b>parms</th> | <tr><th><b>Parameters=</b>parms</th> | ||
<td>A string that contains the parameters that are to be passed to <var class="product"> | <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. | ||
This is an optional parameter; if it is not specified, no parameters are passed to <var class="product"> | This is an optional parameter; if it is not specified, no parameters are passed to <var class="product">Fast/Unload</var>. | ||
</td></tr> | </td></tr> | ||
<tr><th><b>AllMessages=</b>bool</th> | <tr><th><b>AllMessages=</b>bool</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"> | <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. | ||
<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. | <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. | ||
</td></tr> | </td></tr> | ||
<tr><th><b>ReportToStringlist=</b>bool</th> | <tr><th><b>ReportToStringlist=</b>bool</th> | ||
<td>A Boolean enumeration value: <ul> <li>If <var>True</var>, the report data from <var class="product"> | <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> | ||
< | <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>. | ||
</td></tr> | </td></tr> | ||
<tr><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"> | <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 | <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. | ||
</td></tr></table> | </td></tr></table> | ||
==See also== | ==See also== | ||
{{Template:Recordset:FastUnloadTask footer}} | {{Template:Recordset:FastUnloadTask footer}} | ||
Revision as of 20:27, 29 April 2011
Initiate asynch Recordset unload using Fast/Unload User Language Interface (Recordset class)
[Requires Fast/Unload Soul Interface]
This method performs unloads using Fast/Unload where
the Fast/Unload output is processed programmatically as it is received.
The FastUnloadTask approach has this advantage over the FastUnload method which has a Stringlist output: it avoids potentially large quantities of data from being moved to and from CCATEMP. Its disadvantage is that, since User Language processing is likely to be slower than Fast/Unload processing, using FastUnloadTask is likely to tie up a Fast/Unload task much longer than using FastUnload, which sends its output to a Stringlist.
FastUnloadTask returns a FastUnloadTask object that can be used to retrieve output from Fast/Unload.
The FastUnloadTask function is only available to customers licensed for the Fast/Unload User Language Interface.
The FastUnload function also requires at least one FastUnload task to be available in the Online in which it is running, which means that the FUNTSKN system parameter must be set to 1 or higher. For more information about Fast/Unload User Language Interface environmental considerations, see the Fast/Unload Reference Manual.
Syntax
%fastUnloadTask = recordset:FastUnloadTask( [Input=] input, - [[Parameters=] string], - [AllMessages= boolean], - [ReportToStringlist= boolean], - [MaxTime= number])
Syntax terms
| %funtask | A reference to an instance of a FastUnloadTask object. |
|---|---|
| %rs | A reference to an instance of a Recordset object. |
| Input=inlist | A Stringlist object that contains the Fast/Unload FUEL program for the unload. Input is the allowed name for the parameter. |
| Parameters=parms | A string that contains the parameters that are to be passed to Fast/Unload. Parameters is the allowed name for the parameter.
This is an optional parameter; if it is not specified, no parameters are passed to Fast/Unload. |
| AllMessages=bool | A Boolean enumeration, providing functionality similar to the $Funload ALLMSG parameter: if True, all messages that would go in the Fast/Unload report are sent to the report dataset, report Stringlist, or FUNAUDIT. Informational messages ordinarily suppressed by Fast/Unload User Language Interface are included by this setting.
AllMessages is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to False. That is, many informational messages are suppressed from the report output. |
| ReportToStringlist=bool | A Boolean enumeration value:
ReportToStringlist is the required name for the parameter. The parameter itself is an optional parameter, and it defaults to False. |
| MaxTime | 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 Fast/Unload 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 Fast/Unload).
A value of 0 for MaxTime means that the request will never timeout.
MaxTime is the 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 Fast/Unload Reference Manual. |