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

404 lines
14 KiB
HTML
Raw 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>Display DST Catalog Entries (DSPDSTCLGE)</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="DSPDSTCLGE.Top_Of_Page"></a>
<h2>Display DST Catalog Entries (DSPDSTCLGE)</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="#DSPDSTCLGE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPDSTCLGE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPDSTCLGE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPDSTCLGE"></a>
<p>The Display Distribution Catalog Entry (DSPDSTCLGE) command allows the user to view information about distribution catalog entries.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPDSTCLGE.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="11"><a href="#DSPDSTCLGE.GLBNAME"><b>GLBNAME</b></a></td>
<td valign="top">Global name</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="11">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top">Element 1: Global name token 1</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 2: Global name token 2</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 3: Global name token 3</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 4: Global name token 4</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 5: Global name token 5</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 6: Global name token 6</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 7: Global name token 7</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 8: Global name token 8</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 9: Global name token 9</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top">Element 10: Global name token 10</td>
<td valign="top">
<i>Character value</i>, <b><u>*ANY</u></b>, *HIGHEST, *LOWEST, *NETID, *CPNAME, *SERVER, *TARGET, *MDDATE, *MDTIME</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDSTCLGE.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDSTCLGE.DETAIL"><b>DETAIL</b></a></td>
<td valign="top">Detail</td>
<td valign="top"><b><u>*BASIC</u></b>, *FULL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPDSTCLGE.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</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="#DSPDSTCLGE.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPDSTCLGE.GLBNAME"></a>
<h3>Global name token 1 (GLBNAME)</h3>
<p>Specifies the tokens of the global name used to find the list of catalog entries to be displayed.
</p>
<p>The possible values for token 1 are:
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The corresponding token value is ignored.
</dd>
<dt><b>*HIGHEST</b></dt>
<dd>The catalog entry with the highest corresponding token value is selected.
</dd>
<dt><b>*LOWEST</b></dt>
<dd>The catalog entry with the lowest corresponding token value is selected.
</dd>
<dt><b>*NETID</b></dt>
<dd>The first global name token value is a network ID generated by the command from the network attributes.
</dd>
<dt><b>*SERVER</b></dt>
<dd>This token is stored within the change request activity with the value &amp;SERVER, and replaced by the short name of the change control server when the object is distributed.
</dd>
<dt><b>*TARGET</b></dt>
<dd>This token is stored within the change request activity with the value &amp;TARGET, and replaced by the short name of the target when the object is distributed.
</dd>
<dt><b>*MDDATE</b></dt>
<dd>This token is stored within the change request activity with the value &amp;DATE, and replaced when distributed by the date the object was last modified.
</dd>
<dt><b>*MDTIME</b></dt>
<dd>This token is stored within the change request activity with the value &amp;TIME, and replaced when distributed by the time the object was last modified.
</dd>
<dt><b><i>global-name-token</i></b></dt>
<dd>Specify the first token of the global name.
</dd>
</dl>
<p>The possible values for tokens 2 through 10 are:
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The corresponding token value is ignored.
</dd>
<dt><b>*HIGHEST</b></dt>
<dd>The catalog entry with the highest corresponding token value is selected.
</dd>
<dt><b>*LOWEST</b></dt>
<dd>The catalog entry with the lowest corresponding token value is selected.
</dd>
<dt><b>*NETID</b></dt>
<dd>The global name token <i>n</i> value is a network ID. This value is generated from the network attributes.
</dd>
<dt><b>*CPNAME</b></dt>
<dd>The global name token value is a control point name. This value is generated from the network attributes.
</dd>
<dt><b>*SERVER</b></dt>
<dd>This token is stored within the change request activity with the value &amp;SERVER, and replaced by the short name of the change control server when the object is distributed.
</dd>
<dt><b>*TARGET</b></dt>
<dd>This token is stored within the change request activity with the value &amp;TARGET, and replaced by the short name of the target when the object is distributed.
</dd>
<dt><b>*MDDATE</b></dt>
<dd>This token is stored within the change request activity with the value &amp;DATE, and replaced when distributed by the date the object was last modified.
</dd>
<dt><b>*MDTIME</b></dt>
<dd>This token is stored within the change request activity with the value &amp;TIME, and replaced when distributed by the time the object was last modified.
</dd>
<dt><b><i>global-name-token</i></b></dt>
<dd>Specify a token of the global name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDSTCLGE.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is shown at the requesting workstation, printed with the job's spooled output, or directed to a database file.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>Output requested by interactive job is shown on the display. Output requested by a batch job is printed with the job's spooled output.
</dd>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database file specified on the OUTFILE parameter. All data is written to the output file regardless of the value specified on the DETAIL keyword.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDSTCLGE.DETAIL"></a>
<h3>Detail (DETAIL)</h3>
<p>Specifies which set of information is shown for each catalog entry. This parameter is valid only when OUTPUT(*PRINT) is specified.
</p>
<dl>
<dt><b><u>*BASIC</u></b></dt>
<dd>A list of global names found in the search is printed.
</dd>
<dt><b>*FULL</b></dt>
<dd>All of the catalog entry information found in the search is printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDSTCLGE.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the qualified name of the database file to which the output of the display is directed. If the output file does not exist, this command creates a database file in the specified library.
</p>
<p>The name of the output file can be qualified by one of the following library values:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</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.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
<dl>
<dt><b><i>outfile-name</i></b></dt>
<dd>Specify the name of the database to be used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDSTCLGE.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output of the display is directed. If a member already exists, and *REPLACE is specified, the system clears it and adds the new records. If the member does not exist and a member name is not specified, the system creates a member with the name of the file specified on the OUTFILE parameter. If the member name is specified, but the member does not exist, the system creates it.
</p>
<p>The possible <b>member to receive output</b> values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the member to receive the output.
</dd>
</dl>
<p>The possible <b>operation to perform on member</b> values are:
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDSTCLGE.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Displaying All Catalog Entries</b>
</p>
<p>
<pre>
DSPDSTCLGE
</pre>
</p>
<p>This command displays all of the catalog entries.
</p>
<p><b>Example 2: Displaying Global Catalog Entries</b>
</p>
<p>
<pre>
DSPDSTCLGE GLBNAME(ABACO *HIGHEST ZONEA *LOWEST) OUTPUT(*)
</pre>
</p>
<p>This command displays the catalog entry for the global name selected.
</p>
<p><b>Example 3: Storing Catalog Information</b>
</p>
<p>
<pre>
DSPDSTCLGE GLBNAME(ABACO *HIGHEST LOGO *LOWEST)
OUTPUT(*OUTFILE) OUTFILE(MYLIB/MYFILE)
</pre>
</p>
<p>This command sends all information for all of the catalog entries meeting the selection criteria to the output file MYLIB/MYFILE.
</p>
<p><b>Example 4: Displaying Catalog Entry Information</b>
</p>
<p>This example displays catalog entry information for an entry cataloged with *SERVER, *TARGET, *MDDATE and *MDTIME tokens.
</p>
<p>
<pre>
DSPDSTCLGE GLBNAME(CMPNY1 SALES *SERVER *TARGET *MDDATE
*MDTIME) OUTPUT(*)
</pre>
</p>
<p>This command displays the catalog entry information for the global name CMPNY1 SALES &amp;SERVER &amp;TARGET &amp;DATE &amp;TIME
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDSTCLGE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<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>CPF9860</b></dt>
<dd>Error occurred during output file processing.
</dd>
<dt><b>CPF9871</b></dt>
<dd>Error occurred while processing.
</dd>
<dt><b>MSS0114</b></dt>
<dd>Not authorized to distribution catalog.
</dd>
<dt><b>MSS0116</b></dt>
<dd>Maximum global name length exceeded.
</dd>
<dt><b>MSS0117</b></dt>
<dd>Global name token &amp;3 not valid. Reason code &amp;4.
</dd>
<dt><b>MSS011B</b></dt>
<dd>Distribution catalog entry not found.
</dd>
<dt><b>MSS011C</b></dt>
<dd>Distribution catalog not available.
</dd>
<dt><b>MSS0123</b></dt>
<dd>Internal processing error occurred.
</dd>
<dt><b>MSS0124</b></dt>
<dd>Error while managing distribution catalog.
</dd>
<dt><b>MSS0125</b></dt>
<dd>Distribution catalog damaged.
</dd>
<dt><b>MSS0909</b></dt>
<dd>Error while accessing change control server data base.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDSTCLGE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>