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

464 lines
16 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 Graphics Data File (CRTGDF)</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="CRTGDF.Top_Of_Page"></a>
<h2>Create Graphics Data File (CRTGDF)</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="#CRTGDF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CRTGDF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CRTGDF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CRTGDF"></a>
<p>The Create Graphics Data File (CRTGDF) command creates a graphics data file (GDF) from a chart format and a data file defined by the Business Graphics Utility (BGU).
</p>
<h3>Error messages for CRTGDF</h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>BGU0670</b></dt>
<dd>BGU is already active.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTGDF.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="#CRTGDF.FILE"><b>FILE</b></a></td>
<td valign="top">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: 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="#CRTGDF.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.MBROPT"><b>MBROPT</b></a></td>
<td valign="top">Member option</td>
<td valign="top"><b><u>*NOREPLACE</u></b>, *REPLACE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.AUT"><b>AUT</b></a></td>
<td valign="top">Authority</td>
<td valign="top"><i>Name</i>, <b><u>*LIBCRTAUT</u></b>, *CHANGE, *ALL, *EXCLUDE, *USE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text</td>
<td valign="top"><i>Character value</i>, <b><u>*CHTHDG</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CRTGDF.CHTFMT"><b>CHTFMT</b></a></td>
<td valign="top">Chart format</td>
<td valign="top">Single values: <b><u>*DFT</u></b>, *GDF<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Chart format</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="#CRTGDF.CHTDTAFILE"><b>CHTDTAFILE</b></a></td>
<td valign="top">Chart data file</td>
<td valign="top">Single values: <b><u>*DFT</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Chart data 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="#CRTGDF.CHTDTAMBR"><b>CHTDTAMBR</b></a></td>
<td valign="top">Chart data member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.RCDFMT"><b>RCDFMT</b></a></td>
<td valign="top">Record format</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.DTAFMT"><b>DTAFMT</b></a></td>
<td valign="top">Data format</td>
<td valign="top"><b><u>*FILEDFT</u></b>, *NONPAIR, *PAIR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.FROMRCD"><b>FROMRCD</b></a></td>
<td valign="top">Starting record number</td>
<td valign="top">1-2147483647, <b><u>*FIRST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.NBRRCDS"><b>NBRRCDS</b></a></td>
<td valign="top">Number of records</td>
<td valign="top">1-999, <b><u>100</u></b>, *END</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTGDF.CHTHDG"><b>CHTHDG</b></a></td>
<td valign="top">Chart heading</td>
<td valign="top"><i>Character value</i>, <b><u>*CHTFMT</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CRTGDF.FILE"></a>
<h3>File (FILE)</h3>
<p>Specifies the data file and the library to be used to store the GDF. If the graphics data file does not exist, BGU creates it. If the graphics data file exists, BGU proceeds to process the MBR parameter.
</p>
<dl>
<dt><b>file-name</b></dt>
<dd>The qualified name of an existing GDF.
</dd>
</dl>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the GDF.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job locates the GDF. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b>library-name</b></dt>
<dd>Specify the name of the library where the GDF is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the database file member in which the GDF is to be stored. If the database file member already exists, you must specify *REPLACE in the MBROPT parameter to have the member replaced. If the member does not exist, it will be created.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the database file specified in the FILE parameter is used.
</dd>
<dt><b>member name</b></dt>
<dd>Specify the name of the file member in the GDF file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.MBROPT"></a>
<h3>Member option (MBROPT)</h3>
<p>Specifies to replace the database file member if the member specified in the MBR parameter already exists.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NOREPLACE</u></b></dt>
<dd>Specifies that the database file member is not replaced. This is the default option. If you select it, BGU issues an error message stating that the member already exists.
</dd>
<dt><b>*REPLACE</b></dt>
<dd>Specifies that the existing database file member is replaced.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.AUT"></a>
<h3>Authority (AUT)</h3>
<p>Specifies the authority to the graphics data file.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*LIBCRTAUT</u></b></dt>
<dd>Specifies the use of the create authority previously defined for the target library. If the CRTAUT value for the library changes after the file is created, the new value will not affect access to this, or other existing files.
</dd>
<dt><b>*CHANGE</b></dt>
<dd>Specifies that the public has all data rights and object management rights.
</dd>
<dt><b>*ALL</b></dt>
<dd>Specifies that the public has all data and object rights.
</dd>
<dt><b>*EXCLUDE</b></dt>
<dd>Specifies that the public has no data or object rights.
</dd>
<dt><b>*USE</b></dt>
<dd>Specifies that the public has read data rights and management rights.
</dd>
<dt><b>authorization-list-name</b></dt>
<dd>Specifies that the object has the same rights as specified in the authorization list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.TEXT"></a>
<h3>Text (TEXT)</h3>
<p>Describes the contents of the GDF member. The text string can be up to and including 50 characters.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*CHTHDG</u></b></dt>
<dd>The default uses the string &amp;sdq.GDF - &amp;sdq. as the prefix for the chart heading of the GDF. It is then truncated at 50 characters to form the member text.
</dd>
<dt><b>text</b></dt>
<dd>A text string of up to 50 characters for the member text is used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.CHTFMT"></a>
<h3>Chart format (CHTFMT)</h3>
<p>Specifies the chart format that will be used to create the GDF. The GDF is created by using the chart format and the data in the file and member specified by the CHTDTAFILE and CHTDTAMBR parameters.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The default chart format of BGU is used to create the GDF.
</dd>
<dt><b>*GDF</b></dt>
<dd>Specifies the use of the GDF member name and library name to form the name of an existing chart format.
</dd>
<dt><b>format-name</b></dt>
<dd>Specify the qualified name of an existing chart format to be used to chart the data.
</dd>
</dl>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the chart format.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the chart format. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b>library-name</b></dt>
<dd>Specify the name of the library where the chart format is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.CHTDTAFILE"></a>
<h3>Chart data file (CHTDTAFILE)</h3>
<p>Specifies the database file (physical or logical) that contains the data that will be used to create the GDF. The GDF is created by using the chart data and the chart format specified in the CHTFMT parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The default data values created by BGU and the specified chart format are used to create the GDF.
</dd>
<dt><b>file-name</b></dt>
<dd>Specify the qualified name of an existing database file containing the data to be charted.
</dd>
</dl>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the file.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the file. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b>library-name</b></dt>
<dd>Specify the name of the library where the file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.CHTDTAMBR"></a>
<h3>Chart data member (CHTDTAMBR)</h3>
<p>Specifies the database file member that contains the data that will be used to create the GDF. The GDF is created by using the chart data and the chart format specified in the CHTFMT parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the database file specified in the FILE parameter is used.
</dd>
<dt><b>member-name</b></dt>
<dd>Specify the name of the file member to be used to chart the data.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.RCDFMT"></a>
<h3>Record format (RCDFMT)</h3>
<p>Specifies the record format to be used to describe the physical database file named in the CHTDTAFILE parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first record format containing any numeric fields in the file is used.
</dd>
<dt><b>record-format-name</b></dt>
<dd>Specify the name of the record format to be used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.DTAFMT"></a>
<h3>Data format (DTAFMT)</h3>
<p>Specifies how the data fields from the files specified in the CHTDTAFILE parameter are selected for creating the GDF.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FILEDFT</u></b></dt>
<dd>The data fields are selected in the manner specified in the data file.
</dd>
<dt><b>*NONPAIR</b></dt>
<dd>The data fields are selected in a nonpaired manner. The first numeric field represents the X value (the independent variable) and all remaining numeric fields represent the Y values dependent on it.
</dd>
<dt><b>*PAIR</b></dt>
<dd>The data fields are selected in a paired manner. For example, the first numeric field represents the independent variable X1, and the second numeric field represents the variable Y1 dependent on X1. The third numeric field represents the independent variable X2, and the fourth numeric field represents the variable Y2 dependent on X2 and so on.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.FROMRCD"></a>
<h3>Starting record number (FROMRCD)</h3>
<p>Specifies the record number in the file member where data charting begins. The total number of records is specified by the NBRRCDS parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>Charting begins with the first record in the specified file member.
</dd>
<dt><b>record-number</b></dt>
<dd>Specify the number of the record in the database file member from which charting begins.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.NBRRCDS"></a>
<h3>Number of records (NBRRCDS)</h3>
<p>Specifies the number of records that are used as data for the chart to be stored as a GDF. The number of records to be used begins at the record specified by the FROMRCD parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>100</u></b></dt>
<dd>100 records are used to create your chart.
</dd>
<dt><b>*END</b></dt>
<dd>The records charted end at the last record of the file.
</dd>
<dt><b>number-of-records</b></dt>
<dd>Specify the number of records used as data for the chart. Valid values are from 1 to 999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTGDF.CHTHDG"></a>
<h3>Chart heading (CHTHDG)</h3>
<p>Specifies a chart heading to override the existing chart heading in the chart you are using to create the GDF. The text string can contain up to 132 characters.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*CHTFMT</u></b></dt>
<dd>The heading defined in the chart format specified.
</dd>
<dt><b>chart-heading-text</b></dt>
<dd>Specify a character string of up to 132 characters to override the existing chart heading. A semicolon (;) in the text string indicates to BGU to start a new line in the heading.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTGDF.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTGDF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>BGU0670</b></dt>
<dd>BGU is already active.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTGDF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>