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

488 lines
18 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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 Directory Shadow System (ADDDIRSHD)</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="ADDDIRSHD.Top_Of_Page"></a>
<h2>Add Directory Shadow System (ADDDIRSHD)</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="#ADDDIRSHD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDDIRSHD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDDIRSHD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDDIRSHD"></a>
<p>The Add Directory Shadow System (ADDDIRSHD) command adds a supplier system to supply system distribution directory data to your system through directory shadowing.
</p>
<p><b>Restriction:</b> To use this command, you must have security administrator (*SECADM) authority.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDDIRSHD.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"><a href="#ADDDIRSHD.SYSNAME"><b>SYSNAME</b></a></td>
<td valign="top">System name</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDDIRSHD.SCD"><b>SCD</b></a></td>
<td valign="top">Scheduled shadow</td>
<td valign="top">Single values: <b><u>*CURRENT</u></b><br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Date</td>
<td valign="top">
<i>Date</i></td>
</tr>
<tr>
<td valign="top">Element 2: Time</td>
<td valign="top">
<i>Time</i></td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.FRQ"><b>FRQ</b></a></td>
<td valign="top">Shadowing frequency</td>
<td valign="top">*DAILY, <b><u>*WEEKLY</u></b>, *BIWEEKLY, *MONTHLY, *MONTHLYREL, *HOURS</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.HOURS"><b>HOURS</b></a></td>
<td valign="top">Intervals of hours</td>
<td valign="top">1-999, <b><u>5</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.SKIPDAY"><b>SKIPDAY</b></a></td>
<td valign="top">Days to skip</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values (up to 5 repetitions): *SUN, *MON, *TUE, *WED, *THU, *FRI, *SAT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.MONTHWK"><b>MONTHWK</b></a></td>
<td valign="top">Week of the month</td>
<td valign="top"><b><u>4</u></b>, *LAST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDDIRSHD.INZ"><b>INZ</b></a></td>
<td valign="top">Initial shadow</td>
<td valign="top">Single values: *NONAPPC, *COMPLETED<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Method</td>
<td valign="top">
<b><u>*APPC</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace data</td>
<td valign="top">
<b><u>*NO</u></b>, *YES</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.RMTLOCNAME"><b>RMTLOCNAME</b></a></td>
<td valign="top">Remote location name</td>
<td valign="top"><i>Character value</i>, <b><u>*SYSNAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.MODE"><b>MODE</b></a></td>
<td valign="top">Mode</td>
<td valign="top"><i>Character value</i>, <b><u>*NETATR</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.RMTNETID"><b>RMTNETID</b></a></td>
<td valign="top">Remote network identifier</td>
<td valign="top"><i>Character value</i>, <b><u>*LOC</u></b>, *NETATR, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.LCLLOCNAME"><b>LCLLOCNAME</b></a></td>
<td valign="top">Local location name</td>
<td valign="top"><i>Character value</i>, <b><u>*LOC</u></b>, *NETATR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDDIRSHD.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*SYSNAME</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDDIRSHD.SYSNAME"></a>
<h3>System name (SYSNAME)</h3>
<p>Specifies a maximum of 8 characters for the name of the supplier system you are adding. You can specify uppercase letters A through Z, numbers 0 through 9, and special characters @, #, $, and embedded blanks. Embedded blanks must be enclosed in single quotation marks ('). Leading blanks are not allowed. The @, #, and $ characters are not recommended because they are not part of an invariant character set and are not available on all keyboards.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.SCD"></a>
<h3>Scheduled shadow (SCD)</h3>
<p>Specifies the date and time at which the system you are adding begins supplying data to your system.
</p>
<dl>
<dt><b>*CURRENT</b></dt>
<dd>The system begins shadowing data at the current date and time.
</dd>
</dl>
<p>The possible <b>Shadow Date</b> values are:
</p>
<dl>
<dt><b><i>scheduled-shadow-date</i></b></dt>
<dd>Specify the date on which the system begins supplying data to your system. The date must be specified in the job date format.
</dd>
</dl>
<p>The possible <b>Shadow Time</b> values are:
</p>
<dl>
<dt><b><i>scheduled-shadow-time</i></b></dt>
<dd>Specify the time at which the system begins supplying data to your system.
<p>The time is specified in 24-hour format with or without a time separator as follows:
</p>
<ul>
<li>With a time separator, specify a string of 5 or 8 digits where the time separator separates the hours, minutes, and seconds. If this command is entered from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command fails.
</li>
<li>Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where <b>hh</b> = hours, <b>mm</b> = minutes, and <b>ss</b> = seconds. Valid values for <b>hh</b> range from 00 through 23. Valid values for <b>mm</b> and <b>ss</b> range from 00 through 59.
</li>
</ul>
</dd>
</dl>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.FRQ"></a>
<h3>Shadowing frequency (FRQ)</h3>
<p>Specifies the frequency with which the supplier system you are adding shadows data to your system, based on the value specified on the SCD parameter.
</p>
<dl>
<dt><b><u>*WEEKLY</u></b></dt>
<dd>Shadowing occurs once a week.
</dd>
<dt><b>*DAILY</b></dt>
<dd>Shadowing occurs once a day.
</dd>
<dt><b>*BIWEEKLY</b></dt>
<dd>Shadowing occurs every other week.
</dd>
<dt><b>*MONTHLY</b></dt>
<dd>Shadowing occurs on the same date every month.
</dd>
<dt><b>*MONTHLYREL</b></dt>
<dd>Shadowing occurs on the same relative day of the same relative week of every month, such as the first Monday of the month.
</dd>
<dt><b>*HOURS</b></dt>
<dd>Shadowing occurs in the interval specified on the HOURS parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.HOURS"></a>
<h3>Intervals of hours (HOURS)</h3>
<p>Specifies the number of hours between shadows from the supplier system. This parameter is valid only when FRQ(*HOURS) is specified.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.SKIPDAY"></a>
<h3>Days to skip (SKIPDAY)</h3>
<p>Specifies the days of the week when shadowing does not occur. A maximum of five values, other than *NONE, can be specified.
</p>
<p>This parameter is valid only when FRQ(*DAILY) is specified.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No days are skipped.
</dd>
<dt><b>*SUN</b></dt>
<dd>Sundays are skipped.
</dd>
<dt><b>*MON</b></dt>
<dd>Mondays are skipped.
</dd>
<dt><b>*TUE</b></dt>
<dd>Tuesdays are skipped.
</dd>
<dt><b>*WED</b></dt>
<dd>Wednesdays are skipped.
</dd>
<dt><b>*THU</b></dt>
<dd>Thursdays are skipped.
</dd>
<dt><b>*FRI</b></dt>
<dd>Fridays are skipped.
</dd>
<dt><b>*SAT</b></dt>
<dd>Saturdays are skipped.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.MONTHWK"></a>
<h3>Week of the month (MONTHWK)</h3>
<p>Specifies whether shadowing that occurs on the same relative day of the month is scheduled to occur in the fourth week or the last week of the month.
</p>
<p>This parameter is valid only when FRQ(*MONTHLYREL) is specified and when the SCD parameter date is the 22nd, 23rd, or 24th.
</p>
<dl>
<dt><b><u>4</u></b></dt>
<dd>Shadowing occurs on the same relative day in the fourth week of the month.
</dd>
<dt><b>*LAST</b></dt>
<dd>Shadowing occurs on the same relative day in the last week of the month, whether or not the month has four or five weeks.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.INZ"></a>
<h3>Initial shadow (INZ)</h3>
<p>Specifies the method used for the first shadow from the supplier system. The first shadow duplicates all of the local and shadowed data in the supplier system's distribution directory. Remote users are optionally supplied when the supplier specifies RMTSHD(*YES) on the Change Directory Attributes (CHGDIRA) command. Subsequent shadows include only data that has changed since the previous shadow.
</p>
<p>The possible <b>Automatic Shadow</b> values are:
</p>
<dl>
<dt><b>*APPC</b></dt>
<dd>The first shadow occurs when this command is run using advanced program-to-program (APPC) communication. If you are adding a supplier system with a large directory, you may want to specify *NONAPPC to prevent the first shadow from tying up your communications lines.
<p>When *APPC is specified, Element 2 allows you to specify whether the data in the fields of a directory entry on your system is replaced by shadowed data if the same entry also exists in the supplier system's directory.
</p>
</dd>
</dl>
<p>The possible <b>Replace Data</b> values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The data in the fields of existing directory entries on your system is not replaced with data from the supplier system.
</dd>
<dt><b>*YES</b></dt>
<dd>All shadowed data is added to your system distribution directory. The data in the fields of existing directory entries on your system is replaced with shadowed data if the same entry also exists in the supplier system's directory.
</dd>
<dt><b>*NONAPPC</b></dt>
<dd>The Copy to Directory (CPYTODIR) command is used for the first shadow. It is recommended that you run the CPYTODIR command before running this command. If shadowing from the supplier system you are adding starts before CPYTODIR is run, you may lose data.
</dd>
<dt><b>*COMPLETED</b></dt>
<dd>The initial shadow has already been done using the CPYTODIR command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.RMTLOCNAME"></a>
<h3>Remote location name (RMTLOCNAME)</h3>
<p>Specifies the remote location name of the supplier system you are adding.
</p>
<dl>
<dt><b><u>*SYSNAME</u></b></dt>
<dd>The value specified on the SYSNAME parameter is used for the remote location name.
</dd>
<dt><b><i>remote-location-name</i></b></dt>
<dd>Specify the name of a remote location.
<p>A maximum of 8 characters can be specified. The first character must be an uppercase letter A through Z, or special character $, #, or @. The name cannot contain a blank, plus sign (+), period (.), or an underscore (_). For more information, see the APPC Programmer's Guide.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.MODE"></a>
<h3>Mode (MODE)</h3>
<p>Specifies the name of the mode that defines the sessions on the device used when shadowing data from the supplier system.
</p>
<dl>
</dl>
<dl>
<dt><b><u>*NETATR</u></b></dt>
<dd>The mode in the network attributes is used.
</dd>
</dl>
<dl>
<dt><b><i>mode-name</i></b></dt>
<dd>Specify the mode name.
<p>A maximum of 8 characters can be specified. The first character must be an uppercase letter A through Z, or special character $, #, or @. The name cannot contain a blank, plus sign (+), period (.), or an underscore (_). For more information, see the APPC Programmer's Guide.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.RMTNETID"></a>
<h3>Remote network identifier (RMTNETID)</h3>
<p>Specifies the supplier system's remote network identifier (ID).
</p>
<dl>
<dt><b><u>*LOC</u></b></dt>
<dd>The remote network ID associated with the remote location is used. If several remote network IDs are associated with the remote location, the system determines which remote network ID is used.
</dd>
</dl>
<dl>
<dt><b>*NETATR</b></dt>
<dd>The remote network identifier specified in the network attributes is used.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*NONE</b></dt>
<dd>No remote network identifier (ID) is used.
</dd>
</dl>
<dl>
<dt><b><i>remote-network-ID</i></b></dt>
<dd>Specify a maximum of 8 characters for the remote network ID.
<p>The first character must be an uppercase letter A through Z, or special character $, #, or @. The name cannot contain a blank, plus sign (+), period (.), or an underscore (_). For more information, see the APPC Programmer's Guide.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.LCLLOCNAME"></a>
<h3>Local location name (LCLLOCNAME)</h3>
<p>Specifies the local location name. The local location name is used to identify your system to the supplier system you are adding.
</p>
<dl>
<dt><b><u>*LOC</u></b></dt>
<dd>The local location name associated with the remote location is used.
</dd>
</dl>
<dl>
<dt><b>*NETATR</b></dt>
<dd>The LCLLOCNAME value specified in the system network attributes is used.
</dd>
</dl>
<dl>
<dt><b><i>local-location-name</i></b></dt>
<dd>Specify a maximum of 8 characters for the local location name.
<p>The first character must be an uppercase letter A through Z, or special character $, #, or @. The name cannot contain a blank, plus sign (+), period (.), or an underscore (_). For more information, see the APPC Programmer's Guide.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDDIRSHD.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the object.
</p>
<dl>
<dt><b><u>*SYSNAME</u></b></dt>
<dd>The name specified on the SYSNAME parameter is used for the description.
</dd>
<dt><b><i>'description'</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="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDDIRSHD.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Shadowing a System Weekly</b>
</p>
<p>
<pre>
ADDDIRSHD SYSNAME(NYCITY)
SCD( '92/05/01' '17:00:00' )
FRQ(*WEEKLY) TEXT('Shadow New York System')
</pre>
</p>
<p>This command adds the supplier system NYCITY, which starts shadowing directory data to the local system on May 1, 1992 at 5:00 p.m. The shadow frequency is once a week. The description of the shadow system is 'Shadow New York System'.
</p>
<p><b>Example 2: Shadowing a Remote System Hourly</b>
</p>
<p>
<pre>
ADDDIRSHD SYSNAME(CHICAGO)
SCD('92/04/01' '20:00:00')
FRQ(*HOURS) HOURS(12) RMTLOCNAME(CHIC01)
LCLLOCNAME(CHICAGO1) TEXT('Shadow Chicago System')
</pre>
</p>
<p>This command adds the supplier system CHICAGO, which starts shadowing directory data to the local system on April 1, 1992 at 8:00 p.m. The frequency of shadows is every 12 hours. The description of the shadow system is 'Shadow Chicago System'. The remote location name of the CHICAGO system is CHIC01 and the local location name is CHICAGO1.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDDIRSHD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF90A8</b></dt>
<dd>*SECADM special authority required to do requested operation.
</dd>
<dt><b>CPF90FE</b></dt>
<dd>Add or change of shadow supplier &amp;1 was not successful.
</dd>
<dt><b>CPF905C</b></dt>
<dd>Error occurred trying to find a translation table.
</dd>
<dt><b>CPF9838</b></dt>
<dd>User profile storage limit exceeded.
</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>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDDIRSHD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>