ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/crtformdf.htm

308 lines
11 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Create Form Definition (CRTFORMDF)</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="CRTFORMDF.Top_Of_Page"></a>
<h2>Create Form Definition (CRTFORMDF)</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="#CRTFORMDF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CRTFORMDF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CRTFORMDF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CRTFORMDF"></a>
<p>The Create Form Definition (CRTFORMDF) command creates a form definition from a physical file. The physical file contains the form definition information. The form definition information, can, for example, come from a S/370* host system and be in the Systems Application Architecture (SAA) format.
</p>
<p><b>Restriction:</b> If networking spooled files to a System/370* system, the first two characters of the form definition name must be 'F1'.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTFORMDF.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="#CRTFORMDF.FORMDF"><b>FORMDF</b></a></td>
<td valign="top">Form definition</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: Form definition</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>*CURLIB</u></b></td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#CRTFORMDF.FILE"><b>FILE</b></a></td>
<td valign="top">File</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: 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="#CRTFORMDF.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*FORMDF</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#CRTFORMDF.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*MBRTXT</u></b>, *BLANK</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTFORMDF.REPLACE"><b>REPLACE</b></a></td>
<td valign="top">Replace form definition</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTFORMDF.AUT"><b>AUT</b></a></td>
<td valign="top">Authority</td>
<td valign="top"><i>Name</i>, <b><u>*LIBCRTAUT</u></b>, *CHANGE, *ALL, *USE, *EXCLUDE</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CRTFORMDF.FORMDF"></a>
<h3>Form definition (FORMDF)</h3>
<p>Specifies the form definition being created.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Form definition</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the form definition.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*CURLIB</u></b></dt>
<dd>The current library for the job is used to store the form definition. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where you want to store form definition.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTFORMDF.FILE"></a>
<h3>Source file (FILE)</h3>
<p>Specifies the file containing the form definition records sent to this system.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: File</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the file containing the form definition records.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the file. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTFORMDF.MBR"></a>
<h3>Source file member (MBR)</h3>
<p>Specifies the file member containing the form definition records.
</p>
<dl>
<dt><b><u>*FORMDF</u></b></dt>
<dd>The name of the file member is specified in the <b>Form definition (FORMDF)</b> parameter of this command.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the member in the file specified by the <b>Source file (FILE)</b> parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTFORMDF.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the object.
</p>
<dl>
<dt><b><u>*MBRTXT</u></b></dt>
<dd>The text is taken from the file member being used to create the form definition. You can add or change text for a database source member by using the Source Entry Utility (STRSEU) command, or by using either the Add Physical File Member (ADDPFM) command or the Change Physical File Member (CHGPFM) command. If the file is an inline file or a device file, the text is blank.
</dd>
<dt><b>*BLANK</b></dt>
<dd>No text is specified.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify no more than 50 characters of text, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTFORMDF.REPLACE"></a>
<h3>Replace form definition (REPLACE)</h3>
<p>Specifies whether an existing form definition with the same name as the one being created is replaced.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>The existing form definition is replaced.
</dd>
<dt><b>*NO</b></dt>
<dd>If a form definition with same name exists on the system, the create operation fails. The existing form definition is not replaced.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTFORMDF.AUT"></a>
<h3>Authority (AUT)</h3>
<p>Specifies the authority you are giving to users who do not have specific authority for the object, who are not on an authorization list, and whose group profile or supplemental group profiles do not have specific authority for the object.
</p>
<dl>
<dt><b><u>*LIBCRTAUT</u></b></dt>
<dd>The system determines the authority for the object by using the value specified on the <b>Create authority (CRTAUT)</b> parameter on the Create Library command (CRTLIB) for the library containing the object to be created. If the value specified on the <b>Create authority (CRTAUT)</b> parameter is changed, the new value will not affect any existing objects.
</dd>
</dl>
<dl>
<dt><b>*CHANGE</b></dt>
<dd>The user can perform all operations on the object except those limited to the owner or controlled by object existence (*OBJEXIST) and object management (*OBJMGT) authorities. The user can change and perform basic functions on the object. *CHANGE authority provides object operational (*OBJOPR) authority and all data authority. If the object is an authorization list, the user cannot add, change, or remove users.
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>The user can perform all operations except those limited to the owner or controlled by authorization list management (*AUTLMGT) authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user also can change ownership of the object.
</dd>
</dl>
<dl>
<dt><b>*USE</b></dt>
<dd>The user can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. Use (*USE) authority provides object operational (*OBJOPR), read (*READ), and execute (*EXECUTE) authorities.
</dd>
</dl>
<dl>
<dt><b>*EXCLUDE</b></dt>
<dd>The user cannot access the object.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of an authorization list. Users included on the authorization list are granted authority to the object as specified by the list. The authorization list must exist when the object is created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTFORMDF.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CRTFORMDF FORMDF(*CURLIB/FORMDF1)
FILE(*CURLIB/FORMDF) MBR(F1A01238)
AUT(*EXCLUDE)
TEXT('Default form definition for AFP printers')
</pre>
</p>
<p>This command creates form definition FORMDF1 in the current library, or in the QGPL library if there is no current library. Input is taken from source file FORMDF with member F1A01238, in the current library. Specifying *EXCLUDE for authority restricts the usage of the object to the owner. The text describes what the form definition represents.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTFORMDF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2283</b></dt>
<dd>Authorization list &amp;1 does not exist.
</dd>
<dt><b>CPF8056</b></dt>
<dd>File &amp;1 in &amp;2 not a physical file.
</dd>
<dt><b>CPF88C1</b></dt>
<dd>Printer resource type &amp;1 &amp;2 was not created in library &amp;3.
</dd>
<dt><b>CPF9809</b></dt>
<dd>Library &amp;1 cannot be accessed.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9812</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9845</b></dt>
<dd>Error occurred while opening file &amp;1.
</dd>
<dt><b>CPF9846</b></dt>
<dd>Error while processing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9847</b></dt>
<dd>Error occurred while closing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9870</b></dt>
<dd>Object &amp;2 type *&amp;5 already exists in library &amp;3.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTFORMDF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>