Lotus Notes Database Exit Program


  Required Parameter Group:

1 Change table name Input Char(10)
2 Notes database name Input Char(112)
3 DB2 collection or library name Input Char(10)
4 DB2 table name Input Char(128)


Note: 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.


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.

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.

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.

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.

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.

For more information, see the Globalization topic.


Authorities and Locks

None.


Required Parameter Group

Change table name
INPUT; CHAR(10)

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.

Note: Only changes made by a Notes client will be placed in this table.

Notes database name
INPUT; CHAR(112)

The name of the Notes database in which the changes have occurred.

DB2 collection or library name
INPUT; CHAR(10)

The name of the DB2 collection or library where the change table and base table reside.

DB2 table name
INPUT; CHAR(128)

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.


Format of change table

The following table shows the format of the change table. For a description of the fields in this format, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 CHAR(1) OPERATION
1 1 CHAR(26) TIMESTAMP
27 1B CHAR(256) UPDATEDBY
283 11B CHAR(256) FORM
539 21B BINARY(4) DOCID
...      


Field Descriptions

DOCID. The Notes ID of the document where the operation took place in the Notes database.

FORM. The Notes form name that was used to perform the operation on the Notes database.

OPERATION. The operation flag that indicates whether the imported DB2 UDB for iSeries database data row is inserted, updated, or deleted. Possible values follow:

I Insert
D Delete
U Update

TIMESTAMP. The timestamp in the Notes document of when the operation occurred. The 26-character format is YYYY-MM-DD-HH.MM.SS.ssssss, where:

YYYY Year
MM Month
DD Day
HH Hour
MM Minute
SS Second
ssssss Microsecond

UPDATEDBY. The Notes user who performed the operation on the Notes database.

... 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.



Exit program introduced: V3R7
Top | Client Management Support APIs | APIs by category