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

483 lines
18 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>Create Product Definition (CRTPRDDFN)</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="CRTPRDDFN.Top_Of_Page"></a>
<h2>Create Product Definition (CRTPRDDFN)</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="#CRTPRDDFN.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CRTPRDDFN.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CRTPRDDFN.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CRTPRDDFN"></a>
<p>The Create Product Definition (CRTPRDDFN) command creates a product definition object. This object contains common information for the product.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTPRDDFN.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="#CRTPRDDFN.PRDDFN"><b>PRDDFN</b></a></td>
<td valign="top">Product definition</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: Product definition</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#CRTPRDDFN.PRDID"><b>PRDID</b></a></td>
<td valign="top">Product ID</td>
<td valign="top"><i>Character value</i>, *SER</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.RLS"><b>RLS</b></a></td>
<td valign="top">Release level</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CRTPRDDFN.RGSID"><b>RGSID</b></a></td>
<td valign="top">Registration identifier</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Required, Positional 4</td>
</tr>
<tr>
<td valign="top">Element 1: Registration type</td>
<td valign="top">
*PHONE, *CUSTOMER</td>
</tr>
<tr>
<td valign="top">Element 2: Registration value</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.MSGF"><b>MSGF</b></a></td>
<td valign="top">Message file</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 5</td>
</tr>
<tr>
<td valign="top" rowspan="6"><a href="#CRTPRDDFN.PRDOPT"><b>PRDOPT</b></a></td>
<td valign="top">Product options</td>
<td valign="top">Values (up to 100 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="6">Required, Positional 6</td>
</tr>
<tr>
<td valign="top">Element 1: Product option</td>
<td valign="top">
1-99, *BASE</td>
</tr>
<tr>
<td valign="top">Element 2: Message identifier</td>
<td valign="top">
<i>Name</i></td>
</tr>
<tr>
<td valign="top">Element 3: Allow dynamic naming</td>
<td valign="top">
<b><u>*NODYNNAM</u></b>, *ALWDYNNAM</td>
</tr>
<tr>
<td valign="top">Element 4: Language load ID</td>
<td valign="top">
Single values: <b><u>*NONE</u></b>, *IBMLNG, *BASEOPT<br>Other values (up to 51 repetitions): <i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 5: Code load ID</td>
<td valign="top">
<i>Character value</i>, <b><u>*CODEDFT</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.CPYRGTFST"><b>CPYRGTFST</b></a></td>
<td valign="top">Copyright first year</td>
<td valign="top"><i>Character value</i>, *CURRENT, *NONE</td>
<td valign="top">Required, Positional 7</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.CPYRGTCUR"><b>CPYRGTCUR</b></a></td>
<td valign="top">Copyright current year</td>
<td valign="top"><i>Character value</i>, <b><u>*CURRENT</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.ALWMLTRLS"><b>ALWMLTRLS</b></a></td>
<td valign="top">Allow multiple releases</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.PRDIDSFX"><b>PRDIDSFX</b></a></td>
<td valign="top">Product ID suffix</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.RLSDATE"><b>RLSDATE</b></a></td>
<td valign="top">Release date</td>
<td valign="top"><i>Date</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTPRDDFN.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="#CRTPRDDFN.AUT"><b>AUT</b></a></td>
<td valign="top">Authority</td>
<td valign="top"><b><u>*LIBCRTAUT</u></b>, *USE, *ALL, *CHANGE, *EXCLUDE</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CRTPRDDFN.PRDDFN"></a>
<h3>Product definition (PRDDFN)</h3>
<p>Specifies the qualified name of the product definition object being created.
</p>
<p>The name of the product definition can be qualified by one of the following library values:
</p>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to create the product definition. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the product definition is to be created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.PRDID"></a>
<h3>Product ID (PRDID)</h3>
<p>Specifies the 7-character ID of the product for which a product definition is being created. The product identifier must be in the format <i>nlxxxxx</i>, where <i>n</i> is any numeric character 0 through 9, <i>l</i> is any upper-case letter A through Z, and <i>x</i> is any numeric character 0 through 9 or upper-case letter A through Z.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*SER</b></dt>
<dd>The serial number of the system, together with the product identifier suffix (PRDIDSFX) parameter, is used as the product ID. This does not guarantee a unique product ID.
</dd>
<dt><b><i>product-ID</i></b></dt>
<dd>Specify the 7-character ID of the product for which a product definition is being created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.RLS"></a>
<h3>Release level (RLS)</h3>
<p>Specifies the version, release, and modification level of the product being created.
</p>
<dl>
<dt><b><i>release-level</i></b></dt>
<dd>Specify the release level in the format VxRyMz, where x and y are 0 through 9, and z is 0 through 9 and A through Z.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.RGSID"></a>
<h3>Registration identifier (RGSID)</h3>
<p>Specifies the registration ID of the organization developing the product.
</p>
<p>The possible <b>Registration Type</b> values are:
</p>
<dl>
<dt><b>*PHONE</b></dt>
<dd>The 14-character registration value consists of a country or region code, city code, and telephone number.
</dd>
<dt><b>*CUSTOMER</b></dt>
<dd>The registration value consists of a country or region code and an IBM customer number.
</dd>
</dl>
<p>The possible <b>Registration Value</b> values are:
</p>
<dl>
<dt><b><i>registration-value</i></b></dt>
<dd>Specify the 14-character value to be used as the registration ID.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.MSGF"></a>
<h3>Message file (MSGF)</h3>
<p>Specifies the name of the message file to contain the messages which describe the product and its options. The message ID for the base option is the message ID for the product. The message IDs are listed in the PRDOPT parameter. This message file must be in the base option of the product.
</p>
<p>
<b>Note: </b>If the base product has language features, the message file must be an object in the language load's object list rather than the code load. This allows for a message file to be created for each language and for the message files to be installed in the correct libraries.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.PRDOPT"></a>
<h3>Product options (PRDOPT)</h3>
<p>Specifies the options allowed for this product.
</p>
<p>A product requires the first option defined to be the <b>base option</b>. The option for the base option is *BASE. Specify additional options by selecting Options 1 through 99. Additional options do not have to be specified in sequential order. Specify up to 100 options (the base option and up to 99 additional options). Product options must be listed in the product definition before they can be packaged using the Package Product Option (PKGPRDOPT) command.
</p>
<p>The possible <b>Product Option</b> values are:
</p>
<dl>
<dt><b>*BASE</b></dt>
<dd>The base option information is created.
</dd>
<dt><b><i>product-option</i></b></dt>
<dd>Specify the option number of the product option to which the information applies. Valid values range from 1 through 99.
</dd>
</dl>
<p>The possible <b>message ID</b> value is:
</p>
<dl>
<dt><b><i>message-ID</i></b></dt>
<dd>Specify the message ID of the message that describes the product option.
</dd>
</dl>
<p>The possible <b>Allow Dynamic Naming</b> values are:
</p>
<dl>
<dt><b><u>*NODYNNAM</u></b></dt>
<dd>Libraries and root folders are not dynamically named at installation time. The primary library and primary folder names are used except when a secondary language library name is used.
</dd>
<dt><b>*ALWDYNNAM</b></dt>
<dd>Libraries and root folders can be dynamically named at installation time.
</dd>
</dl>
<p>The possible <b>Language Load ID</b> values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No language loads are used.
</dd>
<dt><b>*IBMLNG</b></dt>
<dd>The product option is available in all IBM languages.
</dd>
<dt><b>*BASEOPT</b></dt>
<dd>The language IDs specified for the base option are used for the language load IDs.
</dd>
<dt><b><i>language-load-ID</i></b></dt>
<dd>Specify the languages (29xx) in which the option is available.
</dd>
</dl>
<p>The possible <b>Code Load ID</b> values are:
</p>
<dl>
<dt><b><u>*CODEDFT</u></b></dt>
<dd>The default code load ID, 5001, is used.
</dd>
<dt><b><i>code-load-ID</i></b></dt>
<dd>Specify the code load ID for this product option. Valid values range from 5001 through 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.CPYRGTFST"></a>
<h3>Copyright first year (CPYRGTFST)</h3>
<p>Specifies the first copyright year for the product. The year must be specified as a four-digit number, such as 1990.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*CURRENT</b></dt>
<dd>The current year is retrieved from the system.
</dd>
<dt><b>*NONE</b></dt>
<dd>No first copyright year is specified. The value is stored as 4 blanks.
</dd>
<dt><b><i>first-copyright-year</i></b></dt>
<dd>Specify the four-digit year of the first copyright.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.CPYRGTCUR"></a>
<h3>Copyright current year (CPYRGTCUR)</h3>
<p>Specifies the current copyright year for the product.
</p>
<p>
<b>Note: </b>If neither CPYRGTCUR(*NONE) nor CPYRGTFST(*NONE) is specified, CPYRGTCUR must be greater than or equal to CPYRGTFST. When both copyright years are specified, the CPYRGTCUR must be greater than or equal to the CPYRGTFST.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>The current year is retrieved from the system.
</dd>
<dt><b>*NONE</b></dt>
<dd>No current copyright year is specified.
</dd>
<dt><b><i>current-copyright-year</i></b></dt>
<dd>Specify the copyright year as a four-digit number, such as 1991.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.ALWMLTRLS"></a>
<h3>Allow multiple releases (ALWMLTRLS)</h3>
<p>Specifies whether more than one release of the product can exist on the system at the same time.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>Only one release of the product is allowed on a system at a time.
</dd>
<dt><b>*YES</b></dt>
<dd>The product can be installed more than once if the release levels are distinct.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.PRDIDSFX"></a>
<h3>Product ID suffix (PRDIDSFX)</h3>
<p>Specifies the suffix to be used with the product ID when PRDID(*SER) is specified. Valid characters are uppercase letters A through Z and numbers 0 through 9.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.RLSDATE"></a>
<h3>Release date (RLSDATE)</h3>
<p>Specifies the release date of the product.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No release date is associated with the product.
</dd>
<dt><b><i>release-date</i></b></dt>
<dd>Specify the release date in the format determined by the job description.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies text that briefly describes the object. More information on this parameter is in "Commonly used parameters" section in the CL topic in the iSeries Information Center (http://www.ibm.com/eserver/iseries/infocenter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*BLANK</u></b></dt>
<dd>Text is not specified.
</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="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTPRDDFN.AUT"></a>
<h3>Authority (AUT)</h3>
<p>Specifies the authority given to users who do not have specific authority to the product definition, who are not on the authorization list, and whose user group has no specific authority to the product definition.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*LIBCRTAUT</u></b></dt>
<dd>The public authority for the product definition is taken from the CRTAUT value of the target library (the library that is to contain the product definition). This value is determined when the product definition is created. If the CRTAUT value for the library changes after the product definition is created, the new value does not effect any existing objects.
</dd>
<dt><b>*USE</b></dt>
<dd>You can perform basic operations on the product load, such as running a program or reading a file. You cannot change the product load. *USE authority provides operational authority and read authority to the object, and *EXCLUDE authority to the library.
</dd>
<dt><b>*ALL</b></dt>
<dd>The user can perform all operations except those limited to the owner or controlled by authorization list management authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user cannot transfer ownership of the product definition.
</dd>
<dt><b>*CHANGE</b></dt>
<dd>The user can perform all operations on the object except those limited to the owner or controlled by object existence authority and object management authority. The user can run and debug the program, but cannot change it. Change authority provides object operational authority and all data authority.
</dd>
<dt><b>*EXCLUDE</b></dt>
<dd>The user cannot access the product definition.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTPRDDFN.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CRTPRDDFN PRDDFN(TESTLIB/TEST01) PRDID(9XYZ123) RLS(V5R2M0)
RGSID(*PHONE 1234567) MSGF(TSTMSGF)
PRDOPT((*BASE MSG0001 *NODYNNAM 2924 *CODEDFT)
CPYRGTFST(2001) CPYRGTCUR(2002) ALWMLTRLS(*NO)
RLSDATE(*NONE) TEXT('product TEST01')
AUT(*LIBCRTAUT)
</pre>
</p>
<p>This command creates product definition TEST01 in library TESTLIB. The product ID is 9XYZ123, the release level of the product is V5R2M0, and the registration telephone number is 1234567. The message file TSTMSGF in library TESTLIB will contain the messages to describe the product. The base option is used with a language load ID 2924. The remaining parameters are included to further define the object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTPRDDFN.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF9899</b></dt>
<dd>Error occurred during processing of command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTPRDDFN.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>