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

292 lines
13 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>Generate Message Catalog (GENCAT)</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="GENCAT.Top_Of_Page"></a>
<h2>Generate Message Catalog (GENCAT)</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="#GENCAT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#GENCAT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#GENCAT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="GENCAT"></a>
<p>This command is an alias for the Merge Message Catalog (MRGMSGCLG) command and can also be issued using the following alternative command name:
</p>
<ul>
<li>MRGMSGCLG
</li>
</ul>
<p>The Generate Message Catalog (GENCAT) command merges message text from one or more source files (SRCFILE parameter) with message text in the specified message catalog (CLGFILE parameter). If the catalog specified does not already exist, it will be created using values specified for the CLGCCSID, DTAAUT, and OBJAUT parameters. If the catalog already exists, the CCSID, DTAAUT, and OBJAUT attributes of the existing message catalog will be used.
</p>
<p>You can specify up to 300 message text source files. Message text source files are processed in the sequence specified. Each successive source file modifies the catalog. If a message number in the source file already exists in the message catalog, the new message text defined in the source file replaces the old message text in the message catalog file. If a message number in the source file does not already exist in the message catalog, the message information is added to the message catalog.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="GENCAT.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="#GENCAT.CLGFILE"><b>CLGFILE</b></a></td>
<td valign="top">Message catalog name</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#GENCAT.SRCFILE"><b>SRCFILE</b></a></td>
<td valign="top">Source file path name</td>
<td valign="top">Values (up to 300 repetitions): <i>Path name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#GENCAT.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="#GENCAT.CLGCCSID"><b>CLGCCSID</b></a></td>
<td valign="top">Message catalog CCSID</td>
<td valign="top">1-65533, <b><u>*SRCCCSID</u></b>, *JOB</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENCAT.SRCCCSID"><b>SRCCCSID</b></a></td>
<td valign="top">Source file CCSID</td>
<td valign="top">1-65533, <b><u>*SRCFILE</u></b>, *JOB</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENCAT.DTAAUT"><b>DTAAUT</b></a></td>
<td valign="top">Public authority for data</td>
<td valign="top"><i>Name</i>, <b><u>*INDIR</u></b>, *NONE, *RWX, *RX, *RW, *WX, *R, *W, *X, *EXCLUDE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENCAT.OBJAUT"><b>OBJAUT</b></a></td>
<td valign="top">Public authority for object</td>
<td valign="top">Single values: <b><u>*INDIR</u></b>, *NONE, *ALL<br>Other values (up to 4 repetitions): *OBJEXIST, *OBJMGT, *OBJALTER, *OBJREF</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="GENCAT.CLGFILE"></a>
<h3>Message catalog name (CLGFILE)</h3>
<p>Specifies the path name of the message catalog to be changed or created. All directories in a stream file path name must exist. If no stream file exists with the specified path name, a message catalog with the specified file name is created. If the path name is in the QSYS file system, the file must exist. If a file member in the QSYS file system does not exist, it is created. Source physical files with multiple data fields are not supported.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.SRCFILE"></a>
<h3>Source file path name (SRCFILE)</h3>
<p>Specifies the path name of the source file that contains the message text to be merged into the message catalog. If the file is from the QSYS file system, then it must be a database source physical file.
</p>
<p>
<b>Note: </b>If the source file is not a record file, then each line in the source file must have been terminated with a newline or linefeed character when the source file was created.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the message catalog.
</p>
<p>
<b>Note: </b>Assigning text to objects is dependent on the support provided by the file system or object type used for the message catalog.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*BLANK</u></b></dt>
<dd>The mode name consisting of 8 blank characters is used.
</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="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.CLGCCSID"></a>
<h3>Message catalog CCSID (CLGCCSID)</h3>
<p>Specifies the coded character set ID (CCSID) in which to store the message text in the message catalog. If the message catalog is a stream file, the CCSID value entered is used to set the stream file's attributes. Use the Work with Object Links (WRKLNK) command to display the CCSID of a message catalog. Use the Display File Description (DSPFD) command to determine the CCSID of a message catalog in the QSYS file system.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SRCCCSID</u></b></dt>
<dd>Special value indicating that the CCSID will be determined from the value specified for the source file CCSID (SRCCSID parameter).
</dd>
<dt><b>*JOB</b></dt>
<dd>Special value indicating the job CCSID is used for the catalog information. If the job CCSID is 65535, the job default CCSID is used.
</dd>
<dt><b><i>coded-character-set-ID</i></b></dt>
<dd>Specify the CCSID used for the catalog information. The values 0, 65534, and 65535 are not valid.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.SRCCCSID"></a>
<h3>Source file CCSID (SRCCCSID)</h3>
<p>Specifies the coded character set ID (CCSID) of the source file.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SRCFILE</u></b></dt>
<dd>Special value indicating that the CCSID will be determined from the CCSID of the first source file (SRCFILE parameter).
</dd>
<dt><b>*JOB</b></dt>
<dd>Special value indicating the job CCSID is used for the CCSID of the source file. If the job CCSID is 65535, the job default CCSID is used.
</dd>
<dt><b><i>coded-character-set-ID</i></b></dt>
<dd>Specify the CCSID of the source file. The values 0, 65534, and 65535 are not valid.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.DTAAUT"></a>
<h3>Public authority for data (DTAAUT)</h3>
<p>Specifies the public authority given users for the data in the object created.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*INDIR</u></b></dt>
<dd>The authority for the object being created is determined by the directory it is being created in. If *INDIR is used for DTAAUT, it is also required for OBJAUT.
</dd>
<dt><b>*RWX</b></dt>
<dd>The users are given *RWX authority to the objects. *RWX authority allows the user to perform all operations on the object except those limited to the owner or controlled by object existence, object management, object alter, and object reference authority. The user can change the object and perform basic functions on the object. *RWX authority provides object operational authority and all the data authorities.
</dd>
<dt><b>*RX</b></dt>
<dd>*RX authority allows the user to perform basic operations on the object, such as run a program or display the contents of a file. The user is prevented from changing the object. *RX authority provides object operational authority and read and execute authorities.
</dd>
<dt><b>*RW</b></dt>
<dd>*RW authority allows the user to view the contents of an object and modify the contents of an object. *RW authority provides object operational authority and data read, add, update, and delete authorities.
</dd>
<dt><b>*WX</b></dt>
<dd>*WX authority allows the user to modify the contents of an object and run a program or search a library or directory. *WX authority provides object operational authority and data add, update, delete, and execute authorities.
</dd>
<dt><b>*R</b></dt>
<dd>*R authority allows the user to view the contents of an object. *R authority provides object operational authority and data read authority.
</dd>
<dt><b>*W</b></dt>
<dd>*W authority allows the user to modify the contents of an object. *W authority provides object operational authority and data add, update, and delete authorities.
</dd>
<dt><b>*X</b></dt>
<dd>*X authority allows the user to run a program or search a library or directory. *X authority provides object operational authority and data execute authority.
</dd>
<dt><b>*EXCLUDE</b></dt>
<dd>Exclude authority prevents the user from accessing the object. The OBJAUT value must be *NONE if this special value is used.
</dd>
<dt><b>*NONE</b></dt>
<dd>The users will not be given any of the data authorities to the objects. This value cannot be used with OBJAUT value of *NONE.
</dd>
<dt><b><i>authorization-list-name</i></b></dt>
<dd>Specify the name of the authorization list used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENCAT.OBJAUT"></a>
<h3>Public authority for object (OBJAUT)</h3>
<p>Specifies the authorities given users to the object.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*INDIR</u></b></dt>
<dd>The object authority is based on the authority for the directory where this object is being created. If *INDIR is used for DTAAUT, it is also required for OBJAUT.
</dd>
<dt><b>*NONE</b></dt>
<dd>None of the other object authorities (existence, management, alter, or reference) will be given to the users. If *EXCLUDE or an authorization list name is specified for the DTAAUT parameter, this value must be specified.
</dd>
<dt><b>*ALL</b></dt>
<dd>All of the other object authorities (existence, management, alter, and reference) will be given to the users.
<p>Or specify up to four (4) of the following values:
</p>
</dd>
<dt><b>*OBJEXIST</b></dt>
<dd>The users will be given object existence authority to the object.
</dd>
<dt><b>*OBJMGT</b></dt>
<dd>The users will be given object management authority to the object.
</dd>
<dt><b>*OBJALTER</b></dt>
<dd>The users will be given object alter authority to the object.
</dd>
<dt><b>*OBJREF</b></dt>
<dd>The users will be given object reference authority to the object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="GENCAT.COMMAND.EXAMPLES">Examples</a> </h3>
<h3>Examples for MRGMSGCLG</h3>
<p>
<pre>
MRGMSGCLG CLGFILE('/USDIR/USMSG.CAT') CLGCCSID(*SRCCSID)
SRCFILE('/QSYS.LIB/MYLIB.LIB/MSGSRC.FILE/USMSG.MBR')
DTAAUT(*R) TEXT('Message catalog for USA')
</pre>
</p>
<p>This command merges the message text from member USMSG of source physical file MSGSRC in library MYLIB in the QSYS file system with message catalog USMSG.CAT in directory USDIR. If the message catalog does not already exist, it will be created with the CCSID of the source file and data authority of *R. The text parameter describes this as a message catalog for the USA.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="GENCAT.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3BE3</b></dt>
<dd>Message catalog &amp;1 not created or updated.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENCAT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>