ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QJORMVRJ.htm

384 lines
9.9 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Remove Remote Journal (QjoRemoveRemoteJournal) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- JC1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten OCT 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Remove Remote Journal (QjoRemoveRemoteJournal) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Qualified journal name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Relational database directory entry</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(18)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Omissible Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="50%">Request variable</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Length of request variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Format name of request variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program: QJOURNAL<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove Remote Journal (QjoRemoveRemoteJournal) API disassociates a
remote journal on the specified target system from the specified journal on the
source system. The journal on the source system may be either a local journal
or another remote journal.</p>
<p>The remote journal, and any associated journal receivers, are not deleted
from the target system by the API processing. No processing is performed on the
target system for the API. The remote journal that remains on the target system
may later be added back to the remote journal definition for the journal on the
source system by using the Add Remote Journal (ADDRMTJRN) command or the Add
Remote Journal (QjoAddRemoteJournal) API.</p>
<p>It is the responsibility of the user to delete the remote journal and any
associated journal receivers from the target system, if so desired.</p>
<p>Once a remote journal has been removed from a journal, all of the journal
receivers that are currently in the journal's receiver directory on the source
system will no longer be protected from deletion even if the journal entries
have not yet been replicated to the remote journal.</p>
<br>
<h3>Restrictions</h3>
<p>The following restrictions apply:</p>
<ul>
<li>The API must be called from the source system for a local or remote
journal.</li>
<li>The remote journal on the specified target system cannot have a journal
state of *ACTIVE.</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Source Journal Authority</em></dt>
<dd>*CHANGE, *OBJMGT</dd>
<dt><em>Source Journal Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Service Program Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Source Journal Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified journal name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the journal on the source system from which the remote journal
is being removed, and the library where it resides. The journal on the source
system may be either a local journal or a remote journal. The first 10
characters contain the journal name, and the second 10 characters contain the
name of the library where the journal is located on the source system.</p>
<p>The special values supported for the library name follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">Library list</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">Current library</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Relational database directory entry</strong></dt>
<dd>INPUT; CHAR(18)
<p>The name of the relational database directory entry that contains the remote
location name of the target system.</p>
</dd>
</dl>
<br>
<h3>Omissible Parameter Group</h3>
<dl>
<dt><strong>Request variable</strong></dt>
<dd>INPUT; CHAR(*)
<p>The request variable structure that describes the input for the Remove
Remote Journal (QjoRemoveRemoteJournal) API.</p>
</dd>
<dt><strong>Length of request variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the request variable, in bytes. The length of the request
variable must be set to 20 bytes.</p>
</dd>
<dt><strong>Format name of request variable</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format RMRJ0100 is the only supported format that is used by this API.
See <a href="#HDRRMRJ100">RMRJ0100 Format</a> for more information on the
RMRJ0100 format.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRMRJ100">RMRJ0100 Format</a></h3>
<p>The following table defines the information that may be provided for format
RMRJ0100 when you remove a remote journal.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Qualified remote journal name</td>
</tr>
</table>
<br>
<h3><a name="HDRRMRJFLD">Field Descriptions</a></h3>
<p><strong>Qualified remote journal name.</strong> The qualified name of the
remote journal on the target system. The first 10 characters contain the remote
journal name, and the second 10 characters contain the name of the library
where the remote journal resides on the target system. If this field is not
provided or is blank, the resolved qualified journal name is assumed.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td valign="top">CPF6981 E</td>
<td valign="top">Remote journal &amp;1 in &amp;2 not removed.</td>
</tr>
<tr>
<td valign="top">CPF6982 E</td>
<td valign="top">Relational database directory entry &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF6992 E</td>
<td valign="top">Remote journal &amp;1 in &amp;2 not removed.</td>
</tr>
<tr>
<td valign="top">CPF8100 E</td>
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to
FF.</td>
</tr>
<tr>
<td valign="top">CPF9801 E</td>
<td valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td valign="top">CPF9802 E</td>
<td valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9803 E</td>
<td valign="top">Cannot allocate object &amp;2 in library &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF9820 E</td>
<td valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF9830 E</td>
<td valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API Introduced: V4R2
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"jc1.htm">Journal and Commit APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>