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

317 lines
14 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 Logical File Member (ADDLFM)</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="ADDLFM.Top_Of_Page"></a>
<h2>Add Logical File Member (ADDLFM)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>Conditional
</td>
<td valign="top" align="right">
<a href="#ADDLFM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDLFM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDLFM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDLFM"></a>
<p>The Add Logical File Member (ADDLFM) command adds a named file member to a logical file which must already exist on the system. The maximum number of members that can be added to the file is specified for the <b>Maximum members (MAXMBRS)</b> parameter on the Create Logical File (CRTLF) command or the Change Logical File (CHGLF) command. To add other members to the file, use the ADDLFM command to specify each one.
</p>
<p>A logical file member can use the data from all, or a subset of, the physical files referenced by the logical file. Each member has its own set of data and can have its own access path that provides an organization to that data. The system attempts to implicitly share an access path already on the system.
</p>
<p>Each added member has the same attributes as those defined in the logical file.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>To add a member to a keyed logical file, you must have object operational (*OBJOPR) authority and either object management (*OBJMGT) or object alter (*OBJALTER) authority for each of the physical files on which the logical file member is based (specified explicitly by the DTAMBRS parameter or implicitly by the PFILE or JFILE keyword specified in DDS).
</li>
<li>For a member added to a non-keyed logical file, *OBJOPR authority for each of the physical files is required.
</li>
<li>This command is conditionally threadsafe. In multithreaded jobs, this command is not threadsafe for distributed files and fails for distributed files that use relational databases of type *SNA. This command is also not threadsafe and fails for Distributed Data Management (DDM) files of type *SNA, when SYSTEM(*RMT) or SYSTEM(*FILETYPE) is specified.
</li>
</ul>
<p>
<b>Note: </b>An *EXCLRD lock is required on the file to add a member. Because this command adds a member to a file in a library, the library must not be locked (*SHRNUP or *EXCLRD with the Allocate Object (ALCOBJ) command) in another job.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDLFM.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="#ADDLFM.FILE"><b>FILE</b></a></td>
<td valign="top">Logical 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: Logical 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="#ADDLFM.MBR"><b>MBR</b></a></td>
<td valign="top">Logical file member</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="5"><a href="#ADDLFM.DTAMBRS"><b>DTAMBRS</b></a></td>
<td valign="top">Physical file data members</td>
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 32 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="5">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Physical file</td>
<td valign="top">
<i>Qualified object name</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Qualifier 1: Physical file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top" style="padding-left:10pt">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*CURRENT</u></b></td>
</tr><tr>
<td valign="top">Element 2: Member</td>
<td valign="top">
Single values: <b><u>*NONE</u></b><br>Other values (up to 32 repetitions): <i>Name</i></td>
</tr>
<tr>
<td valign="top"><a href="#ADDLFM.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*BLANK</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLFM.SHARE"><b>SHARE</b></a></td>
<td valign="top">Share open data path</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDLFM.FILE"></a>
<h3>Logical file (FILE)</h3>
<p>Specifies the logical file to which the member is to be added.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Logical file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the logical file.
</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 is used to locate the logical 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 logical file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLFM.MBR"></a>
<h3>Logical file member (MBR)</h3>
<p>Specifies the logical file member to be added. The member name must be unique in the file.
</p>
<p>If the FILE parameter specifies a DDM file and a member name is specified as part of the remote file name in the DDM file, the member names must be the same.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the logical file member to be added.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLFM.DTAMBRS"></a>
<h3>Physical file data members (DTAMBRS)</h3>
<p>Specifies the physical files and members that contain the data associated with the logical file member being added by this command. A logical file member can be based on all (*ALL) of the physical files and members on which the logical file itself is based, or the member can be based on a subset of the total files and members.
</p>
<p>
<b>Note: </b>When adding a member to a logical file that is a DDM file, the physical file, if specified, must also be a DDM file with its library and member(s) specified explicitly. *CURRENT is not supported when the logical file is a DDM file.
</p>
<p>When a logical file is created, the physical files specified for the PFILE or JFILE DDS keyword are used to create the logical file. If no library name is specified for the physical files on the PFILE or JFILE keyword, the library list (*LIBL) at file creation time is used to find the physical files; the physical files from the library list are used to create the logical file. The qualified physical files from the PFILE or JFILE keyword (regardless of whether a library name was specified or if the library list was used to find the files) are the physical files associated with the logical file. The names of the physical files associated with the logical file are saved in the description of the logical file. When a member is added to the logical file, the DTAMBRS parameter is used to specify the physical file members associated with the logical file member. Each physical file name specified on the DTAMBRS parameter must be the name of a physical file that is associated with the logical file (saved in the description of the logical file).
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The logical file member being added is based on all the physical files and members (that exist at the time this CRTLF command is entered) used by the logical file. At least one member must exist in at least one of the physical files. The physical file names are specified for the PFILE or JFILE parameter in the DDS.
</dd>
</dl>
<p><b>Element 1: Physical file</b>
</p>
<dl>
<dt><b></b></dt>
<dd>
<p><b>Qualifier 1: Physical file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the names of the physical files that contain the data being accessed by the logical file member being added.
<p>The physical file names must match a name on the PFILE or JFILE keywords in the DDS and cannot be specified more often on the DTAMBRS parameter than on the PFILE or JFILE keywords in the DDS. For join logical files, all physical files specified for the JFILE keyword must be specified for the DTAMBRS parameter and each physical file must contain only one member. If a physical file name is not specified for a physical file that is on a PFILE or JFILE keyword in the DDS, the logical file member is not based on any member of that physical file.
</p>
</dd>
</dl>
</dd>
<dt><b></b></dt>
<dd>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
<p>If a library name is not specified, the current library name (*CURRENT) from the logical file description is used. If the library name is specified, the physical file must be a physical file associated with the logical file. If the logical file is associated with more than one physical file of the same name, the library name must be specified.
</p>
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</dd>
</dl>
<p><b>Element 2: Member</b>
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>A member name is not specified.
</dd>
</dl>
<p><b>Other values (up to 32 repetitions)</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the names of the physical file members that contain the data being accessed by the logical file member being added.
<p>When the FILE parameter specifies a join logical file or an arrival sequence logical file, only one data member must be specified for the DTAMBRS parameter for each physical file that was specified for the PFILE or JFILE keyword in the DDS. *ALL is valid only if each based-on physical file has only one member. If any of the physical files has more than one member, the specific physical file member must be specified for the DTAMBRS parameter.
</p>
<p>The same physical file name can be specified more than once on the JFILE keyword. In this case, each occurrence of the file name is treated as a different based-on physical file, and must be specified for the DTAMBRS parameter.
</p>
<p>Up to 32 qualified physical file names and physical file member names can be specified. Also, the total number of member names cannot exceed 32. For example, one file can specify 32 members, two files can each have 16 members, or 32 files can each have one member specified.
</p>
<p>For DDM file:
</p>
<ul>
<li>The file names specified in the DTAMBRS parameter must be the names of the DDM files that represent the remote based-on physical files. If a member name was specified as part of the remote file name in the DDM file, only that member name can be specified for the DTAMBRS parameter. The member names must be the actual remote file member names.
</li>
<li>The based-on physical files must be at the same system location as the logical file to which the member is being added.
</li>
<li>When no member name is specified for the remote file name in the DDM file, all members are accessible. When only one member name is specified, only that member is accessible through that DDM file.
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLFM.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the object.
</p>
<dl>
<dt><b><u>*BLANK</u></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="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLFM.SHARE"></a>
<h3>Share open data path (SHARE)</h3>
<p>Specifies whether the open data path (ODP) is shared with other programs in the same routing step. When an ODP is shared, the programs accessing the file share facilities such as the file status and the buffer.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The ODP is not shared with other programs in the routing step. A new ODP for the file is created and used every time a program opens the file.
</dd>
</dl>
<dl>
<dt><b>*YES</b></dt>
<dd>The same ODP is shared with each program in the job that also specifies *YES when it opens the file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDLFM.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
ADDLFM FILE(INVENLIB/STOCKTXS) MBR(JANUARY)
DTAMBRS((INVENTXS (JANUARY)))
TEXT('JANUARY STOCK ACTIVITY BY LOCATION')
</pre>
</p>
<p>This command adds a member named JANUARY to the logical file named STOCKTXS in the INVENLIB library. The logical file has access to the data stored in the JANUARY member of the INVENTXS physical file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDLFM.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3204</b></dt>
<dd>Cannot find object needed for file &amp;1 in &amp;2.
</dd>
<dt><b>CPF7306</b></dt>
<dd>Member &amp;1 not added to file &amp;2 in &amp;3.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLFM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>