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

262 lines
9.2 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>Add to CM for OnDemand (ADDVIRDAR)</title>
</head>
<body bgcolor="white">
<a name="ADDVIRDAR.Top_Of_Page"></a>
<h2>Add to CM for OnDemand (ADDVIRDAR)</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="#ADDVIRDAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDVIRDAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDVIRDAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDVIRDAR"></a>
<p>The Add to CM for OnDemand (ADDVIRDAR) command will add existing OnDemand report indexes into Content Manager for iSeries as external data references. The Add to CM for OnDemand (ADDVIRDAR) command adds the indexes to a Content Manager for iSeries interface file (EKD0314).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDVIRDAR.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="#ADDVIRDAR.REPORT"><b>REPORT</b></a></td>
<td valign="top">Report name</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ADDVIRDAR.VERSION"><b>VERSION</b></a></td>
<td valign="top">Version</td>
<td valign="top">1-99, *HIGHEST</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDVIRDAR.RPTDATE"><b>RPTDATE</b></a></td>
<td valign="top">Report date range</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Required, Positional 3</td>
</tr>
<tr>
<td valign="top">Element 1: From date</td>
<td valign="top">
<i>Character value</i>, *AVAIL, *CURRENT</td>
</tr>
<tr>
<td valign="top">Element 2: To date</td>
<td valign="top">
<i>Character value</i>, *CURRENT</td>
</tr>
<tr>
<td valign="top"><a href="#ADDVIRDAR.CALLVI"><b>CALLVI</b></a></td>
<td valign="top">Call CM for iSeries program</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#ADDVIRDAR.SBMJOB"><b>SBMJOB</b></a></td>
<td valign="top">Submit to batch</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDVIRDAR.JOBD"><b>JOBD</b></a></td>
<td valign="top">Job description</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job description</td>
<td valign="top"><i>Name</i>, <b><u>QRDARS400</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr></table>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDVIRDAR.REPORT"></a>
<h3>Report name (REPORT)</h3>
<p>Specify the name of the report(s) that you want to integrate into Content Manager for iSeries.
</p>
<p>This is a required parameter.
</p>
<p>
<b>Note: </b>If you press the F4 key for this parameter while prompting the command, a list of all the valid entries is presented to you.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDVIRDAR.VERSION"></a>
<h3>Version (VERSION)</h3>
<p>Specify the version of the report(s) that should be integrated.
</p>
<dl>
<dt><b>*HIGHEST</b></dt>
<dd>The highest defined version of the report definition is used.
</dd>
<dt><b><i>01-99</i></b></dt>
<dd>Specify the version number of the report to use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDVIRDAR.RPTDATE"></a>
<h3>Report date range (RPTDATE)</h3>
<p>Specifies the earliest and latest dates of the report(s) that should be integrated.
</p>
<p><b>Element 1: From date</b>
</p>
<dl>
<dt><b><i>date</i></b></dt>
<dd>Specify a date using the format YYYYMMDD where YYYY represents the year, MM the month, and DD the day. Do not use any type of special characters to separate year, month, and day values.
</dd>
<dt><b>*AVAIL</b></dt>
<dd>The date of the earliest available report is used.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Today's date is used.
</dd>
</dl>
<p><b>Element 2: To date</b>
</p>
<dl>
<dt><b><i>date</i></b></dt>
<dd>Specify a date using the format YYYYMMDD where YYYY represents the year, MM the month, and DD the day. Do not use any type of special characters to separate year, month, and day values.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Today's date is used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDVIRDAR.CALLVI"></a>
<h3>Call CM for iSeries program (CALLVI)</h3>
<p>Specify if you want to call the QVIXRFINX program to complete the addition process for the report(s) into Content Manager for iSeries.
</p>
<p>The QVIXRFINX program adds all OnDemand report indexes which have been placed in the Content Manager for iSeries interface file into Content Manager for iSeries.
</p>
<p>
<b>Note: </b>For an OnDemand report to be available for retrieval from the Content Manager workstation client, the QVIXRFINX program must be called to add the OnDemand report indexes into Content Manager for iSeries.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>If you specify *YES, the QVIXRFINX program will be called to add the specified report(s) into Content Manager for iSeries.
</dd>
<dt><b>*NO</b></dt>
<dd>If you specify *NO, the OnDemand report(s) specified will only be added to the Content Manager for iSeries interface file. A later call of the QVIXRFINX program is required to complete the addition of all OnDemand report indexes into Content Manager for iSeries.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDVIRDAR.SBMJOB"></a>
<h3>Submit to batch (SBMJOB)</h3>
<p>Specify if you want to integrate the reports interactively or in a batch job.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>This command should be submitted to run in a different job.
</dd>
<dt><b>*NO</b></dt>
<dd>This command should be run within the current job. If you are entering this command from a terminal, this will prevent you from doing any other work from this terminal session until this command completes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDVIRDAR.JOBD"></a>
<h3>Job description (JOBD)</h3>
<p>Specifies the name of the job description used for the submitted job.
</p>
<p><b>Qualifier 1: Job description</b>
</p>
<dl>
<dt><b><u>QRDARS400</u></b></dt>
<dd>The QRDARS400 job description is used as the job description for the submitted job.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the job description used for the job.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</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 used to locate the job description name. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the job description name is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDVIRDAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
ADDVIRDAR REPORT(CHECKSTMTS) VERSION(*HIGHEST)
RPTDATE(20020101 20020101)SBMJOB(*NO)
</pre>
</p>
<p>This command runs interactively to add existing OnDemand Spool File Archive report indexes to Content Manager (previously known as VisualInfo or VI) for the OnDemand report definition named CHECKSTMTS for the particular date specified.
</p>
<p><b>Example 2: More Complex Example</b>
</p>
<p>
<pre>
ADDVIRDAR REPORT(CHECKSTMTS) VERSION(*HIGHEST)
RPTDATE(*AVAIL *CURRENT)
</pre>
</p>
<p>This command submits a job to batch that will add existing OnDemand Spool File Archive report indexes to Content Manager (previously known as VisualInfo or VI) for the OnDemand report definition named CHECKSTMTS. Spooled file index records are added to Content Manager for all available dates.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDVIRDAR.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDVIRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>