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

226 lines
7.0 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>Add Data Definition (ADDDTADFN)</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="ADDDTADFN.Top_Of_Page"></a>
<h2>Add Data Definition (ADDDTADFN)</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="#ADDDTADFN.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDDTADFN.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDDTADFN.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDDTADFN"></a>
<p>The Add Data Definition (ADDDTADFN) command copies file, record format, and field definitions from an externally described database file to a data dictionary.
</p>
<p>When definitions are added to a dictionary, the system does a search to find out if the dictionary contains a definition with the same name as the one being added. If an exact match of the definition is found, the existing definition is used. If an exact match is not found, a new version of the definition is created.
</p>
<p>Database files using the following functions are not added to a dictionary:
</p>
<ul>
<li>Access path sharing
</li>
<li>Alternative collating sequence
</li>
<li>Program-described files
</li>
<li>Join logical files
</li>
<li>Logical files with more than one format
</li>
<li>Logical files with select/omit specifications
</li>
</ul>
<p>Only format and field definitions of database files using the following functions are added to a dictionary:
</p>
<ul>
<li>Field default values
</li>
<li>Field validity check codes
</li>
<li>Key fields defined using names in based on physical files
</li>
<li>Derived fields
</li>
</ul>
<p>
<b>Note: </b>When adding a file that is already linked, the current link is ended and then the definition is added and linked.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDDTADFN.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="#ADDDTADFN.FILE"><b>FILE</b></a></td>
<td valign="top">Data base file</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: Data base 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="#ADDDTADFN.DTADCT"><b>DTADCT</b></a></td>
<td valign="top">Data dictionary</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDTADFN.DFN"><b>DFN</b></a></td>
<td valign="top">File definition</td>
<td valign="top"><i>Name</i>, <b><u>*FILE</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDDTADFN.FILE"></a>
<h3>Data base file (FILE)</h3>
<p>Specifies the name and library of the externally described database file from which the definition is copied to the specified dictionary.
</p>
<p>This is a required parameter.
</p>
<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 thread is used to locate the file. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDTADFN.DTADCT"></a>
<h3>Data dictionary (DTADCT)</h3>
<p>Specifies the name of the dictionary to which the definitions are added. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDTADFN.DFN"></a>
<h3>File definition (DFN)</h3>
<p>Specifies the name the file definition is given when it is copied into the dictionary.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FILE</u></b></dt>
<dd>The name of the file definition is the same as the database file name specified in the <b>Data base file</b> prompt (FILE parameter).
</dd>
<dt><b><i>file-definition</i></b></dt>
<dd>Specify the name the file definition is given when copied to the data dictionary.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDDTADFN.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
ADDDTADFN FILE(MYLIB/MYFILE) DTADCT(MINE) DFN(*FILE)
</pre>
</p>
<p>This command copies the definitions from MYFILE located in library MYLIB to the dictionary MINE. The file definition has the same name as the database file specified in the FILE parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDDTADFN.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2E9E</b></dt>
<dd>Not enough space to add to dictionary &amp;1.
</dd>
<dt><b>CPF2FE0</b></dt>
<dd>Error occurred while opening dictionary &amp;1.
</dd>
<dt><b>CPF2FE1</b></dt>
<dd>Error occurred while closing dictionary &amp;1.
</dd>
<dt><b>CPF2FE2</b></dt>
<dd>Dictionary &amp;1 currently in use.
</dd>
<dt><b>CPF2F02</b></dt>
<dd>Not authorized to use dictionary &amp;1.
</dd>
<dt><b>CPF2F07</b></dt>
<dd>Dictionary &amp;1 in error.
</dd>
<dt><b>CPF2F08</b></dt>
<dd>Dictionary &amp;1 not found.
</dd>
<dt><b>CPF2F61</b></dt>
<dd>File &amp;2 in &amp;3 currently in use.
</dd>
<dt><b>CPF2F72</b></dt>
<dd>File &amp;2 in &amp;3 not valid for ADDDTADFN.
</dd>
<dt><b>CPF2F73</b></dt>
<dd>ADDDTADFN not allowed for SQL database files.
</dd>
<dt><b>CPF2F74</b></dt>
<dd>Attributes of file &amp;2 in &amp;3 not supported.
</dd>
<dt><b>CPF9812</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDTADFN.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>