External Call Facility - Revision history

Gary: /* ECF return codes and $function */

2026-01-31T21:31:33Z

ECF return codes and $function

← Older revision		Revision as of 21:31, 31 January 2026
Line 422:		Line 422:
	<tr>		<tr>
	<td align="right">2</td>		<td align="right">2</td>
	<td align="right">0</td>		<td align="right">1</td>
	<td>User not authorized for ECF function, ~~see~~ ECPRIV parameter</td>		<td>User not authorized for ECF function, refer to ECPRIV parameter</td>
	</tr>		</tr>

	<tr>		<tr>
	<td> </td>		<td> </td>
	<td align="right">1</td>		<td align="right">2</td>
	<td>Unable to obtain ACEE for setting ECF subtask security profile</td>		<td>Unable to obtain ACEE for setting ECF subtask security profile</td>
	</tr>		</tr>

Gary: /* ECF return codes and $function */

2026-01-31T21:13:42Z

ECF return codes and $function

← Older revision		Revision as of 21:13, 31 January 2026
Line 423:		Line 423:
	<td align="right">2</td>		<td align="right">2</td>
	<td align="right">0</td>		<td align="right">0</td>
	<td>User not authorized for ECF function, see ECPRIV</td>		<td>User not authorized for ECF function, see ECPRIV parameter</td>
	</tr>		</tr>

Gary: /* ECF return codes and $function */

2026-01-31T21:12:59Z

ECF return codes and $function

← Older revision		Revision as of 21:12, 31 January 2026
Line 423:		Line 423:
	<td align="right">2</td>		<td align="right">2</td>
	<td align="right">0</td>		<td align="right">0</td>
	<td>~~Not~~ authorized</td>		<td>User not authorized for ECF function, see ECPRIV</td>
			</tr>

			<tr>
			<td> </td>
			<td align="right">1</td>
			<td>Unable to obtain ACEE for setting ECF subtask security profile</td>
	</tr>		</tr>

Gary: /* ECF User 0 parameters */

2025-12-28T15:19:14Z

ECF User 0 parameters

← Older revision		Revision as of 15:19, 28 December 2025
Line 659:		Line 659:
	<td><var>[[ECWAIT parameter\|ECWAIT]]</var> </td>		<td><var>[[ECWAIT parameter\|ECWAIT]]</var> </td>
	<td>ECF wait time</td>		<td>ECF wait time</td>
			</tr>

			<tr>
			<td><var>[[ECWAIT parameter\|ECMAXCPU]]</var> </td>
			<td>Maximum CPU time in seconds allowed for an external call of an ECF module, else 0 for no limit. If limit is exceeded, the ECF module a user 099 ABEND is reflected to the ECF task. This support added by 79Z087.</td>
	</tr>		</tr>
	</table>		</table>

	==Subtask and load module management==		==Subtask and load module management==
	<p>		<p>

DCameron: /* Wait types for ECF */

2019-05-13T12:30:57Z

Wait types for ECF

← Older revision		Revision as of 12:30, 13 May 2019
Line 739:		Line 739:
	===Wait types for ECF===		===Wait types for ECF===
	<p>		<p>
	See the table of codes in [[~~Controlling system operations (CCAIN)~~#~~Job step return codes~~\|~~Job step return codes]] for a~~ listing of wait types that includes the External Call Facility, wait types 43 through 46.</p>		See the table of codes in the [[ONLINE_monitoring#Wait_type_values\| listing of wait types]] that includes the External Call Facility, wait types 43 through 46.</p>

	===ECF statistics===		===ECF statistics===
	<p>		<p>

Alex: /* IDCAMS example */

2017-06-27T06:06:18Z

IDCAMS example

← Older revision		Revision as of 06:06, 27 June 2017
Line 1,105:		Line 1,105:
	</table>		</table>

			<span id="idcams"></span>
	===IDCAMS example===		===IDCAMS example===
	<p>		<p>

JAL: add 7.7 change to profile used for External Call

2016-09-02T22:35:31Z

add 7.7 change to profile used for External Call

Show changes

JAL: minor formatting

2016-09-01T21:05:41Z

minor formatting

← Older revision		Revision as of 21:05, 1 September 2016
Line 1,114:		Line 1,114:
	</p>		</p>

	When <var>IDCAMS</var> is invoked by <var>External Call</var>, the user's Universal Buffer must contain the input lines to be passed to <code>SYSIN</code>, separated by EBCDIC linefeed characters (X'25'). The output lines from IDCAMS are appended to the Universal Buffer, also separated by new lines.		When <var>IDCAMS</var> is invoked by <var>External Call</var>, the user's [[Universal Buffer]] must contain the input lines to be passed to <code>SYSIN</code>, separated by EBCDIC linefeed characters (X'25'). The output lines from <var>IDCAMS</var> are appended to the Universal Buffer, also separated by new lines.

	Before calling <var>IDCAMS</var>, the Universal Buffer must be allocated to a length sufficient to hold all of the input lines and all of the expected output lines. If the buffer is too small, output is truncated. While it is possible to calculate the optimum Universal Buffer length on each invocation, it is better to do the following to minimize storage fragmentation:		Before calling <var>IDCAMS</var>, the Universal Buffer must be allocated to a length sufficient to hold all of the input lines and all of the expected output lines. If the buffer is too small, output is truncated. While it is possible to calculate the optimum Universal Buffer length on each invocation, it is better to do the following to minimize storage fragmentation:
	<ul>		<ul>
Line 1,124:		Line 1,124:

	====Return codes====		====Return codes====
	The <var>IDCAMS</var> interface can return one of the following ~~Return Codes~~:		The <var>IDCAMS</var> interface can return one of the following return codes:
	<table class="thJustBold">		<table class="thJustBold">
	<tr><th>20</th>		<tr><th>20</th>
Line 1,136:		Line 1,136:

	<tr><th><i>Else</i></th>		<tr><th><i>Else</i></th>
	<td>The return code is from IDCAMS.</td></tr>		<td>The return code is from the IDCAMS program.</td></tr>
	</table>		</table>

JAL: minor formatting

2016-08-31T22:44:27Z

minor formatting

← Older revision		Revision as of 22:44, 31 August 2016
Line 60:		Line 60:
	BUMP FORCE SUBSYS MYAPSY		BUMP FORCE SUBSYS MYAPSY

	BUMP FORCE MODULE MYPGM		BUMP FORCE MODULE MYPGM</p>
	</p>
	<p>		<p>
	For users who are not running an external module, the presence or absence of the <var>FORCE</var> option is irrelevant. Adding the <var>FORCE</var> option affects only users who are running an external module. The <var>FORCE</var> option does not interrupt users that are in an unbumpable wait.</p>		For users who are not running an external module, the presence or absence of the <var>FORCE</var> option is irrelevant. Adding the <var>FORCE</var> option affects only users who are running an external module. The <var>FORCE</var> option does not interrupt users that are in an unbumpable wait.</p>

	==<b id="extStmt"></b>ECF SOUL statements==		==<b id="extStmt"></b>ECF SOUL statements==

	<p>		<p>
	You must check <var>[[$Status]]</var> and <var>[[$StatusD]]</var> return codes after each ECF statement.</p>		You must check <var>[[$Status]]</var> and <var>[[$StatusD]]</var> return codes after each ECF statement.</p>
Line 73:		Line 71:
	<dl>		<dl>
	<dt>Function</dt>		<dt>Function</dt>
	<dd>		<dd>Calls an external module that was previously loaded using an <var>EXTERNAL LOAD</var> statement, using a call name that was previously specified in an <var>EXTERNAL NAME</var> statement.</dd>
	Calls an external module that was previously loaded using an <var>EXTERNAL LOAD</var> statement, using a call name that was previously specified in an <var>EXTERNAL NAME</var> statement.</dd>
	<dt>Privileges</dt>		<dt>Privileges</dt>
	<dd>		<dd>
Line 165:		Line 162:
	</table></dd>		</table></dd>
	</dl>		</dl>

	~~<div id="EXTERNAL MODULE statement"></div>~~

	===<b id="module"></b>External Module statement===		===<b id="module"></b>External Module statement===
	~~<!--Warning: <div> above-->~~
	<dl>		<dl>
	<dt>Function</dt>		<dt>Function</dt>
Line 246:		Line 240:
	<td>The module is the [https://en.wikipedia.org/wiki/IBM_mainframe_utility_programs#IDCAMS IBM IDCAMS utility]. Specifying this option causes the IDCAMS module to be invoked in such a way that, rather than reading data from the <var>SYSIN</var> DD and sending output to the <var>SYSPRINT</var> DD, data is read from and written to the user buffer (sometimes known as the Universal Buffer).		<td>The module is the [https://en.wikipedia.org/wiki/IBM_mainframe_utility_programs#IDCAMS IBM IDCAMS utility]. Specifying this option causes the IDCAMS module to be invoked in such a way that, rather than reading data from the <var>SYSIN</var> DD and sending output to the <var>SYSPRINT</var> DD, data is read from and written to the user buffer (sometimes known as the Universal Buffer).

	The <var>IDCAMS</var> option is available as of Model 204 7.7.		The <var>IDCAMS</var> option is available as of Model 204 7.7. For an example, see [[#IDCAMS example\|IDCAMS example]], below.

	Specifying this option for a module other than IDCAMS is likely to result in abends in the module when called.		Specifying this option for a module other than IDCAMS is likely to result in abends in the module when called.

Alex: /* SOUL code */

2016-08-08T01:31:55Z

SOUL code

← Older revision		Revision as of 01:31, 8 August 2016
Line 1,185:		Line 1,185:
	%input.len = $Lstr_Set_UserBuffer(%idcams.in)		%input.len = $Lstr_Set_UserBuffer(%idcams.in)

	* Call the ~~DRAKE~~ wrapper, appending output to Universal Buffer		* Call the IDCAMS wrapper, appending output to Universal Buffer
	external call ~~wrapper~~		external call idcams
	Printtext $status={$STATUS}, $STATUSD={$STATUSD}, $ECFSTAT={$ECFSTAT}		Printtext $status={$STATUS}, $STATUSD={$STATUSD}, $ECFSTAT={$ECFSTAT}
	%rc = +$substr($ecfstat,4,5)		%rc = +$substr($ecfstat,4,5)
Line 1,194:		Line 1,194:
	* a starting offset parameter) and parse lines to stringLlist.		* a starting offset parameter) and parse lines to stringLlist.
	%idcams.out = $lstr_substr($lstr_Get_UserBuffer,%input.len+1)		%idcams.out = $lstr_substr($lstr_Get_UserBuffer,%input.len+1)
	%lines.out = new %lines.out:ParseLines(%idcams.out)		%lines.out = new
			%lines.out:ParseLines(%idcams.out)

	Printtext IDCAMS passed the following {%lines.in:count} lines:		Printtext IDCAMS passed the following {%lines.in:count} lines: