315 lines
9.2 KiB
HTML
315 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">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Lotus Notes Database Exit Program</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. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- CS3 SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA at -->
|
|
<!-- RCHVMW2 on 20 Oct 1998 at 18:04:38 -->
|
|
<!--File Edited Oct 2001 by v2cdijab -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
|
|
|
|
<h2>Lotus Notes Database Exit Program</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
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%">Change table name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Notes database name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(112)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">DB2 collection or library name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">DB2 table name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(128)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<br>
|
|
<p><strong>Note:</strong> To use this exit program, you need the IBM OS/400
|
|
Lotus Notes Enhanced Integration feature. This feature is not available on
|
|
releases past V4R3.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<p>The Lotus Notes Database exit program provides the capability for the user
|
|
to process an SQL table of all changes (updates, insertions, and deletions)
|
|
that have occurred in the Notes database that is being shadowed from DB2 UDB
|
|
for iSeries.</p>
|
|
|
|
<p>The Lotus Notes Database exit program refers to the i5/OS program that the
|
|
user specifies from the Notes interface to the Register Notes to DB2 UDB for
|
|
i5/OS Exit Program option.</p>
|
|
|
|
<p>The input parameters are padded with blanks to the maximum length of each
|
|
parameter. They are not null-terminated. Therefore, if you need to compare or
|
|
use the values of these parameters in a C-language program, your exit program
|
|
may need to remove any trailing blanks before use.</p>
|
|
|
|
<p>An SQL table is built in the library of the DB2 collection or library where
|
|
the base table of the import and shadow request resides. This change table
|
|
contains a row for each change that occurred in the Notes database as a result
|
|
of a Notes client operation. The row contains the operation, column values, and
|
|
key values of the operations.</p>
|
|
|
|
<p>The exit program is submitted as a batch job. Any errors that the exit
|
|
program generates are sent to the job log of the batch job.</p>
|
|
|
|
<p>For more information, see the
|
|
<a href="../nls/rbagsglobalmain.htm">Globalization</a> topic.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Change table name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the change table in the base table collection or library (as
|
|
specified on the original shadow request) that contains the summary of changes
|
|
to the Notes database.</p>
|
|
|
|
<p><strong>Note:</strong> Only changes made by a Notes client will be placed in
|
|
this table.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Notes database name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(112)
|
|
|
|
<p>The name of the Notes database in which the changes have occurred.</p>
|
|
</dd>
|
|
|
|
<dt><strong>DB2 collection or library name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the DB2 collection or library where the change table and base
|
|
table reside.</p>
|
|
</dd>
|
|
|
|
<dt><strong>DB2 table name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(128)
|
|
|
|
<p>The name of the DB2 base table that is shadowed to the Notes server. This is
|
|
the name of the table specified on the original import or shadow SQL
|
|
statement.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCHGT">Format of change table</a></h3>
|
|
|
|
<p>The following table shows the format of the change table. For a description
|
|
of the fields in this format, see <a href="#HDRCHGTB">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<table border="1" 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(1)</td>
|
|
<td align="left" valign="top" width="60%">OPERATION</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="left" valign="top">CHAR(26)</td>
|
|
<td align="left" valign="top">TIMESTAMP</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">27</td>
|
|
<td align="center" valign="top">1B</td>
|
|
<td align="left" valign="top">CHAR(256)</td>
|
|
<td align="left" valign="top">UPDATEDBY</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">283</td>
|
|
<td align="center" valign="top">11B</td>
|
|
<td align="left" valign="top">CHAR(256)</td>
|
|
<td align="left" valign="top">FORM</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">539</td>
|
|
<td align="center" valign="top">21B</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">DOCID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">...</td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCHGTB">Field Descriptions</a></h3>
|
|
|
|
<p><strong>DOCID.</strong> The Notes ID of the document where the operation
|
|
took place in the Notes database.</p>
|
|
|
|
<p><strong>FORM.</strong> The Notes form name that was used to perform the
|
|
operation on the Notes database.</p>
|
|
|
|
<p><strong>OPERATION.</strong> The operation flag that indicates whether the
|
|
imported DB2 UDB for iSeries database data row is inserted, updated, or deleted.
|
|
Possible values follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>I</em></td>
|
|
<td align="left" valign="top">Insert</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>D</em></td>
|
|
<td align="left" valign="top">Delete</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>U</em></td>
|
|
<td align="left" valign="top">Update</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>TIMESTAMP.</strong> The timestamp in the Notes document of when the
|
|
operation occurred. The 26-character format is YYYY-MM-DD-HH.MM.SS.ssssss,
|
|
where:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>YYYY</em></td>
|
|
<td align="left" valign="top">Year</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Month</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DD</em></td>
|
|
<td align="left" valign="top">Day</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>HH</em></td>
|
|
<td align="left" valign="top">Hour</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Minute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>SS</em></td>
|
|
<td align="left" valign="top">Second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>ssssss</em></td>
|
|
<td align="left" valign="top">Microsecond</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>UPDATEDBY.</strong> The Notes user who performed the operation on
|
|
the Notes database.</p>
|
|
|
|
<p><strong>...</strong> The values and offsets from here on are run-time
|
|
dependent. The columns included in the change table will be the same as the
|
|
order and attributes of the columns that were selected in the original SQL
|
|
statement that was used for the import and shadow request. If no key columns
|
|
were specified on the original import statement, key columns are placed first
|
|
in the table. In addition, each key column is preceded by a column that
|
|
contains the old key value.</p>
|
|
<br>
|
|
<hr>
|
|
Exit program introduced: V3R7
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#Top_Of_Page">Top</a> |
|
|
<a href="cms.htm">Client Management Support APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|