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

475 lines
19 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>Start DPR Capture (STRDPRCAP)</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="STRDPRCAP.Top_Of_Page"></a>
<h2>Start DPR Capture (STRDPRCAP)</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="#STRDPRCAP.PARAMETERS.TABLE">Parameters</a><br>
<a href="#STRDPRCAP.COMMAND.EXAMPLES">Examples</a><br>
<a href="#STRDPRCAP.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="STRDPRCAP"></a>
<p>The Start DPR Capture (STRDPRCAP) command starts the process that captures changes to iSeries data source tables.
</p>
<p>The files that you want to capture changes for must first be registered.
</p>
<p>You register files using the Replication Center or Add DPR Registration (ADDDPRREG) command. The files that you register for change capture are defined in the "CAPCTLLIB"/IBMSNAP_REGISTER table.
</p>
<p>When you have registered the source tables to use remote journaling, you must run the STRDPRCAP command on the same system where you registered the source tables.
</p>
<p>The values for the retention limit and the lag limit in the Tuning Parameter table IBMSNAP_CAPPARMS affect the operation of the STRDPRCAP command. You can alter these settings using the Change DPR Capture Attributes (CHGDPRCAPA) command. These values take affect when the Capture component is started. While capture is in active state you can change the capture tuning values dynamically using the Override DPR Capture Attributes OVRDPRCAPA command.
</p>
<ul>
<li>Note: Do not precede an entry with an asterisk unless that entry is shown on the display itself or in the help information with an asterisk.
</li>
</ul>
<h3>Error Messages for STRDPRCAP</h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>ASN2002</b></dt>
<dd>Capture Parameters table not found.
</dd>
<dt><b>ASN2003</b></dt>
<dd>No tables have been registered.
</dd>
<dt><b>ASN2560</b></dt>
<dd>Capture instance is already active.
</dd>
<dt><b>ASN2561</b></dt>
<dd>Capture instance is starting.
</dd>
<dt><b>ASN2019</b></dt>
<dd>Not authorized to Capture Parameters table IBMSNAP_CAPPARMS.
</dd>
<dt><b>ASN2501</b></dt>
<dd>Not authorized to register table.
</dd>
<dt><b>ASN2513</b></dt>
<dd>STRDPRCAP command failed.
</dd>
<dt><b>ASN4501</b></dt>
<dd>Register table not found or failed to open.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRDPRCAP.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="#STRDPRCAP.RESTART"><b>RESTART</b></a></td>
<td valign="top">Restart after end</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRDPRCAP.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, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job description</td>
<td valign="top"><i>Name</i>, <b><u>QZSNDPR</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b></td>
</tr><tr>
<td valign="top"><a href="#STRDPRCAP.WAIT"><b>WAIT</b></a></td>
<td valign="top">Wait</td>
<td valign="top">60-6000, <b><u>120</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRDPRCAP.CLNUPITV"><b>CLNUPITV</b></a></td>
<td valign="top">Clean up interval</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top">Element 1: Wait time</td>
<td valign="top">
1-100, <b><u>*DFT</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Start clean up</td>
<td valign="top">
<b><u>*IMMED</u></b>, *DELAYED, *NO</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.CAPCTLLIB"><b>CAPCTLLIB</b></a></td>
<td valign="top">Capture control library</td>
<td valign="top"><i>Name</i>, <b><u>ASN</u></b></td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRDPRCAP.JRN"><b>JRN</b></a></td>
<td valign="top">Journal</td>
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 50 repetitions): <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Journal</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="#STRDPRCAP.TRCLMT"><b>TRCLMT</b></a></td>
<td valign="top">Trace limit</td>
<td valign="top">1-35000000, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.MONLMT"><b>MONLMT</b></a></td>
<td valign="top">Monitor limit</td>
<td valign="top">1-35000000, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.MONITV"><b>MONITV</b></a></td>
<td valign="top">Monitor interval</td>
<td valign="top">60-6000, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.MEMLMT"><b>MEMLMT</b></a></td>
<td valign="top">Memory limit</td>
<td valign="top">1-35656, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.RETAIN"><b>RETAIN</b></a></td>
<td valign="top">Retention period</td>
<td valign="top">1-35000000, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.LAG"><b>LAG</b></a></td>
<td valign="top">Lag limit</td>
<td valign="top">1-35000000, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRDPRCAP.FRCFRQ"><b>FRCFRQ</b></a></td>
<td valign="top">Force frequency</td>
<td valign="top">30-600, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="STRDPRCAP.RESTART"></a>
<h3>Restart after end (RESTART)</h3>
<p>Specifies how to start the Capture process.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>The Capture process continues processing the changes from the point that it finished when previously ended. Also known as a <u> warm start</u> , this is the default mode of operation.
</dd>
<dt><b>*NO</b></dt>
<dd>The Capture process removes all information from the Change Data tables before it processes the changes. If you specify *ALL on the JRN parameter, Capture also removes all information from the "CAPCTLLIB"/IBMSNAP_UOW table. The subscriptions for all of the affected base tables are full-refreshed before change capture resumes. This is also known as a <u> cold start</u> .
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.JOBD"></a>
<h3>Job description (JOBD)</h3>
<p>Specifies the name of the job description to use when submitting the Capture process.
</p>
<dl>
<dt><b><u>*LIBL/QZSNDPR</u></b></dt>
<dd>Specifies the default job description provided with the DataPropagator product for iSeries.
</dd>
<dt><b><i>job-description-name</i></b></dt>
<dd>Specifies the name (library-name/job-description-name) of the job description used for the Capture process.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.WAIT"></a>
<h3>Wait (WAIT)</h3>
<p>Specify the maximum number of seconds to wait before the Capture process checks its status. You can use this value to tune the performance of the Capture process. A low value reduces the time the Capture process takes before ending or initializing, but can have an effect on system performance. A higher value increases the time the Capture process takes before ending or initializing, but can improve system performance. A value that is too high can result in decreased performance while the Capture process is performing periodic processing. The amount of the decrease in performance depends on the amount of change activity to registered files and the amount of other work occurring on the system.
</p>
<dl>
<dt><b><u>120</u></b></dt>
<dd>The default maximum number of seconds the Capture process waits.
</dd>
<dt><b>60-6000</b></dt>
<dd>Specify the maximum number of seconds you want the Capture process to wait.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.CLNUPITV"></a>
<h3>Clean up interval (CLNUPITV)</h3>
<p>Specify the maximum number of hours the Capture process waits before pruning old records from the Change Data tables and other control tables.
</p>
<p>This parameter works in conjunction with the RETAIN parameter (in the case of CDs, the UOW, the SIGNAL table and the AUTHTKN table), the TRCLMT parameter(in the case of the CAPTRACE table) and the MONLMT parameter (in case of the CAPMON table). Whereas this parameter determines how frequent to prune and the three other parameters determine whether an old row is eligible for pruning.
</p>
<p>STRDPRCAP command uses the values RETENTION_LIMIT,TRACE_LIMIT, MONITOR_LIMIT and PRUNE_INTERVAL stored in the CAPPARMS table if the user chooses the default for RETAIN, TRCLMT, MONLMT and CLNUPITV parameters,respectively. A user can supply a new value for these limits on the STRDPRCAP command. Or the user can alter their values at a later time using the OVRDPRCAPA command while capture is running.
</p>
<p>At the time interval you specify on this parameter, the Capture process uses information from the Pruning Set table to determine which records in the Change Data tables are eligible for pruning.
</p>
<p>This is a two-part value. The first part specifies the number of hours the Capture process waits before pruning records.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Specifies that the default value is used for the CLNUPITV parameter. The default value is the value of the PRUNE_INTERVAL column of the Capture tuning parameters table ("CAPCTLLIB/IBMSNAP_CAPPARMS). You can change this value by changing the CLNUPITV parameter on the Change DPR Capture Attributes (CHGDPRCAPA) command.
</dd>
<dt><b>24</b></dt>
<dd>The default maximum number of hours the Capture process waits.
</dd>
<dt><b>1-100</b></dt>
<dd>Specify the maximum number of hours you want the Capture process to wait.
</dd>
</dl>
<p>The second part specifies whether or not you want to prune records, or whether you want the Capture process to prune records immediately before capturing any changes.
</p>
<dl>
<dt><b><u>*IMMED</u></b></dt>
<dd>The Capture process prunes old records from the Change Data tables before beginning to capture changes for the selected files.
</dd>
<dt><b>*DELAYED</b></dt>
<dd>The Capture process waits the specified number of hours before pruning old records from the Change Data tables.
</dd>
<dt><b>*NO</b></dt>
<dd>The Capture process does not prune records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.CAPCTLLIB"></a>
<h3>Capture control library (CAPCTLLIB)</h3>
<p>Specifies the name of the Capture control library to use when submitting the Capture process. The Capture Control Library contains the control tables where the source tables are registered.
</p>
<dl>
<dt><b><u>ASN</u></b></dt>
<dd>Specifies the default capture control library provided with the DataPropagator product for iSeries.
</dd>
<dt><b><i>capture-control-library-name</i></b></dt>
<dd>Specifies the name of the capture control library used for the Capture process.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.JRN"></a>
<h3>Journal (JRN)</h3>
<p>Specify a list of up to 50 journals that you want the Capture process to work with. Capture will start processing all of the registered tables that are currently journaled to the specified journal or journals.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Capture will start working with all of the journals that have any registered tables journaled to them.
</dd>
<dt><b><i>library-name/journal-name</i></b></dt>
<dd>Specify the qualified name of the journal that you want the Capture process to work with.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.TRCLMT"></a>
<h3>Trace limit (TRCLMT)</h3>
<p>Specifies the trace limit. During pruning, trace table IBMSNAP_CAPTRACE entries older than the trace limit will be pruned.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>trace-limit</i></b></dt>
<dd>Number of minutes of trace data to be kept in the capture trace table after pruning.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.MONLMT"></a>
<h3>Monitor limit (MONLMT)</h3>
<p>Specifies the capture monitor limit. During pruning, monitor table IBMSNAP_CAPMON entries older than the monitor limit will be pruned.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>monitor-limit</i></b></dt>
<dd>Number of minutes of monitor data to be kept in the monitor table after pruning.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.MONITV"></a>
<h3>Monitor interval (MONITV)</h3>
<p>Specifies the monitor interval. Monitor rows will be written every n seconds as indicated by this value.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>monitor-interval</i></b></dt>
<dd>Specifies how often Capture will write out a monitor row. This is expressed in seconds. Any value less than 120 seconds will default to 120 seconds.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.MEMLMT"></a>
<h3>Memory limit (MEMLMT)</h3>
<p>Specifies the memory limit. Memory in megabytes that each Capture journal job is allowed to use. After this allocation is used up, Capture will use temporary files to store any processing data.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>memory-limit</i></b></dt>
<dd>Specifies how much memory each Capture journal job can use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.RETAIN"></a>
<h3>Retention period (RETAIN)</h3>
<p>Specifies the retention limit, which is the number of minutes that data is retained in the CD tables and the UOW table before it is removed.
</p>
<p>The value of this parameter works with the CLNUPITV parameter. When the CLNUPITV value is reached, data in the CD and UOW tables is removed if the UOW table row shows that the transaction is older than the value of this parameter.
</p>
<p>Ensure that the Apply intervals are set to copy changed information before the value on the RETAIN parameter is reached. This prevents your tables from becoming inconsistent. If they become inconsistent, the Apply program performs full refreshes.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>retention-limit (in minutes)</i></b></dt>
<dd>Specifies the number of minutes that the CD is retained.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.LAG"></a>
<h3>Lag limit (LAG)</h3>
<p>Specifies the lag limit, which is the number of minutes that the Capture program can fall behind before clearing out the CD tables and starting over with change capture. When the lag limit is reached (that is, when the timestamp of the journal entry is older than the current time minus the lag limit), the Capture program assumes that it is too far behind to catch up. It then initiates a cold start for the tables that it is processing for that journal. The Apply program then performs a full refresh to provide the Capture program with a new starting point. Users typically set this value high so that it has no effect.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Uses the value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>lag-limit (in minutes)</i></b></dt>
<dd>Specifies the number of minutes that the Capture processing of CD entries is allowed to fall behind.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRDPRCAP.FRCFRQ"></a>
<h3>Force frequency (FRCFRQ)</h3>
<p>Specifies approximately how often the Capture program writes changes to the CD and UOW tables.
</p>
<p>The Capture program makes the changes available to the Apply program either when the buffers are filled or when this time has expired, whichever occurs first.
</p>
<p>Use this parameter to make source table changes more readily available for the Apply program on servers with a low rate of source table changes.
</p>
<p>This is a global value, and is used for all defined source tables. Setting this value at a lower number can affect processor usage.
</p>
<dl>
<dt><b><u>*DFT (default)</u></b></dt>
<dd>Uses the COMMIT_INTERVAL value from IBMSNAP_CAPPARMS.
</dd>
<dt><b><i>force-frequency (in seconds)</i></b></dt>
<dd>Specifies the number of seconds that the Capture program keeps CD table and UOW table changes in buffer space before making them available for use by the Apply program. This value can range from 30 to 600 seconds.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRDPRCAP.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRDPRCAP.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>ASN2002</b></dt>
<dd>Capture Parameters table not found.
</dd>
<dt><b>ASN2003</b></dt>
<dd>No tables have been registered.
</dd>
<dt><b>ASN2560</b></dt>
<dd>Capture instance is already active.
</dd>
<dt><b>ASN2561</b></dt>
<dd>Capture instance is starting.
</dd>
<dt><b>ASN2019</b></dt>
<dd>Not authorized to Capture Parameters table IBMSNAP_CAPPARMS.
</dd>
<dt><b>ASN2501</b></dt>
<dd>Not authorized to register table.
</dd>
<dt><b>ASN2513</b></dt>
<dd>STRDPRCAP command failed.
</dd>
<dt><b>ASN4501</b></dt>
<dd>Register table not found or failed to open.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRDPRCAP.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>