friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/strarcbrm.htm

332 lines
11 KiB
HTML
Raw Blame History

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Start Archive using BRM (STRARCBRM)</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="STRARCBRM.Top_Of_Page"></a>
<h2>Start Archive using BRM (STRARCBRM)</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="#STRARCBRM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#STRARCBRM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#STRARCBRM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="STRARCBRM"></a>
<p>The Start Archive using BRM (STRARCBRM) command selects a control group and begins the archive process. You can start the archive immediately or you can schedule it using the system job scheduler. Processing can be batch or interactive.
</p>
<p>
<b>Note: </b>The default value for the <b>Option (OPTION)</b> parameter is *REPORT, which produces a report of archive candidates. To perform an archive you must change the OPTION parameter to *ARCHIVE.
</p>
<p>To use this command, you must have the Backup Recovery and Media Services for iSeries, 5722-BR1, licensed program installed.
</p>
<p><b>Restrictions: </b>
</p>
<ul>
<li>The BRMS Advanced feature (Option 2) is required to use this command.
</li>
<li>The special values *LOAD and *EXIT are ignored when you choose the *REPORT option.
</li>
<li>This command should not be used by control group *EXIT item processing as results will be unpredictable.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRARCBRM.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="#STRARCBRM.CTLGRP"><b>CTLGRP</b></a></td>
<td valign="top">Control group</td>
<td valign="top"><i>Name</i>, *ARCGRP</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#STRARCBRM.OPTION"><b>OPTION</b></a></td>
<td valign="top">Run option</td>
<td valign="top"><b><u>*REPORT</u></b>, *ARCHIVE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRARCBRM.SCDTIME"><b>SCDTIME</b></a></td>
<td valign="top">Schedule time</td>
<td valign="top"><i>Decimal number</i>, <b><u>*IMMED</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRARCBRM.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="#STRARCBRM.JOBD"><b>JOBD</b></a></td>
<td valign="top">Job description</td>
<td valign="top">Single values: <b><u>*USRPRF</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: Job description</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="#STRARCBRM.JOBQ"><b>JOBQ</b></a></td>
<td valign="top">Job queue</td>
<td valign="top">Single values: <b><u>*JOBD</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: Job queue</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></table>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="STRARCBRM.CTLGRP"></a>
<h3>Control group (CTLGRP)</h3>
<p>Specifies the name of the control group that you want to schedule for archive.
</p>
<p>Archive control groups are groups of lists and special values that share common archive characteristics. You can create multiple archive control groups to complete your archive strategy.
</p>
<p>This is a required field.
</p>
<dl>
<dt><b>*ARCGRP</b></dt>
<dd>The default archive control group is processed. The default archive control group is set up in the BRMS archive policy.
</dd>
<dt><b><i>control-group-name</i></b></dt>
<dd>Specify the name of the archive control group, such as QUARTERLY, that you want to process.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRARCBRM.OPTION"></a>
<h3>Run option (OPTION)</h3>
<p>Specifies whether you want to produce a report of candidates for archive or process an archive.
</p>
<p>
<b>Note: </b>You should always run a report of candidates for archive (*REPORT option) prior to processing the actual archive. The special values *LOAD and *EXIT are not processed when using the *REPORT option.
</p>
<dl>
<dt><b><u>*REPORT</u></b></dt>
<dd>You want to produce the archive candidate reports. There are three archive candidate reports. The reports and the printer file to which they are written are:
<ul>
<li>Archive DLO Candidate report - QP1A8ARF
</li>
<li>Archive Object Candidate report - QP1AARC
</li>
<li>Archive Spooled File Candidate report - QP1AOQ
</li>
</ul>
</dd>
<dt><b>*ARCHIVE</b></dt>
<dd>You want to process an archive. There are three archive reports. The reports and the printer file to which they are written are:
<ul>
<li>DLO Archive report - QP1A8ARF
</li>
<li>Object Archive report - QP1AARC
</li>
<li>Spooled File Archive report - QP1AOQ
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRARCBRM.SCDTIME"></a>
<h3>Schedule time (SCDTIME)</h3>
<p>Specifies the time that you want BRMS to begin processing the archive.
</p>
<dl>
<dt><b><u>*IMMED</u></b></dt>
<dd>Archives are to begin immediately.
</dd>
<dt><b><i>schedule-time</i></b></dt>
<dd>Specify the time in hour and minutes that you want the archive to begin. The time is expressed in 24 hour clock format 'hhmm'.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRARCBRM.SBMJOB"></a>
<h3>Submit to batch (SBMJOB)</h3>
<p>Specifies how you want to process the selected control group.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Submits the processing of the control group to batch. The job is dependent on the job queue and job description specified as subsequent parameters.
</dd>
<dt><b>*NO</b></dt>
<dd>Performs the processing of the control group within the current job.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRARCBRM.JOBD"></a>
<h3>Job description (JOBD)</h3>
<p>Specifies the job description used with this job.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*USRPRF</u></b></dt>
<dd>The job description in the user profile under which the submitted job runs is used as the job description of the submitted job.
</dd>
</dl>
<p><b>Qualifier 1: Job description </b>
</p>
<dl>
<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>The library list is used to locate the job description.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the job description. 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 is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRARCBRM.JOBQ"></a>
<h3>Job queue (JOBQ)</h3>
<p>Specifies the job queue in which this job is placed.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*JOBD</u></b></dt>
<dd>The submitted job is placed on the job queue named in the specified job description.
</dd>
</dl>
<p><b>Qualifier 1: Job queue </b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the job queue on which the submitted job is placed.
</dd>
</dl>
<p><b>Qualifier 2: Library </b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the job queue.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the job queue. 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 queue is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRARCBRM.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Producing a Report of Archive Candidates</b>
</p>
<p>
<pre>
STRARCBRM CTLGRP(ARCH01) SCHTIME(1230)
</pre>
</p>
<p>This command will start processing for archive control group ARCH01 at 12:30 p.m.. A report of all archive candidates is produced.
</p>
<p><b>Example 2: Processing an Archive</b>
</p>
<p>
<pre>
STRARCBRM CTLGRP(ARCH01) OPTION(*ARCHIVE) SCHTIME(1230)
</pre>
</p>
<p>This command will start archiving, using archive control group ARCH01, at 12:30 p.m..
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRARCBRM.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>BRM1034</b></dt>
<dd>Control group &amp;1 type &amp;2 canceled.
</dd>
<dt><b>BRM1391</b></dt>
<dd>Control group &amp;2 type &amp;3 canceled.
</dd>
<dt><b>BRM1393</b></dt>
<dd>Control group &amp;2 type &amp;3 canceled.
</dd>
<dt><b>BRM1917</b></dt>
<dd>Feature not installed.
</dd>
<dt><b>BRM1921</b></dt>
<dd>Feature not licensed.
</dd>
<dt><b>BRM40A2</b></dt>
<dd>BRMS product initialization required.
</dd>
<dt><b>CPF3700</b></dt>
<dd>All CPF37xx messages could be signaled. xx is from 01 to FF.
</dd>
<dt><b>CPF3800</b></dt>
<dd>All CPF38xx messages could be signaled. xx is from 01 to FF.
</dd>
<dt><b>CPF9800</b></dt>
<dd>All CPF98xx messages could be signaled. xx is from 01 to FF.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRARCBRM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink