friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/addfcte.htm

568 lines
21 KiB
HTML
Raw Blame History

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Add Forms Control Entry (ADDFCTE)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="ADDFCTE.Top_Of_Page"></a>
<h2>Add Forms Control Entry (ADDFCTE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#ADDFCTE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDFCTE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDFCTE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDFCTE"></a>
<h3>Add FCT Entry</h3>
<p>The ADDFCTE command adds an entry to an existing FCT. The FCT can contain up to 9999 entries. Each entry includes the following forms-control attributes:
</p>
<ul>
<li>Host form type
</li>
<li>Host subsystem writer type
</li>
<li>Local form type
</li>
<li>Physical file member creation information
</li>
<li>Format of the output data
</li>
<li>Channel values and associated line numbers
</li>
<li>Form size
</li>
<li>Lines and characters per inch
</li>
<li>Number of copies
</li>
<li>User program name.
</li>
</ul>
<h3>Error messages for ADDFCTE</h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>RJE0024</b></dt>
<dd>Errors found. Processing of request ended.
</dd>
<dt><b>RJE0050</b></dt>
<dd>Entry cannot be added to the forms control table &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDFCTE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.FCT"><b>FCT</b></a></td>
<td valign="top">Forms control table</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Forms control table</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#ADDFCTE.FORMTYPE"><b>FORMTYPE</b></a></td>
<td valign="top">Host form type</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.DEVTYPE"><b>DEVTYPE</b></a></td>
<td valign="top">Device type</td>
<td valign="top"><b><u>*PRT</u></b>, *PUN</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.LCLFORM"><b>LCLFORM</b></a></td>
<td valign="top">Local form type</td>
<td valign="top"><i>Character value</i>, <b><u>*FORMTYPE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.FILE"><b>FILE</b></a></td>
<td valign="top">Output file</td>
<td valign="top">Single values: <b><u>*WTRE</u></b>, *NONE<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Output file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#ADDFCTE.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*WTRE</u></b>, *FIRST, *GEN</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.FSN"><b>FSN</b></a></td>
<td valign="top">File member sequence number</td>
<td valign="top">0-999, <b><u>*WTRE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.DTAFMT"><b>DTAFMT</b></a></td>
<td valign="top">Data format</td>
<td valign="top"><b><u>*WTRE</u></b>, *DATA, *FCFC, *CMN</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.CHLVAL"><b>CHLVAL</b></a></td>
<td valign="top">Channel values</td>
<td valign="top">Single values: <b><u>*FILE</u></b><br>Other values (up to 12 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: </td>
<td valign="top">
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12</td>
</tr>
<tr>
<td valign="top">Element 2: </td>
<td valign="top">
1-255</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.FORMSIZE"><b>FORMSIZE</b></a></td>
<td valign="top">Form size</td>
<td valign="top">Single values: <b><u>*FILE</u></b><br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Form length</td>
<td valign="top">
1-255</td>
</tr>
<tr>
<td valign="top">Element 2: Form width</td>
<td valign="top">
1-255</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.LPI"><b>LPI</b></a></td>
<td valign="top">Lines per inch</td>
<td valign="top"><b><u>*FILE</u></b>, 4, 6, 8, 9</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.CPI"><b>CPI</b></a></td>
<td valign="top">Characters per inch</td>
<td valign="top"><b><u>*FILE</u></b>, 10, 15</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDFCTE.COPIES"><b>COPIES</b></a></td>
<td valign="top">Number of copies</td>
<td valign="top">1-99, <b><u>*FILE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.PGM"><b>PGM</b></a></td>
<td valign="top">Program to call</td>
<td valign="top">Single values: <b><u>*WTRE</u></b>, *NONE<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Program to call</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#ADDFCTE.MSGQ"><b>MSGQ</b></a></td>
<td valign="top">Message queue</td>
<td valign="top">Single values: <b><u>*WTRE</u></b>, *NONE<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Message queue</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr></table>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDFCTE.FCT"></a>
<h3>Forms Cntrl Table (FCT)</h3>
<p>Specifies the qualified name of the FCT to which the entry is added.
</p>
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the FCT.
</li>
<li>*CURLIB: The current library for the job is used to locate the FCT. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the FCT is located.
</li>
</ul>
<p><i>forms-control-table-name:</i> Specify the name of the FCT to which an entry is added.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.FORMTYPE"></a>
<h3>Host Form Type (FORMTYPE)</h3>
<p>Specifies the host form type for the FCT entry. The value is received from the host subsystem in either a peripheral data set information record (PDIR) for SNA, or a form-mount message for BSC. It must contain from one through eight alphanumeric characters. Lowercase letters, blanks, or special characters must be enclosed in apostrophes. For example, a host form type of blanks is specified as FORMTYPE (' ') (four blanks).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.DEVTYPE"></a>
<h3>Device Type (DEVTYPE)</h3>
<p>Specifies the device type associated with the FCT entry.
</p>
<p>The possible values are:
</p>
<ul>
<li>*PRT: The printer device is used.
</li>
<li>*PUN: The punch device is used.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.LCLFORM"></a>
<h3>Local Form Type (LCLFORM)</h3>
<p>Specifies the local form type. It replaces the FORMTYPE value received from the host subsystem. This makes the form-mount messages more understandable to the system user when the output from the job is received. The local form type contains more characters than the host form type, and therefore can be more descriptive.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FORMTYPE: The host form type is not replaced.
</li>
<li><i>local-form-type:</i> Specify the local form type. It replaces the host form type when the output from the job is received. Valid values are from one to 10 alphanumeric characters. Lowercase letters, blanks, or special characters must be enclosed in apostrophes.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.FILE"></a>
<h3>Output File (FILE)</h3>
<p>Specifies the qualified name of the file that receives the data from the host subsystem.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: The file specified in the session description writer entry is used.
</li>
<li>*NONE: A file is not associated with this entry. The session description writer entry determines where the data is sent. RJE does not use the information in the FCT entry.
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the file.
</li>
<li>*CURLIB: The current library for the job is used to locate the file. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the file is located.
</li>
</ul>
</li>
<li><i>file-name:</i> Specify the name of the diskette, DDM, physical, printer, or source physical file that receives the data from the host subsystem. Diskette and printer files must be program described.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the file member to which output is directed. This parameter applies only if you specify a DDM, physical, or source physical file in the FILE parameter.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: Creates file members according to the method specified in the session description writer entry.
</li>
<li>*GEN: Creates a member name formatted as either Affffffccc or Bffffffccc where:
<dl>
<dt><b>A</b></dt>
<dd>Indicates that the file member contains print data.
</dd>
<dt><b>B</b></dt>
<dd>Indicates that the file member contains punch data.
</dd>
<dt><b>ffffff</b></dt>
<dd>Up to the first six non-blank characters of the host form type that was received from the host subsystem. Only A through Z, 0 through 9, $, #, @, and _ are valid in the form type that is used to generate member names.
</dd>
<dt><b>ccc</b></dt>
<dd>Indicates a three-digit FSN controlled by the session to maintain member uniqueness.
</dd>
</dl>
<p>If a member name already exists in the file, the three-digit FSN is incremented by one until either a unique name is reached and a member is created, or sequence numbers up to and including 999 have been tried without creating a member.
</p>
<p>If no member is created, the writer issues a message requesting you to either try again or to cancel this file.
</p>
</li>
<li>*FIRST: The first member in the file is used.
</li>
<li><i>member-name:</i> Specify the name of the file member. If the member is not found, an inquiry message is sent to the RJE message queue.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.FSN"></a>
<h3>File Member Seq Number (FSN)</h3>
<p>Specifies the initial three-digit FSN that is used to create member names. This parameter applies only if you specify *GEN for the MBR parameter.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: The FSN in the session description writer entry is used.
</li>
<li><i>file-sequence-number:</i> Specify the initial three-digit FSN. Leading zeros are not required for sequence numbers less than 100.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.DTAFMT"></a>
<h3>Data Format (DTAFMT)</h3>
<p>Specifies the format of the output data.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: The output format from the session description writer entry is used.
</li>
<li>*FCFC: The output data is in first-character forms control (FCFC) format. If DEVTYPE(*PUN) is specified, *FCFC is not valid.
<p>The data can be written to a physical file in FCFC format and printed later using the Copy File (CPYF) command, specifying an FCFC printer file for the TOFILE parameter. The record length of the physical file must include one extra byte for the FCFC code.
</p>
</li>
<li>*DATA: The output data is in data format. No FCFC codes are embedded in the data. Specify *DATA to send data to a physical file to be processed by a program.
</li>
<li>*CMN: The output data is in communications format (256-character records). *CMN format decreases communications time. Before using the data, issue the CVTRJEDTA command to convert it to either FCFC format or data format. If you specify *CMN, the output file must be a physical file with a record length of 256 bytes.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.CHLVAL"></a>
<h3>Channel Values (BCHLVAL)</h3>
<p>Specifies the printer carriage channel information, which is used to determine which line on a page to skip to before printing the next line of output.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FILE: The printer carriage channel information is the same as that in the device file.
</li>
<li><i>carriage-channel-identifier line-number:</i> Specify the channel identifiers and line numbers.
<p>Each identifier has a value from 1 to 12, corresponding to printer channels 1 to 12. For each carriage channel identifier, RJE skips to the associated line number before printing. If a line number is not specified, single spacing is used. An identifier is specified only once for each command call.
</p>
<p>The maximum line number is 255.
</p>
<p>The CHLVAL parameter associates the channel identifier with a page line number. For example, CHLVAL((1 5)(10 55)) means to associate channel 1 with line 5, and channel 10 with line 55.
</p>
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.FORMSIZE"></a>
<h3>Form Size (FORMSIZE)</h3>
<p>Specifies the form size on the server printer.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FILE: The form size specified in the device file is used.
<p><b>Element 1: Form Length</b>
</p>
</li>
<li><i>form-length:</i> Specify the form length in the FCT entry. The maximum value is 255, and it must be greater than or equal to the overflow line number specified in the device file. If it is not, the form length will not be changed when the FCT entry is used.
<p><b>Element 2: Form Width</b>
</p>
</li>
<li><i>form-width:</i> Specify the form width in the FCT entry. The maximum value is 255.
</li>
</ul>
<p>
<b>Note: </b>If you specify OUTRCDLEN(*FIXED), use a form width of 198 with 15 characters per inch (cpi) and a form width of 132 with 10 cpi. If FORMSIZE(*FILE) and CPI(15) are specified, the form width should be 198 in the printer file description. If you specify OUTRCDLEN(*FILE), ensure that the form width is either greater than or equal to the length of the longest record that is received for this form type. If the form width is greater than the record length, the record is right-padded with blanks.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.LPI"></a>
<h3>Line per Inch (LPI)</h3>
<p>Specifies the number of print lines per inch (lpi) on the server printer.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FILE: Specify the number of print lines per inch in the device file.
</li>
<li>4: Four print lines per inch is used.
</li>
<li>6: Six print lines per inch is used.
</li>
<li>8: Eight print lines per inch is used.
</li>
<li>9: Nine print lines per inch is used.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.CPI"></a>
<h3>Characters per Inch (CPI)</h3>
<p>Specifies the number of characters per inch (cpi) on the server printer. The CPI parameter applies only when RJE is writing to a printer file.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FILE: The number of characters per inch in the device file is used.
</li>
<li>10: RJE produces 132-character records at 10 cpi when *FIXED is specified for OUTRCDLEN.
</li>
<li>15: RJE produces 198-character records at 15 cpi when *FIXED is specified for OUTRCDLEN.
</li>
</ul>
<p>
<b>Note: </b>When host data is written by an RJE printer to a printer file, the record size that RJE uses is dependent on the cpi when *FIXED is specified for OUTRCDLEN, and on the page width when *FILE is specified. If OUTRCDLEN(*FIXED) and CPI(15) are specified, the form width in the FORMSIZE parameter should be 198 characters. Otherwise, the record is truncated to the specified form width.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.COPIES"></a>
<h3>Number of Copies (COPIES)</h3>
<p>Specifies the number of copies to print. This parameter applies only to spooled files.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FILE: The number of copies specified in the device file is used.
</li>
<li><i>number-of-copies:</i> Specify a value between 1 and 99 for the number of copies to print.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.PGM"></a>
<h3>Program to Call (PGM)</h3>
<p>Specifies the qualified name of a user program associated with the session description.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: The program specified in the session description writer entry is used.
</li>
<li>*NONE: No user program is associated with the writer.
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the user program.
</li>
<li>*CURLIB: The current library for the job is used to locate the user program. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the user program is located.
</li>
</ul>
</li>
<li><i>program-name:</i> Specify the name of the user program.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDFCTE.MSGQ"></a>
<h3>Message Queue (MSGQ)</h3>
<p>Specifies the qualified name of the message queue to which messages for the writer are sent.
</p>
<p>The possible values are:
</p>
<ul>
<li>*WTRE: The message queue in the session description writer entry is used.
</li>
<li>*NONE: A message queue is not used.
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the message queue.
</li>
<li>*CURLIB: The current library for the job is used to locate the message queue. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the message queue is located.
</li>
</ul>
</li>
<li><i>message-queue-name:</i> Specify the name of the message queue.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDFCTE.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDFCTE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>RJE0024</b></dt>
<dd>Errors found. Processing of request ended.
</dd>
<dt><b>RJE0050</b></dt>
<dd>Entry cannot be added to the forms control table &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDFCTE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink