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

344 lines
12 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>Work with Admin for OnDemand (WRKADMRDAR)</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="WRKADMRDAR.Top_Of_Page"></a>
<h2>Work with Admin for OnDemand (WRKADMRDAR)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Interactive environments (*INTERACT *IPGM *IREXX *EXEC)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#WRKADMRDAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKADMRDAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKADMRDAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKADMRDAR"></a>
<p>The Work with Admin for OnDemand (WRKADMRDAR) Command allows you to administer the OnDemand product. You can work with reports, report extensions, report groups, policies, overlays, and object control table entries.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKADMRDAR.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="#WRKADMRDAR.TYPE"><b>TYPE</b></a></td>
<td valign="top">Administrator function</td>
<td valign="top">*REPORT, *RPTEXT, *RPTGRP, *RPTOVL, *RPTCOL, *OBJCOL, *OCT, *RPTPCY, *OBJPCY</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.REPORT"><b>REPORT</b></a></td>
<td valign="top">Report name</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.RPTEXT"><b>RPTEXT</b></a></td>
<td valign="top">Report extension name</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.RPTGRP"><b>RPTGRP</b></a></td>
<td valign="top">Report group</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.RPTCOL"><b>RPTCOL</b></a></td>
<td valign="top">Report policy</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.RPTOVL"><b>RPTOVL</b></a></td>
<td valign="top">Report overlay</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.OBJCOL"><b>OBJCOL</b></a></td>
<td valign="top">Object policy</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKADMRDAR.OCTLIB"><b>OCTLIB</b></a></td>
<td valign="top">OCT library</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKADMRDAR.TYPE"></a>
<h3>Type (TYPE)</h3>
<p>Specifies the type of administration to be performed.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*REPORT</b></dt>
<dd>This option allows you to work with report definitions. Using this option, you may create, delete, display, update, and copy a report definition.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Spooled File Archive is installed.
</p>
</dd>
<dt><b>*RPTEXT</b></dt>
<dd>This option allows you to work with report definition extensions. Using this option, you may create, delete, display, update, and copy a report definition extension.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Spooled File Archive is installed.
</p>
</dd>
<dt><b>*RPTGRP</b></dt>
<dd>This option allows you to work with report groups. Using this option, you may create, delete, display, update, and copy a report group.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Spooled File Archive is installed.
</p>
</dd>
<dt><b>*RPTOVL</b></dt>
<dd>This option allows you to work with a report overlay. Using this option, you may create, delete, display, and update the overlay lines for a report.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Spooled File Archive is installed.
</p>
</dd>
<dt><b>*RPTCOL</b></dt>
<dd>This option allows you to work with report policy entries. Using this option, you may create, delete, display, and update the Report Policy entries.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Spooled File Archive is installed.
</p>
</dd>
<dt><b>*OBJCOL</b></dt>
<dd>This option allows you to work with object policy entries. Using this option, you may create, delete, display, and update the Object Policy entries.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Object Archive is installed.
</p>
</dd>
<dt><b>*OCT</b></dt>
<dd>This option allows you to work with entries that are in the Object Control Table (OCT). Using this option, you may add, delete, display, and change the OCT entries.
<p>
<b>Note: </b>This value can only be specified if the Content Manager OnDemand Object Archive is installed.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.REPORT"></a>
<h3>Report name (REPORT)</h3>
<p>Specifies the name of the report definition that you want to work with.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All of the report definitions are shown.
</dd>
<dt><b><i>generic*-report-name</i></b></dt>
<dd>Specify the generic name of the report definitions to work with.
</dd>
<dt><b><i>report-name</i></b></dt>
<dd>Specify the name of a report definition to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.RPTEXT"></a>
<h3>Report extension name (RPTEXT)</h3>
<p>Specifies the name of the report definition extension that you want to work with.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All of the report definition extensions are shown.
</dd>
<dt><b><i>generic*-report-extension-name</i></b></dt>
<dd>Specify the generic name of the report definition extensions to work with.
</dd>
<dt><b><i>report-extension-name</i></b></dt>
<dd>Specify the name of a report definition extension to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.RPTGRP"></a>
<h3>Report group (RPTGRP)</h3>
<p>Specifies the name of the report group that you want to work with.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All report groups are shown.
</dd>
<dt><b><i>generic*-group-name</i></b></dt>
<dd>Specify the generic name for the report groups that you want to work with.
</dd>
<dt><b><i>group-name</i></b></dt>
<dd>Specify the name of a report group to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.RPTCOL"></a>
<h3>Report policy (RPTCOL)</h3>
<p>Specifies the name of the Report Policy for which entries are shown on the Work with Report Policies display.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All report policies are shown.
</dd>
<dt><b><i>generic*-policy-name</i></b></dt>
<dd>Specify the generic name of the report policies to work with.
</dd>
<dt><b><i>policy-name</i></b></dt>
<dd>Specify the name of a report policy to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.RPTOVL"></a>
<h3>Report overlay (RPTOVL)</h3>
<p>Specifies which report overlays are shown on the Work with Report Overlays display.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All report overlays are shown.
</dd>
<dt><b><i>generic*-overlay-name</i></b></dt>
<dd>Specify the generic name of the report overlays to work with.
</dd>
<dt><b><i>overlay-name</i></b></dt>
<dd>Specify the name of a report overlay to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.OBJCOL"></a>
<h3>Object policy (OBJCOL)</h3>
<p>Specifies the name of the object policy for which entries are shown on the Work with Object Policies display.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All object policies are shown.
</dd>
<dt><b><i>generic*-policy-name</i></b></dt>
<dd>Specify the generic name of the object policies to work with.
</dd>
<dt><b><i>policy-name</i></b></dt>
<dd>Specify the name of an object policy to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKADMRDAR.OCTLIB"></a>
<h3>OCT library (OCTLIB)</h3>
<p>Specifies the name of the library for which Object Control Table (OCT) entries are shown on the Work with Object Control Table display.
</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>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All OCT entries are shown.
</dd>
<dt><b><i>generic*-OCT-name</i></b></dt>
<dd>Specify the generic name of the OCT libraries to work with.
</dd>
<dt><b><i>OCT-name</i></b></dt>
<dd>Specify the name of an OCT library to work with. displayed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKADMRDAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
WRKADMRDAR TYPE(*REPORT)
</pre>
</p>
<p>This command example initiates the OnDemand Spool File Archive administrative functions for all report definitions (*REPORT). Other administrative functions that can be specified include report extensions (*RPTEXT), report groups (*RPTGRP), report overlays (*RPTOVL), report migration policies (*RPTPCY), and object migration policies (*OBJPCY).
</p>
<p><b>Example 2: More Complex Example</b>
</p>
<p>
<pre>
WRKADMRDAR TYPE(*REPORT) REPORT(C*)
</pre>
</p>
<p>This command is similar to Example 1 but provides a generic value for the report definition name to subset the list of report definitions with which to work. Each administrative function described in Example 1 allows the entry of a specific name, a generic name, or *ALL.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKADMRDAR.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="#WRKADMRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>