TIBCO ActiveMatrix BusinessWorks Plug-in for …...The plug-in supports capturing of change data (insert, update, or delete data) from and merging change data request into a relational

TIBCO ActiveMatrix BusinessWorks™ Plug-infor DatabaseUser's GuideSoftware Release 8.1June 2018

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Business Studio, TIBCOActiveMatrix BusinessWorks Plug-in for Database are either registered trademarks or trademarks ofTIBCO Software Inc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database User's Guide

Copyright © 1999-2018 TIBCO Software Inc. All rights reserved.

3


Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Comparison between Adapter and Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Creating a JDBC Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Creating an ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Debugging and Running a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Deploying Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

User Interface Elements of the ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Creating a Schema Using the ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Adding a Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

Adding a Parent Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

Adding a Child Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Setting Up a Relation Between Parent and Child Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Refresh the Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Specifying the Columns of an Order By Clause for a Child Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Table Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Publishing Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Child Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Using an Exception Table as a Source Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Child Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Opaque Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

ADB Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Data Event Poller Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Data Merger Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Importing a Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Data Event Poller Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Data Event Poller: Parent Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

4


Data Event Poller: DB2UDBParent Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Data Event Poller: MSSQLServerParent Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60


Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Data Event Poller: OracleParent Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63



Data Event Poller: ParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

Data Event Poller: DB2ParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68



Data Event Poller: MSSQLServerParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73



Data Event Poller: OracleParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79



Data Event Poller: PublishByReference Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Data Event Poller: DB2UDBPublishByReference Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84



Data Event Poller: MSSQLPublishByReference Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88



Data Event Poller: OraclePublishByReference Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93



Data Merger Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Data Merger: Parent Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Data Merger: DB2UDBDataMergerParent Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

DataMerger DB2Parent: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

DataMerger DB2Parent: Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Data Merger: MSSQLServerDataMergerParent Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

MSSQLServerParent: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

MSSQLServerParent: Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Data Merger: OracleDataMergerParent Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

5


Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

Data Merger: ParentChild Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Data Merger: DB2UDBDataMergerParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Data Merger: MSSQLServerDataMergerParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

MSSQLServerParentChild: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

MSSQLServerParentChild: Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Data Merger: OracleDataMergerParentChild Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

OracleDataMergerParentChild: Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

OracleDataMerger ParentChild: Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126

Output Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Mapping Adapter Datatype to Plug-in XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Mapping Microsoft SQL Server Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Mapping Oracle Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Mapping DB2 Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Mapping MySQL Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Mapping PostgreSQL Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131

Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Enabling Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132

Disabling Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Unlocking the MUTEX Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Viewing Client Information Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Refactoring a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Error Handling by Data Merger Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134

Normal Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Bulk Insert Error Handling and Applicable Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135

How Records are Handled by the Bulk Insert Error Handling Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135

Upsert Operation on Parent-Child Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Entity Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

6


Figures

ADB Configuration shared resource: Connection Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

ADB Configuration shared resource: Schemas Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

ADB Configuration shared resource: Connection Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

ADB Configuration shared resource: Schemas Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Data Event Poller: Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Data Event Poller Activity: Fault Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Data Merger Activity: Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Data Merger Activity: Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

Data Merger Activity: Fault Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

7


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Documentation for TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database is available on the TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database Product Documentation page.

Product-Specific Documentation

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BusinessWorks Plug-in for Database User's Guide

● TIBCO ActiveMatrix BusinessWorks Plug-in for Database Installation

● TIBCO ActiveMatrix BusinessWorks Plug-in for Database Release Notes

The following documents provide additional information and can be found on the TIBCO ProductDocumentation website:

● TIBCO ActiveMatrix BusinessWorks documentation

● TIBCO Enterprise Administrator documentation

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

8


https://docs.tibco.com

https://docs.tibco.com

https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-database

http://www.tibco.com/services/support

https://support.tibco.com

https://support.tibco.com

https://ideas.tibco.com/

https://community.tibco.com

Product Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database is an add-on product for TIBCOActiveMatrix BusinessWorks™. The plug-in supports capturing of change data (insert, update, or deletedata) from and merging change data request into a relational database. The plug-in supports JDBC-compliant databases such as Oracle, Microsoft SQL Server, MySQL, IBM DB2 for z/OS, iSeries (AS400),and UDB, PostgreSQL, Amazon RDS for MySQL, Oracle, SQL Server, and Microsoft Azure SQL Server.

TIBCO ActiveMatrix BusinessWorks Plug-in for Database will be referred as ADB (Active Database)Plug-in, in the User's Guide.

You can perform the following main tasks by using the Data Event Poller activity:

● Define the schema of a parent table, parent-child table, and a reference table.● Select the storage mode, that is, specify how the publishing table stores the event information.

— Publish by value: All the published column information is stored in the stage table.— Publish by reference: Only the key values of the changed event are stored in the stage table, and

data of other columns is retrieved through the table's join operation.● Publish data of child table. (Publish Child Data option)● Order the data of the child table in ascending or descending order. (Child Table Order By option)● Specify the maximum number of database records to be published per event to start a TIBCO

ActiveMatrix BusinessWorks™ job. (Record per event option)● Specify a Polling Interval and the maximum number of records to be retrieved for each polling

when a polling batch is used. ("Polling Interval" and Polling Batch Size options)● Improve the performance in a high-load scenario by using load balancing. Load balancing

distributes the workload across application nodes.● Insert, delete, and update records in the parent and child tables.● Republish records with status as failed or scheduled (Failed(F) Records and Scheduled(S) Records

options)● Specify schema mapping options for design time and runtime (Design Time and Runtime options)

You can perform the following main tasks by using the Data Merger activity:

● Define the schema of a parent table and a parent-child table.● Specify exception table and opaque exception table.● Specify child exception table mappings.● Specify the precommit stored procedure. (Stored Procedure option)● Specify the date-time patterns. (Date, Time, and Timestamp options)● Specify the Bulk insert size and batch commit size for handling bulk insertion of data. (“Bulk Insert

Size” and “Batch Commit Size” options)● Handling of Bulk Insert Error. (Handle Bulk Insert Error option)● Handle Upsert Operation. (Upsert option)● Handle Empty String and set to default. (Set Empty String to Default(Oracle) option)● Specify schema mapping options for design time and runtime (Design Time and Runtime options)

These features can be implemented using:

● ADB Configuration Shared Resource - The ADB Configuration shared resource uses JDBCConnection shared resource to connect to a database, and create XML schema definition (XSD)

9


schema for plug-in operation. The ADB Configuration shared resource is used by the plug-inactivities.

● Data Event Poller - You can use this activity to poll the change in stage table at a specified interval.

● Data Merger - You can use this activity to perform insert, delete, update, and upsert operations onthe relevant tables in the associated database. The data is then available to other applications thathave access to the database.

10


Comparison between Adapter and Plug-In

This topic is useful for users, who have previously used the TIBCO ActiveMatrix® Adapter forDatabase, to help understand differences in the plug-in where supported features have overlap withadapter.

FeatureTIBCO ActiveMatrix® Adapterfor Database

TIBCO ActiveMatrixBusinessWorksTM Plug-in forDatabase

Services Provided Publication service,Subscription service and RPCservice, as well as AlerterService

The plug-in is a replacement ofthe ADB Adapter and AEPalette available in TIBCOActiveMatrix BusinessWorks™.

Data Event Poller activity isequivalent to the adapter'sPublication service with anAdapter Subscriber activity.

Data Merger activity isequivalent to the adapter'sSubscription service with aTIBCO BusinessWorks™Adapter Publication activity.

Transport Type JMS and Rendezvous The plug-in is native to TIBCOActiveMatrix BusinessWorks™and does not requiremessaging.

Message Format The ADB Adapter is developedusing Adapter SDK librariesand outputs the message usingAE Schema.

The plug-in is native to TIBCOActiveMatrix BusinessWorks™and outputs the message asXML based on a XSD.

Support for Load Balancing Configurable Supported by default but canbe configured by the user.

TRA Properties TRA properties are maintainedin TIBCO Administrator

TRA properties are notapplicable in plug-in.

UseBetweenClause Default is false Default is true

Referencing an external schema Yes Yes

Storage Mode Publish by value/reference Publish by value/reference

Stage Table Yes Yes

11




Triggers Generation Direct apply/SQL statementgenerated

Direct apply/SQL statementgenerated

or

save generated SQL into file

DB reconnection attempts DB JDBC connection recovery/reconnect attempts

Reconnection is tried at everypolling interval.

Polling Batch size Supported Supported

Group messaging Supported Renamed as "record per event"

MS SQL WindowsAuthentication

Yes Yes

Auto Re-Publish(Oracle_failed_rePublish)

Yes Yes

Look back Yes No

Publishing by Reference Object Yes Yes

Polling performanceenhancement hint

Yes No

Database vendors● IBM DB2

● Microsoft SQL Server

● MySQL

● Oracle Database

● PostgreSQL

● Sybase

● Teradata

● IBM DB2

● Microsoft SQL server

● MySQL

● Oracle Database

● PostgreSQL

Database Driver support● Native Database Drivers

supported

● DataDirect Driverssupported

● Native Database drivers arerequired for Amazon RDSfor MySQL and MicrosoftAzure SQL Server.

● DataDirect Driverssupported.

Set Database client information Yes Yes

Publish Batch confirm size/timeout

Yes No

12




Database Connection JDBC-based adapter connection JDBC connection

Database Configuration Adapter Configuration ADB Configuration Sharedresource

Refresh the existing schema Refind Schema option The Refind Schema option isrenamed as Refresh Schema.

Multithreading (multipleprocessing stream)

Message session based Multithreading is providedthrough TIBCO ActiveMatrixBusinessWorks™ engine jobthread, each job thread has aData Merger activity instance.

Separate sessions Message session based Not applicable

UseSerial (Messages processedin order)

Yes Yes with a single TIBCOActiveMatrix BusinessWorks™engine and TIBCOActiveMatrix BusinessWorks™process thread count = 1

Use Exception table (Errorinserted in the exception table)

Yes This is optional for the plugin,as you might choose to correctthe data and reprocess it. Thestatus of the output alwaysshows the status of each recordif it is not a one way process.

Use Child Exception table(Error related to child tabledata inserted in the childexception table)

Yes Yes

User Opaque Exception table(when no exception table orinsertion in the exception tablefails)

Yes Yes

Subscriber Precommit StoredProcedure call

The subscriber can beconfigured to call a storedprocedure after a databaseinsert, update, or deleteoperation and before atransaction commit.

Yes

13




Batch processing The adapter providesprocessing of subscriptionrequests in batches at twooperation levels:

● Insert of the incomingmessages

● Commit of the insert,update, and deleteoperations

To use this feature, you have toconfigure the following fields:

● Bulk Insert Size

● Batch Commit Size

● Batch CommitTimeout(milliseconds)

The plugin supports batchprocessing if number of datarows in the activity input ismore than 1, but does notsupport this globally, that is, noaccumulation of the messagesprocessed by different TIBCOActiveMatrix BusinessWorks™process jobs or TIBCOActiveMatrix BusinessWorks™process nodes are packed asbatches.

For each process, one databaseoperation each, as a singlerecord or batch operation, canbe configured.

Bulk Insert Error Handlingfeature:

Batch commit (size, timeout)(The number of messages to beput in a batch before invoking acommit operation. The defaultvalue is 0.)

Error Handling by subscriptionservice

When Subscription Serviceinserts data into a database andan error occurs, the subscriberendpoint rolls back all previousoperations on the database tothe original status. SubscriptionService handles error data intwo ways: normal errorhandling and bulk insert errorhandling.

The Batch Commit Size field isdisplayed only when the UseSeparate Session check box isselected on the Configurationtab.

If you use the defaultvalue in the BatchCommit Size field,the adapter takes 1 asthe value of the batchcommit size whenrunning SubscriptionService.

No explicit setting is required.Plugin commits all thesuccessful operations, and un-successful processed recordsare sent to be handled by theexception logic. For example,operation results returned asresult of the activities and/orinsertion in the exceptiontables.

For more information aboutBulk insert error handling, see Bulk Insert Error Handling

One way upsert operationrequest

Yes No, as there is no messagingmiddleware involved.

14




JMS Durable Subscriber Name The JMS Subscriber Name cantake the deployment timeglobal variable value.

Not applicable.

Runtime Schema In the case where the schemaname of the table objects isdifferent in the developmentand the productionenvironments.

Yes

Bulk Insert Size Design-time setting Is part of the palette'sconfiguration and relatedTIBCO ActiveMatrixBusinessWorks™ process.

15


Getting Started

A typical workflow for using the plug-in to achieve different goals includes creating a process, testing itin the debugger, and deploying the application.

TIBCO ActiveMatrix BusinessWorks™ uses the Eclipse GUI provided by TIBCO Business Studio™ todefine business processes and generate Enterprise Archives (EAR files). The EAR file is deployed andrun in the TIBCO ActiveMatrix BusinessWorks™ runtime, and also is managed by using TIBCO®

Enterprise Administrator (TEA).

The typical workflow for using the plug-in is:

1. Creating a Project

2. Creating a JDBC Connection Shared Resource

3. Creating an ADB Configuration Shared Resource

4. Configuring a Process

5. Testing a Process

6. Debugging and Running a Process

7. Deploying Applications

Creating a ProjectThe first task of using a plug-in is creating a project. You can add resources and processes after creatinga project. An Eclipse project is an application module configured for TIBCO ActiveMatrixBusinessWorks. An application module is a resource unit that is named, versioned, and packaged as apart of the application.

Procedure

1. Start TIBCO Business Studio by using one of the following ways:

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version number > Studio for Designers.

● Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory

2. From the menu, click File > New > BusinessWorks Resources to open the BusinessWorks Resourcewizard.

3. In the "Select a wizard" dialog box, click BusinessWorks Application Module and click Next toopen the New BusinessWorks Application Module wizard.

There are several ways to open the New BusinessWorks Application Module dialog boxand create a new project in TIBCO Business Studio. See the TIBCO ActiveMatrixBusinessWorks documentation for more information.

4. In the Project dialog box, configure the project you want to create:a) Type a name for the project that you are creating in the Project name field.b) By default, the created project is located in the workspace currently in use. Keep the Use default

location.c) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating a project.d) Click Finish to create the project.

16


Result

The project with the specified settings is displayed in the Project Explorer view.

Creating a JDBC Connection Shared ResourceTo connect to the database, you must use the JDBC Connection shared resource.

1. Expand the created project in the Project Explorer view.

2. Right-click the Resources folder and select New > JDBC Connection.

3. Enter a name in the Resource Name field and click Finish.

4. Configure the JDBC Connection shared resource as described in the following sections.

General

The General section has the following fields.

Field Description

Name The name to be displayed as the label for the shared resource

Description A short description of the shared resource

JDBC Connection

This section has the following fields.

Field

LiteralValue/ModuleProperty? Description

Connection Type None Specifies the kind of JDBC connection you want to create.

17


Field


MaximumConnections

Yes The maximum number of database connections to allocate.The default maximum is 10. The minimum value that can bespecified is 1.

Login Credentials Yes The user name used to connect to the database.

The password used to connect to the database.

JDBC Driver

This section has the following fields.

Field


Database Driver Yes The name of the JDBC driver. If you select a supported driverfrom a list of supported drivers, the Database URL field ispopulated with a template for the URL of the driver.

For example:tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver

Database URL Yes The URL to use to connect to the database. A template of theURL is supplied for the selected JDBC driver. You mustsupply the portions of the URL that are in angle brackets (<>).

For example: jdbc:tibcosoftwareinc:sqlserver://<host>:<port>;DatabaseName=<dbname>

Login Timeout Yes The length of time (in seconds) to wait for a successfuldatabase connection.

Only JDBC drivers that support connection timeouts can usethis field. If the JDBC driver does not support connectiontimeouts, the value of this field is ignored. Most JDBC driverssupport connection timeouts.

Test Connection

Click the Test Connection button to test whether the specified configuration fields result in a validconnection to a database.

Creating an ADB Configuration Shared Resource

Prerequisites

Configure a JDBC Connection shared resource as described in Creating a JDBC Connection SharedResource.

18


Procedure


2. Right-click the Resources folder and select New > ADB Configuration.

3. Type a name in the Resource Name field in the ADB Configuration Editor dialog box. Click Finish.The ADB Configuration shared resource is created. The shared resource consists of two pages:Connection and Schemas.

ADB Configuration shared resource: Connection Page

ADB Configuration shared resource: Schemas Page

4. Configure the ADB Configuration shared resource in the displayed editor, as described in UserInterface Elements of the ADB Configuration Shared Resource.

19


Configuring a ProcessAfter creating a project, an empty process is created. You must configure the process by addingactivities to the empty process to complete a task.

Prerequisites

Ensure that you have created an empty process when creating a project. See Creating a Project for moreinformation.

Procedure

1. In the Project Explorer view, click the created project and open the empty process from theProcesses folder.

2. Select an activity from the Palette view and drop it in the Process editor.For example, select and drop the DataEventPoller activity from the ADB palette. You can add otheractivities similarly.

3. Click an activity in the Process editor and drag the icon to create a transition between theadded activities.

4. Click to create links between two activities and configure the condition types.

5. Configure the DataEventPoller activity as described in Data Event Poller Activity.

6. Configure DataMerger activity as described in Data Merger Activity.

An ADB Configuration shared resource is required when configuring the activities. See Creating an ADB Configuration Shared Resource for more details about how to create theshared resource.

7. Click File > Save to save the project.

20


Testing a ProcessAfter configuring, you might debug or test a process.

Prerequisites

Ensure that you have configured a process, as described in Configuring a Process.

Procedure

1. Open the process you have configured in TIBCO Business Studio.

2. On the toolbar, click Debug > Debug Configurations.3. Click BusinessWorks Application > BWApplication in the left panel.

By default, all the applications in the current workspace are selected in the Applications tab. Ensurethat only the application you want to debug is selected in the Applications tab in the right panel.

4. Click the Advanced tab and click Browse to locate the logback file.By default, the log file resides in the TIBCO_HOME/bw/<version>/config/design/logbackdirectory and error logs are captured. See Managing Logs for more details.

5. Click Debug to test the process in the selected application.TIBCO Business Studio changes to the Debug perspective. The debug information is displayed inthe Console view.

6. In the Debug tab, expand the debugged process and click an activity.

7. In the upper-right panel, click Job Data view, and then click the Output tab to check the activityoutput.

Debugging and Running a ProcessDebug the application you have configured to ensure that the application configuration is correct.

Procedure

1. Open the process that you have configured in TIBCO Business Studio.

2. On the toolbar, click Run > Debug Configurations.3. Click BusinessWorks Application > BWApplication in the left panel.

4. Ensure only the application you want to debug and run is selected in the Applications tab in theright panel.

5. Click the Advanced tab and click Browse to locate the logback file.By default, the log file resides in the TIBCO_HOME/bw/<version>/config/design/logbackdirectory and error logs are captured. See Managing Logs for more details.

6. Click Debug.TIBCO Business Studio changes to the Debug perspective. Logs are displayed in the Console view.

Deploying ApplicationsAfter testing a process, you can deploy the application that contains the configured process into aruntime environment, and then use the bwadmin utility to manage the deployed application.

Prerequisites

Before deploying an application, generate an application archive, which is an enterprise archive (EAR)file created in TIBCO Business Studio. For more information, also see:

21


● Creating a Project.

● Generating an EAR File.

Deploying an application involves:

1. Uploading an EAR file.

2. Deploying an application.

3. Configuring an application.

4. Starting an application.

See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

Generating an EAR FileApplication archives are enterprise archive (EAR) files that are created in TIBCO Business Studio. AnEAR file is required when deploying an application.

Prerequisites

An application project has already been created, as described in Creating a Project.

There are many ways to generate an EAR file, the following is one such method. For more informationon this, see TIBCO ActiveMatrix BusinessWorks Administration for more information.

Procedure

1. Go to the File Explorer view and click the Open Directory to Browse icon.

2. Select the folder where you want to generate the EAR file and click OK.The new folder is displayed in the File Explorer view.

3. Drag the application from the Project Explorer view to the new folder in the File Explorer view.

The EAR file is generated with the name <name>.<application>_<version>.ear.

22


ADB Configuration Shared Resource

You should use the ADB Configuration shared resource to establish a connection from the ActiveMatrixBusinessWorks Plug-in to the database.

The ADB Configuration shared resource utilizes the JDBC connection shared resource to retrieve thedatabase table schema information.

The following topics are covered in this section:

● User Interface Elements of the ADB Configuration Shared Resource

● Creating Schema Using the ADB Configuration Shared Resource

● Table Reference

User Interface Elements of the ADB Configuration Shared ResourceThe user interface elements in the ADB Configuration shared resource are described below.

The shared resource consists of two pages: Connection and Schemas.

Connection Page

ADB Configuration shared resource: Connection Page

The ADB Configuration shared resource utilizes the JDBC connection shared resource to retrieve thedatabase table schema information. The JDBC connection shared resource is configured on theConnection page.

The Connection page consists of two sections: General and Configuration.

Shared Resource > Connection Page > General Fields

FieldModuleProperty? Description

Package No The name of the package where the shared resource is added.

Name No The name to be displayed as the label for the shared resource in theprocess.

23



Description No A short description for the shared resource.

Shared Resource > Connection Page > Configuration Fields


JDBCConnection

No Define the JDBC connection by selecting the JDBC shared resource.Oracle and Microsoft SQL Server are the supported vendors. OnlyTIBCO embedded DataDirect JDBC driver is supported by the plug-in.

DefaultSchema

Yes Specify the default schema name.

If no default schema name is specified, it uses the JDBCconnection user name.

Set ClientInfo(Oracle)

Yes When the value of this property is set to on, the plugin callsSET_CLIENT_INFO to set the database session client information.

The default value is on.

DB2 Type No Select the type of DB2 from the drop down: UDB , AS400, or OS390.

The default value is OS390.

ValidateSchema

No Click this button to validate the JDBC connection and the schemasconfigured under the shared resource. For the schema, the tables,columns, and column types are validated. If a referred table isprovided, the existence of the table is also validated. An errormessage is displayed if the validation fails.

After all the issues are resolved, after clicking Validate Schema, youreceive a "Validation of Schema is successful" message.

24


Schemas Page

ADB Configuration shared resource: Schemas Page

The type of service and the associated tables to generate XSD schema and database triggers are definedon the Schemas page.The Schemas section on the left lists the schema type. You can add or remove schemas. You can addDBPoller and DBMerger schema types. When a new DBPoller or DBMerger schema is added, acorresponding section is created on the right that consists of the following tabs:

● Configuration

● Schema

● Options

● Child Table Order By (only for DBPoller activity)

● Child Table Exception Mappings (only for DBMerger activity)

● DB2 (only when the DB2 connection is used)

The Configuration tab contains the following fields:

25


Shared Resource > Schemas Page > Configuration Tab


Name No You can update the schema name.

See Entity Naming Conventions.

Description No A short description for the schema.

The Schema tab contains the following UI options:

Shared Resource > Schemas Page > Schema Tab

Icon/Option Description

Add a parent table from the connected Database (through JDBC connection).

Add a child table to a parent table.

Refresh the existing schema or change the columns used.

Allow KeyColumns Only

If this check box is selected, the Join To relation between the parent and childtable is applied only on the columns having a User Key. If the check box is notselected, the Join To relation can be applied on any fields.

Tables andColumns

Displays the selected table and its columns.

26



Join To Set a relation between the parent table and child table.

For setting a relation between the parent table and child table, you must eitherclear the Allow Key Columns Only or at least one column must be enabled asUser Key from the parent.

User Key Select the check box beside the column name to specify that the column mustcontain a unique sets of values. If the user key is defined in a child table and theparent table has a primary key, it has no impact on the generated triggers andthe user key is used for mapping the parent-child relationship.

If the parent table does not have a primary key (rare cases), no update or deletetriggers are generated. To use a user key as the implicit primary key in thetrigger, you must modify and apply the trigger manually.

Update Trigger Fires a trigger when an UPDATE statement changes a value in a column.

Only the following databases are supported in the Update Trigger option:

● Oracle

● SQL Server

● DB2 UDB/AS400/OS390

Update trigger is applicable only for a parent table.

XSD Type Displays the XSD type of the column. This is a read-only column.

DB Type Displays the data type of the database column. This is a read-only column.

The Options tab contains the following fields for the Data Event Poller activity:

27


Shared Resource > Schemas Page > Options Tab for Data Event Poller activity


Storage Mode No Select how the stage table keeps the event information. You caneither Publish by Value or Publish by Reference. If you selectPublish by Reference as the storage mode when you select thereference object, you can see all the column details such as Column,XSD Type, and DB Type.

● Publish by Value: The storage table keeps all the publishedcolumn information in the stage table.

● Publish by Reference: Only the key value(s) of the changed eventare kept in the storage table, and data of other columns isretrieved through the table's join operation.

If you specify a table or view as a referred object, thereferred object must contain columns with the samenames and data types as the primary key columns inthe source table.

The primary key values in the source table must be thesame as the primary key values in the referred object.

PublishingTable

No Displays the stage table name. This name can be modified.

You can use only alphanumeric characters and anunderscore in the table name. No other special charactersare allowed in the table name.

See Publishing Table for more information on the columns in thepublishing table.

ReferredObject

No You can add a reference object from the same schema or a differentschema. This option is enabled only when the Storage Mode isPublish by Reference.

You can also download a table or a view as a referred object.

If this field is empty, the plug-in reads data from the source table.

If you specify a table or view as a referred object, thereferred object must contain columns with the samenames and data types as the primary key columns in thesource table. The primary key values in the source tablemust be the same as the primary key values or the subsetof primary key values in the referred object.

For more information about how to add a reference object, see Creating a Schema Using the ADB Configuration Shared Resource.

Publish ChildData

No Select the check box if you want to publish the parent table and thechild table data.

The default is true.

28



ReferredObject

No Displays the name of the table that is selected as the referred object.

Select No Click this button to select a table as a referred object.

Refresh No When the schema is altered, you can click this button to refresh theschema displayed in the Referred Object Table.

No Click this button to clear the selected referred object.

Referred Object Table

Columns No Displays the columns in the referred object.

XSD Type No Displays the XSD type of the column.

DB Type No Displays the data type of the database column.

The Options tab contains the following fields for the Data Merger activity:

29


Shared Resource > Schemas Page > Options Tab for Data Merger activity


ExceptionTable Name

No Name of the exception table to which data is written if the plugincannot write the data to the data merger destination table. This tableholds messages that caused an exception. If the table does not exist,data merger creates one by itself. For more information aboutexception table, see Exception Table.

The exception table cannot contain any user-created columns wherethe column name starts with ADB_. These characters are reservedfor use by the plugin.

For the parent-child relationship, this is the parentexception table. If you do not set the parent exceptiontable, the child exception table is invalid.

OpaqueExceptionTable Name

No Specifies the name for the opaque exception table. For moreinformation about opaque exception table, see Opaque ExceptionTable.

You can use the Child Table Order By tab to specify the columns of an Order By clause used for eachchild table query. The plug-in returns the child table result set in a particular sequence.

The Child Table Order By tab contains the following fields:

Shared Resource > Schemas Page > Child Table Order By Tab


Child TableName

When a child table is added to a parent table, the child table is automaticallyadded to the Child Table Order By tab. The name of table is displayed here.

30



Select Columns The Order By Clause column cannot be edited; you can add the fields of thetable by selecting them using the Select Columns button. The wizard thatopens, contains a list of all the fields of the child table. You can select thecolumns based on which you want to order the table.

● Check to Use DESC - Identifies the columns based on which you want toorder the table. The default order is the ascending order. To order in thedescending order, you can select the check box beside the column in theCheck to Use DESC panel.

● - Moves the selected column to the Check to Use DESC list.

● - Moves the selected column from the Check to Use DESC list to theleft.

● - Moves the selected column to one level above in the Check to UseDESC list.

● - Moves the selected column to one level below in the Check to UseDESC list.

You can use the Child Exception Table Mappings tab to create child exception table.

The Child Exception Table Mappings tab contains the following fields:

Shared Resource > Schemas Page > Child Exception Table Mappings Tab


DBMerger ChildTable Name

Displays the list of child table names.

Child ExceptionTable Name

Displays the list of child exception table names corresponding to each childtable in the DBMerger Child Table Name column.

The DB2 tab contains the following fields for the Data Even Poller activity:

31


Shared Resource > Schemas Page > DB2 Tab for Data Event Poller activity


OS390 Options

Database Name Name of the database that you want to put your publishing table in.

Table SpaceName

Name of the table space where the publishing table is located.

Storage Group Optional.

The designator of the storage group that holds the publishing table indexes.

Buffer Pool Optional.

Name of the buffer pool to be used for indexes.

Index Suffix A suffix of your choice, up to 13 characters, that the plug-in appends to each ofthe indexes (IDX_1 and IDX_2).

Trigger Suffix A suffix of your choice, up to 5 characters, that the plug-in appends to each ofthe triggers (T1, T2, and T3).

AS400 Options

Trigger Option The new data from the source table is copied to the publishing table by settingthe trigger options. Currently, the SQL option is available.

SQL: The SQL trigger can be insert, update, or a delete trigger. When copyingfrom the source table to the publishing table, the prompt is not returned untilall data is written.

The DB2 tab contains the following fields for the Data Merger activity:

32


Shared Resource > Schemas Page > DB2 Tab for Data Merger activity


OS390 Options

Database Name Name of the database that you want to put your publishing table in.

Table Space Name Name of the table space where the publishing table is located.

LOB Table SpaceName

The name of the Large Objects (LOB) table space name where auxiliary tableof the opaque exception table is located.

Creating a Schema Using the ADB Configuration Shared ResourceThe following topics are applicable to the DataEventPoller activity and the DataMerger activity.

Adding a Shared Resource

Procedure


2. Right-click the Resources folder and select New > ADB Configuration. Specify the Resource Folder,Package, and Resource Name. Click Finish.

3. On the Connection page, select the JDBC connection in the JDBC Connection field.

4. On the Schemas page, select DBPoller or DBMerger as required, and then click Add. As soon as anew DBPoller or DBMerger schema is added, a corresponding section is created on the right.

33


Adding a Parent Table

If you perform a delete operation on a Parent table, the DataEventPoller activity does not publish anychild data.

To add a parent table from the connected Database (through JDBC connection):

Procedure

1. Click the icon. The Select Table wizard is displayed.

2. Enter a pattern name to search the table.You can also use the % character to search for table names.

3. To fetch data from the default schema, click Fetch beside the Default Schema field. To fetch datafrom any other schema, click Fetch beside the Other Schema.

● For a parent table, only tables are fetched.

● In the same ADB Configuration shared resource, after a table is downloaded, it is notdisplayed in the list when you do the next fetch.

All the tables available in the specified schemas are displayed.

34


4. Click Finish.The table is displayed in the Schema tab on the right.

35


Adding a Child Table

Procedure

1. Select the parent table and click .

A wizard similar to the one for adding a parent table is displayed.

2. Fetch the table and click Finish.

● For a child table, both tables and views are fetched.

● In the same ADB Configuration shared resource, once a table or view is downloaded, itis not displayed in the list when you do the next fetch.

The child table is added under the parent table and displayed in the Schema tab on the right.

Setting Up a Relation Between Parent and Child TablesYou can set up a relation between the parent and child table using Join To. For applying a Join Torelation between a parent and child table, you need to set at least one field as the User Key in the childtable or uncheck the Allow Key Columns check box.

Procedure

1. If you want to apply the Join To relation only on fields having a user key, select the Allow KeyColumns Only checkbox. If you clear the Allow Key Columns Only check box, the Join To relationis applied on any fields from the parent table.

36


2. Select the Update Trigger check box to ensure that the selected column is updated by the databaseapplication.

You can edit the information for Join To, User Key, and Update Trigger columns of the child tablein a dialog box by double clicking the table name.

37


Refresh the Schema

Refresh the existing schema or change the columns used by using the icon.

Specifying the Columns of an Order By Clause for a Child TableWhen a child table is added to a parent table, it is displayed in the Child Table Order By tab. You canspecify the columns of an Order By clause used for each child table query. The plug-in returns the childtable result set in a particular sequence.

Procedure

1. Click Select Columns in the Child Table Order By tab.The Select Child Table Order By Columns wizard appears.

38


2. Select the fields depending on the order you want and move them to the right panel using .

Similarly, you can use to move them back to the left panel. You can also reorder the sequenceusing the Up and the Down buttons.

3. If you want to get the values of a field in a descending order, select the check box beside theappropriate field in the right panel, that is, the Check to Use DESC panel. The default order is theascending order.

4. Click Finish.

Table ReferenceWhen TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database publishes data to or retrieves datafrom a source or target schema, the plug-in has to deal with several tables.

The tables are listed below:

● Publishing Table● Child Table● Exception Table● Child Exception Table● Opaque Exception Table

Publishing TablePublishing tables mirror tables that you have identified for monitoring. They contain additionalcolumns, primarily a sequence number and delivery status, which are required by the plug-in to detect

39


new rows. You can create a publishing table for each table you want to activate in TIBCO BusinessStudio.

In addition to a copy of the source table columns, the publishing table has the following additionalcolumns.

Column Name Type Description

ADB_SEQUENCE INTEGER Stores the monotonically increasingsequence number that represents newrows in the publishing table. If a columnwith this name exists, the number isgenerated automatically.

By default, the schema type is string. Theplug-in treats this number as a string. Thisnumber can be larger than an integer if thedatabase supports it.

ADB_TIMESTAMP DATE Time of row insertion in publishing tablethat is used to calculate expiration of rows.The timestamp is generated automatically.

ADB_OPCODE INTEGER Operation code used by the plug-in:

● 1 indicates INSERT

● 2 indicates UPDATE

● 3 indicates DELETE

For more information about the upsertoperation, see Upsert Operation on Parent-Child Tables.

ADB_REF_OBJECT VARCHAR2(64) When publishing by reference object isused, contains the name of the referenceobject that provides source data.

ADB_L_DELIVERY_STATUS

ADB_L_DELIVERY (for DB2)

CHAR Delivery status of Records:

● N indicates that a new Record hasarrived, but has not yet been published.

● S indicates that one node has got thisrecord, and is not taken again whenpolling other records.

● C indicates complete.

● F indicates failed.

Also see Child Table.

Child TableTo support incremental parent-child operations, each child row has an opcode, that is, an extraADB_OPCODE field that is added to the child schema. The plug-in determines if the operation is anincremental parent-child operation by checking the first level child opcode. If the first level child

40


opcode is not set, the plug-in treats it as a complete operation. For the subsequent child level, if thechild opcode is not set, it inherits the parent opcode.

When working with a parent-child table, the value of ADB_OPCODE in the parent table and the childtable must be the same. Or set the value of ADB_OPCODE only in the parent table and leave the childtable empty.

Also see Publishing Table.

Exception TableIf a database restriction is applied or a failure occurs, an exception table can be configured to receive amessage.

In addition to destination table columns, the following columns are added to the exception table:


ADB_OPCODE INTEGER Operation code used by the plug-in:

● 1 indicates INSERT

● 2 indicates UPDATE

● 3 indicates DELETE

● 4 indicates UPDATE if row exists,otherwise, INSERT

If an incoming job does not have anoperation code, an INSERT operationoccurs. For more information about theupsert operation, see Upsert Operation onParent-Child Tables.

ADB_TRACKING_ID VARCHAR2(40) Tracking ID of the job.

This column is the primary key. Eachexception table that is mapped to a childtable is connected to the parent exceptiontable by this column.

ADB_JOIN_ID VARCHAR2(46) Joined column used to link a parent recordto its child record.

ADB_JOIN_ID is generated fromADB_TRACKING_ID and concatenatedwith the record number in the group.

The exception table of a child table isconnected to the exception table of a parenttable by the ADB_JOIN_ID column.

ADB_ERROR_TEXT VARCHAR(4000) Text of the error from the database serveror other source that caused the error.

ADB_ERROR_TIME TIMESTAMP Timestamp of the inserted record.

For Oracle databases, the timestampincludes the time zone information.

41


Using an Exception Table as a Source Table

If you want to publish data from an exception table and use that exception table as the source table, donot use the ADB_ERROR_TEXT or ADB_OPCODE column names. Instead, follow these guidelines:

● Create a database view that mirrors the exception table, rename the ADB_ERROR_TEXT andADB_OPCODE columns so that they do not begin with "ADB_."

● After renaming the columns, use Publish By Reference Object and choose your view as the referenceobject.

Child Exception TableA child exception table contains both child table columns and additional columns.

The additional columns are listed in the following table:


ADB_TRACKING_ID VARCHAR2(40) Tracking ID of the message.

ADB_JOIN_ID VARCHAR2(46) Joined column used to link a parent recordto its child record.

ADB_JOIN_ID is generated fromADB_TRACKING_ID and concatenatedwith the record number in the group.

ADB_ERROR_TEXT VARCHAR(4000) Text of the error from the database serveror other source that caused the error.

Opaque Exception TableThe Data Merger activity uses two logical layers when processing a message. The first layer decodesdata from the message, and the second layer provides the database transaction. If an exception occursin the first layer, the plugin logs the message in the opaque exception table. In the second layer, if anyDML command fails at any level, the plugin rolls back this transaction and starts another transaction,inserting the error messages in exception tables. If inserting error messages in the exception table fails,the plugin logs the message in the opaque exception table.

The opaque exception table records the entire message in a column with the error message. The opaqueexception table has the following columns:


ADB_TRACKING_ID VARCHAR2(40) Tracking ID of the message.

ADB_SUBTAB VARCHAR2(1000) Destination table name.

ADB_ERROR_TEXT VARCHAR(4000) Text of the error from the database server,plugin SDK, or other source that causedthe error.

ADB_ERROR_TIME TIMESTAMP Timestamp of the inserted record.

For Oracle records, the timestamp includesthe time zone information.

42



ADB_MSG BLOB Raw bytes of the message.

The default column size is 1 M.

43


ADB Palette

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database achieves its functionality with the help ofData Event Poller activity and Data Merger activity.

The Data Event Poller Activity and Data Merger Activity use the ADB Configuration shared resourcecreated earlier.

● In Data Event Poller activity, the user key is used to define a relationship between the parent andchild tables.

● In the Data Merger activity, the user key is used in the "where" clause of a query during an updateoperation or a delete operation.

● Projects from earlier versions of the TIBCO ActiveMatrix BusinessWorks™ Plug-in for Databaseneed to be refactored. For more information about refactoring, see Refactoring a Project.

Data Event Poller ActivityThe Data Event Poller activity polls the change in a stage table in a specified time interval. Theconfiguration allows you to generate the required trigger SQL script file to create stage table andtriggers.

General

The General tab contains the following fields:

Field

Literal Value/ProcessProperty/ModuleProperty? Description

Name No The name to be displayed as the label for the activity in theprocess.


ConfigurationResource

Yes Shared configuration resource containing information aboutthe ADB Configuration connection.

44


Field


Schema No The database poller schema which is configured with theschema table. The schema is based on the XSD generated bythe database poller schema.

● Apply Trigger: Applies the trigger script to the database.

● Generate Trigger: Saves the trigger script to a specific fileand can be applied to the database later. You areprompted to select the directory where the trigger filesare to be created. Two files are generated at the specifiedlocation:

— A SQL file containing the script for triggering to thedatabase

— A cleanup SQL file which contains a script to cleanupcreated publishing table, triggers, sequences, and soon.

The filenames are created based on the name of theschema.

You cannot apply or generate the trigger if you areoffline; you must be connected to the database tofetch table metadata.

Description

Provide a short description for the activity.

Advanced

This tab has the following fields:

Data Event Poller: Advanced Tab

45


Field


Sequence Key No This field can contain an XPath expression that specifieswhich processes should run in order. Process instanceswith sequencing keys that evaluate to the same value areexecuted sequentially in the order the process instancewas created.

Custom Job ID No This field can contain an XPath expression that specifiesa custom ID for the process instance.

Operation Options:

Record Per Event Yes Specifies the maximum number of database records tobe retrieved per event to start a TIBCO ActiveMatrixBusinessWorks™ job. The default value is 1.

PollingInterval(ms)

Yes Specifies the amount of time in seconds for polling. Thedefault value is 5000.

Batch Size(MaxRows)

Yes Maximum number of records to be retrieved for eachpolling, when polling batch is used. The default value is10.

ReadCommit(DB2)

Yes Enables the plug-in publisher to perform a commitoperation after selecting a query for DB2.

This check box is enabled only when you use DB2database vendors, including DB2 OS390, DB2 AS400,and DB2 UDB.

Load Balancing Options:

Enable LoadBalancing

Yes Load balancing distributes the workload across TIBCOActiveMatrix BusinessWorks™ Application nodes toimprove the performance in a high-load scenario.TIBCO ActiveMatrix BusinessWorks™ Applicationnodes with the same mutex name specified are in thesame load balance group.

Load balancing is enabled by default.

If you enable Load Balancing, the order ofdata processing is not sequential.

Mutex Name Yes Name of the Mutex table. This name can be changed.

The default name is the first 20 characters of thepublishing table name suffixed with "_MUTEX".

Republish Data Options

46


Field


Failed(F) Records Yes If this check box is selected, records that have a failedstatus are republished when the application is started.

Scheduled(S)Records

Yes If this check box is selected, records that have ascheduled status are republished when the applicationis started.

Schema Mapping Options

Design Time Yes Specifies the design-time database object's schema. Itcan be a list of comma-separated schemas.

Runtime Yes Specifies the runtime table object's schema. It can be acomma-separated list of schemas.

Output

This tab displays the output schema.

For more information on how different data types are mapped to the XSD type, refer to OutputMapping.

47


Fault

Data Event Poller Activity: Fault Tab

The Fault tab lists exceptions that are thrown by this activity:

Error Schema Element Data Type Description

ADBSQLException String It has a msg and msgCode field for the exception.

ADBValidationExeption String It has a msg and msgCode field for the exception.

msg String The error message returned by the plug-in.

msgCode String The error code returned by the plug-in.

Data Merger ActivityThe Data Merger activity performs the insert, update, and delete operations on the parent-child table.The configuration allows you to generate the required exception table SQL script file to create exceptiontables in the database. If an exception occurs while performing a database operation, the record isinserted in the created exception or opaque table.

When you migrate a project created in an earlier version to 8.1.0 version, you must have to refactor it tobe able to see the schema for Data Merger activity. To refactor your project, in TIBCO Business Studio,in the Project Explorer pane, right click the project name, select Refactor > Repair BusinessWorksProjects.

General

The General tab contains the following fields:

48


Field


Name No The name to be displayed as the label for the activity in theprocess.


ConfigurationResource

Yes Shared configuration resource containing information aboutthe ADB Configuration connection.

Schema No The Data Merger schema which is configured with theschema table. The schema is based on the XSD generated bythe Data Merger schema.

● Create Exception Table: Applies the exception table scriptto the database.

● Script Exception Table: Saves the exception table script toa specific file and can be applied to the database later. Youare prompted to select the directory where the triggerfiles are to be created. Two files are generated at thespecified location:

— An SQL file containing the script for triggering to thedatabase

— A cleanup SQL file which contains a script to cleanupthe exception tables that are created.

The filenames are created based on the name of theschema.

You cannot apply or generate the exception tablesif you are offline; you must be connected to thedatabase to fetch the table metadata.

Description

Provide a short description for the activity.

49


Advanced

Data Merger Activity: Advanced Tab

This tab has the following fields:

Field


Operation Options

Timeout(sec) Yes Activity timeout in seconds.

Default value is 180 seconds.

Upsert Yes Updates a row in the destination table if the row exists. Ifno such row exists, it performs an insert. For moreinformation about the upsert operation behavior, see Upsert Operations on Parent-Child Tables.

Set Empty String toDefault(Oracle)

Yes Either on or off. The default setting is off. It works only ifthe following three criteria are met:

● Oracle database is used

● Insert operation is being performed

● JDBC Property CatalogOptions property is set to 1

When you set a default value to a field in creating table, ifthe property value is set to on, the empty strings arechanged to the default value.

Pre Commit Options

50


Field


Stored Procedure Yes The value entered here represents the name of a storedprocedure the merger calls after the database insert,update, or delete operation and before the commit.

Date And Time Pattern Options

Date Yes Enter the date in the yyyy-MM-dd format.

Time Yes Enter the time in the HH:mm:ss format.

Timestamp Yes Enter the timestamp in the yyyy-MM-dd HH:mm:ss.Sformat, where S is milliseconds.

Batch And Bulk Insert Options

Bulk Insert Size Yes All incoming messages to be inserted are stored until thissize is reached. Then, a bulk insert operation is performedon the destination table.

The default value is 1.

Batch Commit Size Yes This property specifies the number of records to bebatched before invoking a commit operation.

The default value is 1. You can set this property if youwant to enable batch commit.

Handle Bulk InsertError

Yes This property indicates whether the bulk insert errorhandling feature in the Data Merger activity is enabled ornot.

Its default value is off.

Schema Mapping Options

Design Time Yes Specifies the design time database object schema. It can bea list of comma-separated schemas.

Runtime Yes Specifies the runtime database object schema. It can be alist of comma-separated schemas.

Input

This tab displays the input schema. You must map the input for the parent-child tables.

51


Output

This tab displays the output schema. If the table does not have a primary key, all columns of the tableare displayed. However, if the table has a primary key, then only the primary key column is displayed.The ADB_STATUS field displays the status of whether a record is processed or not. This field can havetwo values - Success and Fail.

The ADB_ERROR_TEXT field displays the details of the error. This error might be caused when anyrecord fails due to an SQL exception and the ADB_STATUS field has value Fail.

Data Merger Activity: Output Tab

For more information about how different data types are mapped to the XSD type, refer to OutputMapping.

Fault

A fault is generated in the following scenarios:

● When the XSD validation fails or the JDBC connection fails, the ADBValidationException occurs.

● The ADBSQLException occurs and any one of the following scenarios is true:

— The database connection is lost.

— The exception and opaque table names are not specified.

— The exception and opaque tables are not created in the database.

52


— The "insert into exception table" fails and the opaque table is not specified or not created.

Data Merger Activity: Fault Tab

The Fault tab lists exceptions that are thrown by this activity.

Error Schema Element Data Type Description

ADBSQLException String It has a msg and msgCode field for the exception.

ADBValidationExeption String It has a msg and msgCode field for the exception.

msg String The error message returned by the plug-in.

msgCode String The error code returned by the plug-in.

53


Working with Sample Projects

To help you understand how TIBCO ActiveMatrix BusinessWorks Plug-in for Database operates, somesample projects are packaged with the installer.

After the plug-in is installed, the sample projects are available in the TIBCO_HOME\bw\palettes\adb\version_number\samples directory. You must import the sample projects to TIBCO Business Studio.To see more about importing projects, see Importing a Sample Project.

● Sample projects for the Data Event Poller Activity

— Parent

— DB2UDBParent

— MSSQLServerParent

— OracleParent

— ParentChild

— DB2UDBParentChild

— MSSQLServerParentChild

— OracleParentChild

— PublishByReference

— DB2UDBPublishByReference

— MSSQLPublishByReference

— OraclePublishByReference

● Sample Projects for the Data Merger Activity

— Parent

— DB2UDBDataMergerParent

— MSSQLServerDataMergerParent

— OracleDataMergerParent

— ParentChild

— DB2UDBDataMergerParentChild

— MSSQLServerDataMergerParentChild

— OracleDataMergerParentChild

Importing a Sample ProjectTo run a sample project, you must import the project to TIBCO Business Studio.

Procedure

1. Start TIBCO Business Studio.

2. Click File > Import.

3. In the Import window, expand the General folder, select the Existing Studio Projects intoWorkspace item, and click Next.

54


4. To locate the sample, on the Import Projects dialog box, click Browse next to the Select archive filefield to navigate to the sample.The sample projects are located in the TIBCO_HOME\bw\palettes\adb\version_number\samplesdirectory.

5. In the samples directory, select a sample (for example, select the MSSQLServerParent.zip) andclick Open.

6. In the Import window, click Finish.The selected project (for example, MSSQLServerParent) is imported to TIBCO Business Studio.

Data Event Poller ProjectsThe plug-in includes the following projects for the Data Event Poller activity:

● Parent projects

● ParentChild projects

● PublishByReference projects

Data Event Poller: Parent ProjectsThe plug-in includes the following Parent projects for the Data Event Poller activity.:

● DB2UDBParent project

● MSSQLServerParent project

● OracleParent project

Data Event Poller: DB2UDBParent Project

The DB2UDBParent project contains one process: db2udbparent.PublishParentData process. Thisproject demonstrates how the plug-in handles polling of data from a publishing table.

PublishParentData Process

In this example, the DataEventPoller activity polls the data from the publishing table. The followingfigure shows the PublishParentData process:

55


JDBC Connection Resource

In this example, the JDBC Connection resource is configured as follows:

ADB Configuration Resource

In this example, the ADB Configuration resource is configured as follows:

56


The table schema is defined by using the Schemas tab. The different tabs on the right are shown below.

The Configuration tab:

The Schema tab:

6in

The Options tab:

The Child Table Order By tab:

57


The DB2 tab

Setting Up the Project

Before running the project, you must set it up.

Prerequisites

● Run the database scripts located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Event Poller/Parent directory in the following order:

1. DB2UDBParent.cleanup.sql - cleanup script

2. Db2UDBParent.sql - DDL script

3. ParentChild_ins_db2udb.sql - insert script

● Import the DB2UDBParent project before setting it up. For more information, see Importing a SampleProject.

Procedure

1. Expand the imported project in the Project Explorer view.

2. Expand the Module Descriptors resource, and then double-click Module Properties.

3. In the Module Properties panel, complete the following tasks:

58


a) Set the value of the userName field as the username of the database.b) Set the value of the password field to access the database.c) Set the value of the dbDriver field to the database driver name. For example:

tibcosoftwareinc.jdbc.db2.DB2Driver

d) Set the value of the dbUrl field to the database URL name. For example:jdbc:tibcosoftwareinc:db2://<host>:<port>;ServiceName=<serviceName>

4. From the menu bar, click File > Save to save the project.

Running the Project

After setting up the project, you can run it.

Procedure

1. In the Project Explorer view, expand the Module Descriptors resource, and then double-clickComponents.

2. In the Components editor, select the process that you want to run.

3. On the toolbar, click the Save icon.

4. To run the selected process, on the menu bar, click Run > Debug Configurations.

5. In the Debug Configurations dialog box, expand BusinessWorks Application, and then clickBWApplication.

6. In the right panel, click the Applications tab, and then select the check box next todb2udbparent.PublishParentData under DB2UDBParent.application

7. Click Debug to run the process.

8. Click the Stop icon to stop the process.

Result

When the PublishParentData process runs successfully, it polls the data from the publishing table.

59


Data Event Poller: MSSQLServerParent Project

The MSSQLServerParent project contains one process: mssqlserverparent.PublishParentDataprocess. This project demonstrates how the plug-in polls data from the publishing table.







60


The table schema is defined by using the Schema tab. The different tabs on the right are shown below.


The Schema tab:

The Options tab:

61





Prerequisites


1. MSSQLServerParent.cleanup.sql - cleanup script

2. MSSQLServerParent.sql - DDL script

3. Parent_ins_ms.sql - insert script

● Import the MSSQLServerParent project before setting it up. For more information, see Importing aSample Project.

Procedure



3. In the Module Properties panel, complete the following tasks:a) Set the value of the userName field as the username of the database.b) Set the value of the password field to access the database.c) Set the value of the dbDriver field to the database driver name. For example:

tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver

62


d) Set the value of the dbUrl field to the database URL name. For example:jdbc:tibcosoftwareinc:sqlserver://<host>:<port>;DatabaseName=<dbname>

e) Set the value of the dbSchema field to the default schema name.


Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next tomssqlserverparent.PublishParentData under MSSQLServerParent.application.



Result


Data Event Poller: OracleParent Project

The OracleParent project contains one process: oracleparent.PublishParentData process. Theproject shows how the plug-in handles polling of data from publishing table.

63








64




The Schema tab:

6in

The Options tab:

65





Prerequisites


1. OracleParent.cleanup.sql - cleanup script

2. OracleParent.sql - DDL script

3. Parent_ins_ora.sql - insert script

● Import the OracleParent project before setting it up. For more information, see Importing a SampleProject.

Procedure



66



tibcosoftwareinc.jdbc.oracle.OracleDriver

d) Set the value of the dbUrl field to the database URL name. For example:jdbc:tibcosoftwareinc:oracle://<host>:<port>;ServiceName=<serviceName>


Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next tooracleparent.PublishParentData under OracleParent.application



Result


Data Event Poller: ParentChild ProjectThe plug-in includes the following ParentChild projects for the Data Event Poller activity:

67


● DB2UDBParentChild project

● MSSQLServerParentChild project

● OracleParentChild project

Data Event Poller: DB2ParentChild Project

The DB2UDBParentChild project contains one process:db2udbparentchild.PublishParentChildData process. This project demonstrates how the plug-inhandles polling of data from publishing table.

PublishParentChildData Process

In this example, the DataEventPoller activity polls data from the publishing table and correspondingdata from the child table. The following figure shows the PublishParentChildData process:



68






The Schema tab:

69


The Options tab:


70


The DB2 tab



Prerequisites

● Run the database scripts located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Event Poller/ParentChild directory in the following order:

1. DB2UDBParentChild.cleanup.sql – cleanup script

2. DB2UDBParentChild.sql – DDL script

● Import the DB2UDBParentChild project before setting it up. For more information, see Importing aSample Project.

Procedure



3. In the Module Properties panel, complete the following tasks:a) Set the value of the userName field as the username of the database.

71


b) Set the value of the password field to access the database.c) Set the value of the dbDriver field to the database driver name. For example:


d) Set the value of the dbUrl field to the database URL name. For example:jdbc:tibcosoftwareinc:db2://<host>:<port>;DatabaseName=<dbname>



Running the Project


Procedure




4. To run the selected process, on the menu bar, click Run > Debug Configurations .


6. In the right panel, click the Applications tab, and then select the check box next todb2udb_parentchild.PublishParentData under DB2UDB_ParentChild.application.



Result

When the PublishParentChildData process runs successfully, it polls the data from the publishing tableand the child table.

72


Data Event Poller: MSSQLServerParentChild Project

The MSSQLServerParentChild project contains one process: mssqlserverparentchild.PublishParentChildData process. This project demonstrates how the plug-in handles polling of datafrom the publishing table. The corresponding data from the child table is also fetched.


In this example, the DataEventPoller activity polls the data from the publishing table. Thecorresponding data from the child table is also fetched. The following figure shows thePublishParentChildData process:



73






74


The Schema tab:

The Options tab:

75





Prerequisites


1. MSSQLServerParentChild.cleanup.sql – cleanup script

2. MSSQLServerParentChild.sql – DDL script

3. ParentChild_ins_ms.sql – insert script

● Import the MSSQLServerParentChild project before setting it up. For more information, see Importing a Sample Project.

Procedure



76







Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next toMSSQLServerParentChild.application.



Result


77


78


Data Event Poller: OracleParentChild Project

The OracleParentChild project contains one process: oracleparentchild.PublishParentChildDataprocess. This project demonstrates how the plug-in handles polling of data from publishing table.


In this example, the DataEventPoller activity polls data from the publishing table and correspondingdata from the child table. The following figure shows the PublishParentChildData process:





79




The Schema tab:

80


The Options tab:




81


Prerequisites


1. OracleParentChild.cleanup.sql – cleanup script

2. OracleParentChild.sql – DDL script

3. ParentChild_ins_ora.sql – insert script

● You have to import the OracleParentChild project before setting it up. For more information, see Importing a Sample Project.

Procedure







Running the Project


Procedure


2. In the Components editor, click and select the process that you want to run.




6. In the right panel, click the Applications tab, and then select the check box next toOracleParentChild.application.



Result


82


83


Data Event Poller: PublishByReference ProjectThe plug-in includes the following PublishByReference projects for the Data Event Poller activity:

● DB2UDBPublishByReference project

● MSSQLPublishByReference project

● OraclePublishByReference project

Data Event Poller: DB2UDBPublishByReference Project

The MSSQLPublishByReference project contains one process: db2udbpublishbyreference.PubByRefprocess. This project demonstrates how the plug-in handles polling of data from a referenced object.

PubByRef Process

In this example, the DataEventPoller activity polls the data from the referenced object. The followingfigure shows the PubByRef process:



84






85


The Schema tab:

The Options tab:


The DB2 tab:

86




Prerequisites

● Run the database scripts located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Event Poller/PublishByReference directory in the following order:

1. DB2UDBPubByRef.cleanup.sql – cleanup script

2. DB2UDBPubByRef.sql – DDL script

3. pubbyref_ins_db2udb.sql – insert script

● Import the DB2UDBPublishByReference project before setting it up. For more information, see Importing a Sample Project.

Procedure





d) Set the value of the dbUrl field to the database URL name. For example:jdbc:tibcosoftwareinc:db2://<host>:<port>;DatabaseName=<dbname>



Running the Project


87


Procedure




4. To run the selected process, on menu bar, click Run > Debug Configurations.


6. In the right panel, click the Applications tab, and then select the check box next todb2udbpublishbyreference.PubByRef under DB2UDBPublishByReference.application.



Result

When the PubByRef process runs successfully, it polls the data from the publishing table and the childtable.

Data Event Poller: MSSQLPublishByReference Project

The MSSQLPublishByReference project contains one process: mssqlpublishbyreference.PubByRefprocess. This project demonstrates how the plug-in handles polling of data from referenced object.

PubByRef Process


88






89




The Schema tab:

The Options tab:

90





Prerequisites


1. MSSQLPubByRef.cleanup.sql – cleanup script

2. MSSQLPubByRef.sql – DDL script

3. pubbyref_ins_ms.sql – insert script

● Import the MSSQLPublishByReference project before setting it up. For more information, see Importing a Sample Project.

Procedure



91







Running the Project


Procedure




4. To run the selected process, on menu bar, click Run > Debug Configurations.


6. In the right panel, click the Applications tab, and then select the check box next tomssqlserverpublishbyreference.PubByRef under MSSQLPublishByReference.application.



Result

When the PubByRef process runs successfully, it polls the data from the publishing table and the childtable.

92


Data Event Poller: OraclePublishByReference Project

The OraclePublishByReference project contains one process: oraclepublishbyreference.PubByRefprocess. This project demonstrates how the plug-in handles polling of data from a referenced object.

PubByRef Process






93


The table schema is defined by using the Schemas tab. The different tabs on the right are shown below


The Schema tab:

The Options tab:

94





Prerequisites


1. OraclePubByRef.cleanup.sql – cleanup script

2. OraclePubByRef.sql – DDL script

3. pubbyref_ins_ora.sql – insert script

● Import the OraclePublishByReference project before setting it up. For more information, see Importing a Sample Project.

Procedure



95






Running the Project


Procedure


2. In the Components editor, click and select the process that you want to run.


4. To run the selected process, on the the menu bar, click Run > Debug Configurations.


6. In the right panel, click the Applications tab, and then select the check box next tooraclepublishbyreference.OraclePubByRefOraclePublishByReference.application.



Result

When the PubByRef process runs successfully, it polls the data from the referenced object.

Data Merger ProjectsThe plug-in includes the following projects for the Data Merger activity:

96


● Parent

● ParentChild

Data Merger: Parent ProjectsThe plug-in includes the following Parent projects for the Data Merger activity:

● DB2UDBDataMergerParent

● MSSQLServerDataMergerParent

● OracleDataMergerParent

Data Merger: DB2UDBDataMergerParent Process

The DB2UDBDataMergerParent project contains one process: db2udbdatamergerparent.ParentDataprocess. This process demonstrates how the plug-in inserts data in the parent table.

ParentData Process

The following figure shows the ParentData process:



97






The Schema tab:

98


The Options tab:

The Child Exception Table Mappings tab:

The DB2 tab:

99


DataMerger DB2Parent: Setting Up the Project


Prerequisites

● Run the database script - DB2UDB_DataMerger_Parent.sql, located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/Parent directory.

● Import the DB2UDBDataMergerParent project before setting it up. For more information, see Importing a Sample Project.

Procedure

1. Expand the imported project in the Project Explorer view.2. Expand the Module Descriptors resource, and then double-click Module Properties.3. In the Module Properties panel, complete the following tasks:

a) Set the value of the userName field as the username of the database.b) Set the value of the password field to access the database.c) Set the value of the dbDriver field to the database driver name. For example:




DataMerger DB2Parent: Running the Project


Procedure


2. In the Components editor, select the process that you want to run.3. On the toolbar, click the Save icon.4. To run the selected process, on the menu bar, click Run > Debug Configurations.5. In the Debug Configurations dialog box, expand BusinessWorks Application, and then click

BWApplication.

100


6. In the right panel, click the Applications tab, and then select the check box next todb2udbdatamergerparent.ParentData under DB2UDBDataMergerParent.application



Result

When the ParentData process runs successfully, it inserts the data to the parent table.

Data Merger: MSSQLServerDataMergerParent Process

The MSSQLServerDataMergerParent project contains one process:mssqldatamergerparent.ParentData process. This process demonstrates how the plug-in inserts datain the parent table.

ParentData Process


101







102



The Schema tab:

The Options tab:

103



MSSQLServerParent: Setting Up the Project


Prerequisites

● Run the database script - MSSQLServer_DataMerger_Parent.sql, located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/Parent directory.

● Import the MSSQLServerDataMergerParent project before setting it up. For more information, see Importing a Sample Project.

Procedure








MSSQLServerParent: Running the Project


Procedure


104






6. In the right panel, click the Applications tab, and then select the check box next tomssqlserverdatamergerparent.ParentData underMSSQLServerDataMergerParent.application.



Result

When the ParentData process runs successfully, it inserts the data in the parent table.

Data Merger: OracleDataMergerParent Process

The OracleDataMergerParent project contains one process: oracledatamergerparent.ParentDataprocess. This process demonstrates how the plug-in inserts data in the parent table.

ParentData Process


105






106




The Schema tab:

The Options tab:

107





Prerequisites

● Run the database script - Oracle_DataMerger_Parent.sql, located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/Parent directory.

● Import the OracleDataMergerParent project before setting it up. For more information, see Importing a Sample Project.

Procedure





108




Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next tooracledatamergerparent.ParentData under OracleDataMergerParent.application.



Result

When the ParentData process runs successfully, it inserts the data to the parent table.

Data Merger: ParentChild ProjectsThe plug-in includes the following ParentChild projects for the Data Merger activity:

● DB2UDBDataMergerParentChild project

● MSSQLServerDataMergerParentChild project

● OracleDataMergerParentChild project

109


Data Merger: DB2UDBDataMergerParentChild Project

The DB2UDBDataMergerParentChild project contains one process:db2udbdatamergerparentchild.ParentChildData process. This process demonstrates how the plug-in inserts data in the parent table and the child table.

ParentChildData Process

The following figure shows the ParentChildData process:





110




The Schema tab:

111


The Options tab:


112


The DB2 tab:



Prerequisites

● Run the database script - DB2UDB_DataMerger_ParentChild.sql, located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/ParentChild directory.

● Import the DB2UDBDataMergerParentChild project before setting it up. For more information, see Importing a Sample Project.

Procedure





113




Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next todb2udbdatamergerparentchild.ParentChildData underDB2UDBDataMergerParentChild.application.



Result

When the ParentChildData process runs successfully, it inserts the data to the parent table and thechild table.

114


Data Merger: MSSQLServerDataMergerParentChild Project

The MSSQLServerDataMergerParentChild project contains one processmssqldatamergerparentchild.ParentChildData process. This project demonstrates how the plug-inhandles inserting of data in the parent table and the child table.


In this example, the Data Merger activity inserts data in the parent table and the child table. Thefollowing figure shows the ParentChildData process:

115






116




The Schema tab:

117


The Options tab:


118


MSSQLServerParentChild: Setting Up the Project


Prerequisites

● Run the database script - MSSQLServer_ParentChild.sql located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/ParentChild directory.

● Import the MSSQLServerDataMergerParentChild project before setting it up. For moreinformation, see Importing a Sample Project.

Procedure








MSSQLServerParentChild: Running the Project


Procedure





119



6. In the right panel, click the Applications tab, and then select the check box next tomssqlserverdatamergerparentchild.ParentChildData underMSSQLServerDataMergerParentChild.application.



Result

When the ParentChildData process runs successfully, it inserts data in the parent table and the childtable.

Data Merger: OracleDataMergerParentChild Project

The OracleDataMergerParentChild project contains one process:oracledatamergerparentchild.ParentChildData process. This process demonstrates how the plug-in inserts data in the parent table and the child table.


The following figure shows the ParentChildData process:

120







121



The Schema tab:

The Options tab:

122



OracleDataMergerParentChild: Setting Up the Project


Prerequisites

● Run the database script - Oracle_DataMerger_ParentChild.sql, located in the TIBCO_HOME/bw/palettes/adb/version_number/Samples/Data Merger/ParentChild directory in the followingorder:

● You have to import the OracleDataMergerParentChild project before setting it up. For moreinformation, see Importing a Sample Project.

Procedure



3. In the Module Properties panel, complete the following tasks:a) Set the value of the userName field as the username of the database.b) Set the value of the password field to access the database.

123


c) Set the value of the dbDriver field to the database driver name. For example:tibcosoftwareinc.jdbc.oracle.OracleDriver



OracleDataMerger ParentChild: Running the Project


Procedure






6. In the right panel, click the Applications tab, and then select the check box next tooracledatamergerparentchild.ParentChildData underOracleDataMergerParentChild.application



Result

When the ParentChildData process runs successfully, it inserts the data to the parent table.

124


125


Advanced Topics

When you use TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database, you can use advancedconfiguration and deployment.


● Output Mapping

● Fault Tolerance

● Load Balancing

● Unlocking the MUTEX Table

● Viewing Client Information Details

● Refactoring a Project

● Error Handling by Data Merger Activity

● Upsert Operation on Parent-Child Tables

● Entity Naming Conventions

Output MappingThis section describes how different data types are mapped to the XSD type.

Mapping Adapter Datatype to Plug-in XSD Type

Adapter AE Datatype Plug-in XSD Type

i1 byte

i2 short

i4 int

i8 long

ui1 unsignedByte

ui2 unsignedShort

ui4 unsignedInt

ui8 unsignedLong

r4 float

r8 double

binary base64Binary

string string

adbDateTime string

126


Mapping Microsoft SQL Server Datatype to XSD Type

Database Type XSD Type

nchar(n) string

datetime string

binary(n) base64Binary

decimal(p,s) double

float double

money double

real double

smalldatetime string

smallint int

smallmoney double

tinyint int

uniqueidentifier string

varbinary(n) base64Binary

bit int

bigint long

datetimeoffset string

date string

varchar(max) string

char(n) string

int int

numeric double

nvarchar string

timestamp base64Binary

127


Mapping Oracle Datatype to XSD Type

Database Type XSD TypeCases for Numeric andNumber

BLOB base64Binary

CLOB string

CHAR string

DATE string

FLOAT string

LONG string

LONG RAW base64Binary

NCHAR string

NCLOB string

NUMBER double If size is not specified, thedefault is 22.

NUMBER(n) int If size less than 10

NUMBER(p,s) double If size is 10 or more than 10

NVARCHAR2 string

RAW base64Binary

TIMESTAMP string

VARCHAR2 string

NUMBER(n) int If size less than 10

NUMERIC double If size is not specified, thedefault is 22.

NUMERIC(p,s) double

NUMERIC double If size is 10 or more than 10

Mapping DB2 Datatype to XSD Type


integer double

128



char string

bigint long

date string

decimal int

decimal(n,s) double

double double

time string

timestamp string

numeric int

real double

smallint int

float double

blob base64binary

clob string

graphic string

long vargraphic string

long varchar string

varchar string

binary base64binary

Mapping MySQL Datatype to XSD Type


bigint long

bigint unsigned double

binary base64binary

bit base64binary

129



blob base64binary

char string

date string

datetime string

decimal double

double double

float double

integer double

longblob base64binary

longtext string

mediumblob base64binary

mediumint int

mediumint unsigned int

mediumtext string

smallint int

smallint unsigned int

text string

time string

timestamp string

tinyblob base64binary

tinyint int

tinyint unsigned int

tinytext string

varbinary base64binary

varchar string

year string

130


Mapping PostgreSQL Datatype to XSD Type


bigint long

bytea base64binary

character string

char string

date string

double precision double

numeric double

real double

time without time zone string

timestamp without time zone string

text string

bit int

bit(n) where n=1 int

bit(n) where n>1 int/base64binary

integer double

smallint int

Fault ToleranceFault Tolerance allows multiple application nodes to substitute for each other. When the primaryapplication node terminates unexpectedly, the role held by the primary application node can be takenover by an application node in the standby state. In the process of replacement, the standby applicationnode is promoted to the primary application node.

To apply Fault Tolerance, you can select one of the following methods:

● In the process designer, right-click and select Show Properties View. Navigate to the Advanced tab.Select Activation as Single AppNode.

● Setup TIBCO ActiveMatrix BusinessWorks™ Administrator in a Fault Tolerance group.

For more information on fault tolerance in TIBCO Activematrix BusinessWorks™, refer to the TIBCOActiveMatrix BusinessWorks™ Administration guide.

131


Load BalancingThe plug-in provides Load Balancing to distribute the workload across application nodes. This resultsin an improvement of performance in a high-load scenario.

Application nodes with the same mutex name specified are in the same load balancing group.

By default, load balancing is ON.

The default name of the mutex table is the first 20 characters of the publishing table name suffixed with"_MUTEX". You can change the name of the mutex table name and the corresponding mutex table iscreated in the database.

For more information on load balancing and fault tolerance in BusinessWorks, refer to the TIBCOActiveMatrix BusinessWorks™ Administration guide.

Enabling Load BalancingBy default, load balancing is on.

To apply Load Balancing, you can select one of the following methods:

● In the process designer, right-click and select Show Properties View. Navigate to the Advanced tab.Select Activation as Multiple AppNode.

● Setup ActiveMatrix BusinessWorks Administrator in a Group mode.

Disabling Load Balancing

Procedure

1. Click the DataEventPoller activity in the Process Designer.

2. Navigate to the Properties tab > Advanced section.

3. Clear the Enable Load Balancing check box.Load balancing is disabled.

Unlocking the MUTEX TableA Mutex table could result in lock and unlock situations.

When you publish data, the data is set in the table and the status is also set to N. When an applicationnode is running, the mutex table fetches data with status as N and acquires a lock. When the status

132


changes from N to S, the mutex table releases the lock from the table. If you try to forcefully shutdownthe application node, the mutex table gets locked and the configurations associated with Mutex table donot work. To release a lock on a MUTEX table, manual intervention is required.

Only DBA users can execute the scripts to unlock the MUTEX table.

Oracle

To fetch the ID and serial number of the locked session, execute the following query:select s.sid, s.serial#, p.spid From v$session s, v$process pwhere s.paddr = p.addr AND s.sid in (select SESSION_ID fromv$locked_object);

To kill the session that has acquired the lock, execute the following query:alter system kill session '<id>, <serial number>';

Microsoft SQL Server

To fetch the ID and serial number of the locked session, execute the following query:SELECT OBJECT_NAME(P.object_id) ASTableName,Resource_type,request_session_idFROM sys.dm_tran_locks LJOIN sys.partitions PON L.resource_associated_entity_id=p.hobt_idWHERE OBJECT_NAME(P.object_id)='P1Chronolog_IncidentActivityUpdates'

To kill the session that has acquired the lock, execute the following query:Kill session_ID

Viewing Client Information DetailsClient information is displayed in the format ADB_<appnode>_<appspace>_<domain>. Theclient_info parameter is limited to 64 bytes. Longer values are truncated.

Administrators can check client information details. To view client information in the database, youmust run the following query:

SELECT sid, username, client_info FROM v$session WHERE username='<username>';

Refactoring a ProjectProjects from earlier versions have to be refactored to enable the features provided in the new versionsof the plug-in.

Procedure

1. In the Project Explorer pane of TIBCO Business Studio, right-click the project name and selectRefactor > Repair BusinessWorks Projects.

133


2. In the Select the BusinessWorks Projects window, ensure that the Refresh Project Cache and doProject Clean and Add DBMerger in ADB Configuration Shared Resource check boxes areselected.

3. Click OK.

Error Handling by Data Merger ActivityWhen the Data Merger activity inserts data in a database and an error occurs, the activity rolls back allprevious operations on the database to the original status. The Data Merger activity handles data in twoways: normal error handling and bulk insert error handling.


● Normal Error Handling

● Bulk Insert Error Handling

● How Records are Handled by the Bulk Insert Error Handling Feature

Normal Error Handling

Principles for normal error handling are as follows:

134


● If you do not set a bulk insert size, the Data Merger activity inserts error data into either theexception table or opaque exception table.

● If you set both a bulk insert size and a batch commit size, the Data Merger activity inserts data in thefollowing ways:

— If all the data in a bulk is processed successfully, the Data Merger activity inserts all the data inthe bulk in the destination table.

— If all the data in a bulk is not processed successfully, the Data Merger activity inserts all thedata, including the error data, in the bulk in either the exception table or opaque exceptiontable.

Bulk Insert Error Handling and Applicable RestrictionsYou can insert records in a bulk in the destination table. The bulk insert error handling feature is usedto improve data accuracy and processing efficiency. It also prevents failure during bulk insertoperation.

The bulk insert error handling feature restrictions are as follows:

● This feature applies to the Data Merger activity only.

● It can be implemented only when the java.sql.BatchUpdateException error occurs.

● It can be used with databases such as the Oracle database.

● It cannot be used with schemas having a parent-child relationship.

For example, a job attempts to perform a bulk insert of 500 rows to the destination table. If the first 300rows are inserted successfully but the last 200 rows are not, the job inserts the successful 300 rows to thedestination table and the unsuccessful 200 rows to the exception table.

If the bulk insert error handling feature is not enabled and a error occurs, the job inserts all rows (bothcorrect and incorrect) in the exception table when the Data Merger activity performs the bulk insertoperation.

How Records are Handled by the Bulk Insert Error Handling Feature

The following example explains the workflow of bulk insert error handling.

Consider that the plug-in attempts to execute a bulk insert operation that contains the followingrecords. M1, M3, and M4 are correct records. M2 and M5 are incorrect records.

When the Handle Bulk Insert Error check box on the Advanced tab of the Data Merger activity isselected, the following process shows how bulk insert error handling is performed:

1. When the bulk commit size limit is reached, the plug-in starts to commit this bulk insert into thedatabase.

2. When an error occurs while inserting the incorrect record (M2), bulk insert error handling insertsthis record in the exception table.

3. Then the plug-in handles the remaining records, and when an error occurs while inserting theincorrect record (M5), bulk insert error handling inserts this record in the exception table.

4. After the bulk insert operation is complete, you can see all correct records (M1, M3, and M5) are inthe destination table and the incorrect records (M2 and M5) are in the exception table.

If a plug-in instance contains multiple Data Merger activities, each activity handles exception logicbased on its configuration. Therefore, the exception logic of each Data Merger activity might bedifferent.

135


Upsert Operation on Parent-Child TablesWhen an upsert operation is performed on parent-child tables by using the Data Merger activity, theupsert operation behaves differently in different scenarios.

Consider that the Data Merger schema has parent-child tables and the upsert operation is performed onthese tables. The following table summarizes the different scenarios and the results:

Upsert Operation Behavior

Parent Table Child Tables Result

Scenario 1

ADB_OPCODE=2 for a record

Record exists

ADB_OPCODE isblank for allrecords

Records do notexist

The record in parent table is updated correctly; the sameoperation (update) is performed on child records.

Non-existing records in child tables are not inserted in thechild tables.

Scenario 2


Record does notexist

ADB_OPCODE isblank for allrecords

Records exist

The parent record is inserted in the parent table correctly;the same operation (insert) is performed on child records.

“Duplicate records error" occurs when you try to insertexisting records in the child tables.

Scenario 3


Record exists

ADB_OPCODE=1for all records

Records do notexist

The record in parent table is updated correctly andrecords are inserted in the child tables correctly.

Scenario 4


Record does notexist

ADB_OPCODE=2for all records

Records exist

The record is inserted in the parent table correctly and thechild records are updated in child tables correctly.

When working with parent-child tables, the value of ADB_OPCODE in the parent table and the childtable must be the same. Or you must set the value of ADB_OPCODE only in the parent table and leavethe child table empty.

Entity Naming ConventionsMost of the ActiveMatrix BusinessWorks named entities are modeled as NCNames (or as a subset of anNCName). These include activity names and schema names.

NCName stands for XML non-colonized name. For the W3C definition for NCName, see https://www.w3.org/TR/xmlschema-2/#NCName. NCNames conform to the following restrictions:

● Include any or all of the following valid characters: A-Z, a-z, numbers 0-9, hyphen (-), underscore(_).

136


https://www.w3.org/TR/xmlschema-2/#NCName

https://www.w3.org/TR/xmlschema-2/#NCName

● Do not include the following characters: at (@), colon (:), dollar ($), percent (%), ampersand (&),slash (/), plus (+), comma (,), semicolon (;) , parentheses (()), and white space characters.

● Do not begin with a number, dot (.), or hyphen (-). However, these characters can appear in anNCName.

137


Managing Logs

Logs are used to trace and troubleshoot the plug-in exceptions.

When an error occurs, you can check the logs to trace and troubleshoot the plug-in exception. Bydefault, error logs are displayed in the Console view when you run a process in the debug mode. Youcan change the log level of the plug-in to trace different messages and export logs to a file. Different loglevels correspond to different messages, as described in Log Levels

A logback.xml file is located in the TIBCO_HOME\bw\<version>\config\design\logback directory.Update this file to set up a log file and export logs to a file.

Log Levels

Different log levels include different information. The plug-in supports the following log levels:

LogLevel Description

Debug Indicates a developer-defined tracing message.

Info Indicates normal plug-in operations. No action is required. A tracing message tagged withInfo indicates that a significant processing step is reached, and logged for tracking orauditing purposes. Only Info messages preceding a tracking identifier are considered assignificant steps.

Error Indicates that an unrecoverable error occurred. Depending on the severity of the error, theplug-in might continue with the next operation or might stop.

Warn Indicates that an abnormal condition occurred. Processing continues, but special attentionfrom an administrator is recommended.

Trace Includes all information regarding the running process.

Setting Up Log LevelsYou can configure different log levels for the plug-in and plug-in activities to trace different messages.By default, the plug-in uses the log level configured for TIBCO ActiveMatrix BusinessWorks. Thedefault log level of TIBCO ActiveMatrix BusinessWorks is Error.

If neither the plug-in log nor the BusinessWorks log is configured in the logback.xml file, the errorlogs of the plug-in are displayed in the Console view by default. If the plug-in log is not configured, butthe BusinessWorks log is configured in the logback.xml file, the configuration for the BusinessWorkslog is implemented by the plug-in.

Procedure

1. Navigate to the TIBCO_HOME\bw\<version>\config\design\logback directory and open thelogback.xml file.

2. Add the following node in the Console Appender area to specify the log level for the plug-in:<logger name="com.tibco.bw.palette.adbplugin.runtime"> <level value="DEBUG"/></logger>

The level tag defines the log level and the value of the level element can be Trace, Info, Error orDebug.

138


When the level is set to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view.

3. Optional: Add the following node in Console Appender area to specify the log level for an activity:<logger name="com.tibco.bw.palette.adbplugin.runtime.ActivityNameActivity"> <level value="DEBUG"/></logger>

See the following examples:

● To set the log level of the Data Event Poller activity to Debug, you must add the following node:<logger name="com.tibco.bw.palette.adbplugin.runtime.datapoller.ADBEventSource"> <level value="DEBUG"/></logger>

● To set the log level of the Data Merger activity to Debug, you must add the following node:<loggername="com.tibco.bw.palette.adbplugin.runtime.datamerger.DataMergerActivity"> <level value="DEBUG"/></logger>

● To set the log level of the ADB Configuration shared resource to Debug, you must add thefollowing node:<logger name="com.tibco.bw.sharedresource.adbplugin.runtime"> <level value="DEBUG"/></logger>

For the activities that do not configure with specific log levels, they still inherit log levelconfigured for the plug-in or BusinessWorks.

4. Save the file.

Exporting Logs to a FileModify the logback.xml file to export plug-in logs to a file.

Procedure

1. Navigate to the TIBCO_HOME\bw\<version>\config\design\logback directory and open thelogback.xml file.

When deploying an application in TIBCO Enterprise Administrator, you must navigate tothe TIBCO_HOME\bw\domains\defaultdomain\appnodes\defaultappspace\defaultappnode directory to find the logback.xml file.

2. Add the following node to specify the file location:<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-adbplugin.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The file tag defines the location to which the log is exported and the value is the absolute path ofthe file that is detailed to the file name.

3. Add the following node to the root node at the bottom of the logback.xml file to enable exportingthe logs to a file:<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

139


Error Codes

The following table lists error codes, detailed explanation of each error, and ways to resolve errors(wherever applicable).

Error Code and ErrorMessage Role Category Description Resolution

TIBCO-BW-PALETTE-ADBPLUGIN-100001.

The number of

records per event is

{0}.

Trace BW-Plugin Number of recordsper event is 0.

This is a tracemessage andresolution is notapplicable


DataEventPoller

schema {0} bind

fault status updater.

Trace BW-Plugin Set parameter valuesfor updatingADB_L_DELIVERY_STATUS in publishingtable from S to F.



DataEventPoller

Schema {0} execute

fault status updater

{1}.

Trace BW-Plugin Execute update ofADB_L_DELIVERY_STATUS in publishingtable from S to F.



DataEventPoller

Schema {0} No record

found.

Trace BW-Plugin Polling is in progressand no data is foundin parent or child tablefor publishing



DataEventPoller

Schema {0} execute

pub table updater

{1}.

Trace BW-Plugin SQL query used forupdating publishingtable.



DataEventPoller

Schema {0} batch

update {1}.

Trace BW-Plugin Number of recordsupdated during batchprocessing.


140




DataEventPoller

Schema {0} release

multi-threading

semaphore after

marking records.

Trace BW-Plugin Release the publishingtable semaphore toallow other threadspoll the publishingtable



DataEventPoller

Schema {0} release

table {1} lock in

load balance mode.

Trace BW-Plugin Release the table lockin load balance mode.



DataEventPoller

Schema {0} execute

publishing table

selector {1}.

Trace BW-Plugin Select columns frompublishing table withADB_L_DELIVERY_STATUS = 'N'


TIBCO-BW-PALETTE-ADBPLUGIN-100010

DataEventPoller

Schema {0} builds

publishing table

selector.

Trace BW-Plugin Build select statementfor fetching data frompublishing table.


TIBCO-BW-PALETTE-ADBPLUGIN-100011

DataEventPoller

Schema {0} binds

publishing table

selector, polling

batch size is {1}.

Trace BW-Plugin Set parameter valuesfor the select query onpublishing table.



DataEventPoller

Schema {0} execute

publishing table max

sequence selector

{1}.

Trace BW-Plugin SelectMAX(ADB_SEQUENCE) from table whereADB_L_DELIVERY ='N'


141




DataEventPoller

Schema {0} builds

publishing table max

sequence selector.

Trace BW-Plugin Build select statementfor fetching maximumADB_SEQUENCEvalue



DataEventPoller

Schema {0} execute

publishing table

mini sequence

selector {1}.

Trace BW-Plugin SELECTMIN(ADB_SEQUENCE) from table whereADB_L_DELIVERY ='N'



DataEventPoller

Schema {0} builds

publishing table

mini sequence

selector.

Trace BW-Plugin Build select statementfor fetching minimumADB_SEQUENCEvalue



DataEventPoller

Schema {0} selects

record data from

reference object

table {1}.

Trace BW-Plugin SQL query for selectfrom reference objector source table



DataEventPoller

Schema {0} builds

pub table updater.

Trace BW-Plugin Build update queryfor publishing table



DataEventPoller

Schema {0} binds pub

table updater.

Trace BW-Plugin Set parameter valuesfor the update queryon publishing table.



DataEventPoller

Schema {0} build 'S'

to 'N' updater.

Trace BW-Plugin Build update queryfor publishing table tochangeADB_L_DELIVERY_STATUS from S to N.


142




DataEventPoller

Schema {0} bind 'S'

to 'N' updater.

Trace BW-Plugin Set parameter valuesfor updatingADB_L_DELIVERY_STATUS in publishingtable from S to N.



DataEventPoller

Schema {0} execute

'S' to 'N' updater

{1}.

Trace BW-Plugin Execute update ofADB_L_DELIVERY_STATUS in publishingtable from S to N.



DataEventPoller

Schema {0} Child

table {1} has no

data to publish.

Trace BW-Plugin Publish Child Data isenabled and there isno data to fetch fromchild table.



The mutex table {0}

already exists.

Trace BW-Plugin The mutex tablealready exists in theDB.



DataEventPoller

Schema {0} bind

reference object

selector.

Trace BW-Plugin Set parameter valuesfor selecting data fromreferred table.



DataEventPoller

Schema {0} selects

record data from

reference object

table.

Trace BW-Plugin Execute select onreferred table.



DataEventPoller

Schema {0} builds

reference object

selector.

Trace BW-Plugin Build select query forreferred table.


143




DataEventPoller

Schema {0}

constructs the

instance based on

the source table.

Trace BW-Plugin If referred table is notmentioned, updatepublishing table basedon the source table.



DataEventPoller

Schema {0} Start to

fetch data from

child table.

Trace BW-Plugin Publish Child Data isenabled and threadstarts to fetch datafrom child table.



DataEventPoller

Schema {0} Finish

fetching data from

child table.

Trace BW-Plugin Publish Child Data isenabled and threadcompleted fetchingdata from child table.



DataEventPoller

Schema {0} Fetch

child data from {1}.

Trace BW-Plugin Fetching data fromchild table.



DataEventPoller

Schema {0} execute

child selector {1}.

Trace BW-Plugin Select columns forpublishing from childtable.



DataEventPoller

Schema {0} build

child selector.

Trace BW-Plugin Build select query forfetching data fromchild table.



DataEventPoller

Schema {0} bind

child selector.

Trace BW-Plugin Set parameter valuesfor select query tofetch child data.


144




DataEventPoller

Schema {0} build

fault status

updater.

Trace BW-Plugin Build update query toupdate status to F



DataEventPoller

Schema {0} builds

ADB_L_DELIVERY_STATU

S N->S marker.

Trace BW-Plugin Build update queryfor Load Balancingmarker



DataEventPoller

Schema {0} builds

publishing table

selector whose


S is S.

Trace BW-Plugin Select query for loadbalancing



DataEventPoller

Schema {0} binds


S N -> S marker …

Trace BW-Plugin Sets parameter valuesfor the load balancingquery



DataEventPoller

Schema {0} acquire

table {1} lock in

load balance mode.

Trace BW-Plugin DataEventPollerSchema acquiring lockon a table in the loadbalancing mode.



DataEventPoller

Schema {0} execute


S N -> S marker ...

{1}

Trace BW-Plugin Executes the query inload balancing mode.


145




Creating the mutex

table {0}.

Trace BW-Plugin Creates table in DBlock initialization forload balancing mode.



DataEventPoller

Schema {0} selects

record data from

source table.

Trace BW-Plugin If referred table is notmentioned, selectsdata from the sourcetable.



Mutex table {0} is

already locked by

other node.

Trace BW-Plugin Table is already lockedby another node.



DataEventPoller

Schema {0} failed to

construct result

based on source

table because no

data fetched from

{1}.

Trace BW-Plugin Object constructionfailed when no datafound in source table.



Activity {0}

generated output:

\n{1}.

Debug BW-Plugin Shows output of datapoller activity in XMLformat.

This is a debugmessage andresolution is notapplicable


DataEventPoller

Schema {0} starts

polling message.

Info BW-Plugin Thread starts pollingpublishing table tofetch any changes.

This is a infomessage andresolution is notapplicable

TIBCO-BW-PALETTE-ADBPLUGIN-300002.{0}

Info BW-Plugin Shown if there is lossof connection orreconnection issuccessful.


146




DataEventPoller

Schema {0} has

different reference

object in Shared

Resource and

Publishing Table. To

resolve this issue,

either fix the

shared resource or

re-generate the

trigger.

Warn BW-Plugin Schema has differentreference object inShared Resource andPublishing Table.

To resolve thisissue, either fix theshared resource orre-generate thetrigger.


DataEventPoller

Schema {0} failed to

construct result

based on reference

object because no

data fetched from

{1}.

Warn BW-Plugin Object constructionfailed when no datafound in referencedtable.



DataEventPoller

Schema {0} throw

exception {1} when

update entry status.

Error BW-Plugin Thrown if issue occursin updating 'N' to 'C'in publishing tableduring transaction.SQLException isthrown.

Check errors listedin the errormessage, and takean appropriateaction.


DataEventPoller

Schema {0} throw

exception {1} when

execute publishing

table selector.

Error BW-Plugin Thrown whenexecuteQuery fails forpublishing table andSQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

build publishing

table selector.

Error BW-Plugin Thrown whenprepareStatement failsfor publishing tableand SQLException isthrown.


147




DataEventPoller

Schema {0} throw

exception {1} when

bind publishing

table selector.

Error BW-Plugin Thrown when settingparameter fails forpublishing table andSQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

execute the max

sequence selector.

Error BW-Plugin Thrown whenexecuteQuery fails formax sequence selectorand SQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

build publishing

table max sequence

selector.

Error BW-Plugin Thrown whenprepareStatement failsfor max sequenceselector andSQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

execute the mini

sequence selector.

Error BW-Plugin Thrown if there is noDataEventPoller table.



DataEventPoller

Schema {0} throw

exception {1} when

build publishing

table mini sequence

selector.

Error BW-Plugin Thrown whenprepareStatement failsfor min sequenceselector andSQLException isthrown.


148




DataEventPoller

Schema {0} throw

exception {1} when

get dbTable whose

name is

publishingTableName.

Error BW-Plugin Thrown if there iserror fetching datafrom publishing table.



DataEventPoller

Schema {0} throw

exception {1} when

build pub table

updater.

Error BW-Plugin Thrown whenprepareStatement failswhile updatingpublishing table andSQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

bind pub table

updater.

Error BW-Plugin Thrown when settingparameter fails whileupdating publishingtable andSQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

manipulate S to N

status updater.

Error BW-Plugin Thrown whenupdating status fromS to N fails.


TIBCO-BW-PALETTE-ADBPLUGIN-500013.{0}

Error BW-Plugin Throws when ADBvalidation fails.


149




{0}

Error BW-Plugin Thrown when ADBsql Exception Faultoccurs. Scenario 1:Columns in sharedresource andpublishing table arenot same. Createshared resource withtable T columnscol1,col1. In dataevent poller activity,apply triggers. Thepublishing table P_Tis generated. Nowalter the original tableT and add columncol3. Refind schema inshared resource andfetch columnscol1,col1,col3. Nowrun the process. Inserta new record in tableT.



DataEventPoller

Schema {0} throw

exception {1} when

construct minstance

based on publishing

table.

Error BW-Plugin Error fetching row ofpublishing table.SQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

fetch child data.

Error BW-Plugin Error fetching rows ofchild table.SQLException isthrown.



DataEventPoller

Schema {0} throw

exception {1} when

build child

selector.

Error BW-Plugin Thrown whenprepareStatement failsfor building childselector.SQLException isthrown.


150




DataEventPoller

Schema {0} throw

exception {1} when

bind child selector.

Error BW-Plugin Thrown when settingparameter fails whilebuilding the childquery. SQL Exceptionis thrown.



DataEventPoller

Schema {0} throw

exception {1} when

build pub load

balancing marker.

Error BW-Plugin Thrown whenprepareStatement failswhile building theload balance updatequery. SQL Exceptionis thrown.



DataEventPoller

Schema {0} throw

exception {1} when

build pub load

balancing pub table

selector.

Error BW-Plugin Thrown whenfetching the rowsfrom publishing tablefor load balancingselector. SQLException is thrown.



DataEventPoller

Schema {0} throw

exception {1} when

bind pub load

balancing marker.

Error BW-Plugin Thrown when settingparameters fail whilebuilding loadbalancing query. SQLException is thrown.



DataEventPoller

Schema {0} throw

exception {1} when

execute pub load

balancing marker.

Error BW-Plugin Thrown when updatequery fails for loadbalancing. SQLException is thrown.



DataEventPoller

Schema {0} throw

exception {1} when

initialize the

DBLockMechanism.

Error BW-Plugin Initializing the DBLock Mechanism.


151



TIBCO-BW-SR-ADBPLUGIN-100001.

Logs related ot

Starting,

stopping,updating

shared resource.

Trace BW-Plugin When user starts,stops, or updatesshared resource.



Adding new

configuration for

Shared Resource with

name [{0}]

Info BW-Plugin Logs when usercreates new sharedresource



Deleting

Configuration for

Shared Resource with

name[{0}]

Info BW-Plugin When user deletesconfiguration forshared resource



Error creating

shared resource {0}.

Exception:{1}

Error BW-Plugin If any error whilecreating sharedresource.


ADB_DATA_MERGER_EVENTS_MSG-100049{0}

Trace BW-Plugin Displays the messageon activity events suchas initialization.

This is a tracemessage andresolution is notapplicable.

ADB_DATA_MERGER_PARENT_TBALE_INVALID_OPCODE_MSG-100050

Data Merger Schema

{0} the parent table

opcode {1} is

invalid,so discard

the message.

Trace BW-Plugin Discards the messagewhen the parent tableopcode is invalid.


ADB_DATA_MERGER_OPCODE_BYPASS_MSG-100051.

Data Merger Schema

{0} bypass one

message.

Trace BW-Plugin If opcode is 10,bypasses the message.


152



ADB_DATA_MERGER_MSGBODY_MSG-100052.

Data Merger Schema

{0} Message body:

{1}.

Trace BW-Plugin Displays the messagebody of Data Mergerschema.


ADB_DATA_MERGER_CHILD_INCREMENTAL_OPERATION_MSG-100053.

Data Merger Schema

{0} will do

incremental

operation for child

records.

Trace BW-Plugin If opcode exists,handles the child dataincrementally.


ADB_DATA_MERGER_BEGIN_TRANSACTION_MSG-100055.

Data Merger Schema

{0} start DB

transaction.

Trace BW-Plugin Displayed in logswhen databasetransaction starts.


ADB_DATA_MERGER_COMMIT_TRANSACTION_MSG-100056.

Data Merger Schema

{0} commit DB

transaction.

Trace BW-Plugin Displayed in logswhen databasetransaction iscommitted.


ADB_DATA_MERGER_EXECUTE_STMT_FAILED_MSG-100057.

Data Merger Schema

{0} throw exception

{1} when execute

statement {2}.

Trace BW-Plugin Throws exceptionwhen executestatement fails.


ADB_DATA_MERGER_CHILD_TABLE_INVALID_OPCODE_MSG-100058.

Data Merger Schema

{0} the child table

opcode {1} is

invalid,so discard

the child table

message.

Trace BW-Plugin Discards the messagewhen the child tableopcode is invalid.


153



ADB_DATA_MERGER_SINGLE_TABLE_INVALID_OPCODE_MSG-100059.

Data Merger Schema

{0} the single table

opcode {1} is

invalid,so discard

the single message.

Trace BW-Plugin Discards the messagewhen single tableopcode is invalid.


ADB_DATA_MERGER_STATEMENT_IS_NULL_WHEN_EXECUTE_MSG-100060.

Data Merger Schema

{0} can't execute

the statement

because of the

statement is null.

Trace BW-Plugin Displayed whentrying to execute anull statement.


ADB_DATA_MERGER_AFFECT_DATABASE_ROWS_MSG-100061.

Data Merger Schema

{0} {1} row(s)

affected.

Trace BW-Plugin When database row isaffected due tosuccessful statementexecution.


ADB_DATA_MERGER_ROLLBACK_REASON-100062.

Data Merger Schema

{0} will rollback

since {1}.

Trace BW-Plugin Rolls back if you setnot to use anyexception table.


ADB_DATA_MERGER_HANDLE_EXCEPTION_MSG-100063.

Data Merger Schema

{0} handle [{1}] :

{2}

Trace BW-Plugin Handles the exceptionmessage based on theerror status.


ADB_DATA_MERGER_ROLLBACK_TRANSACTION_MSG-100064.

Data Merger Schema

{0} roll back DB

transaction.

Trace BW-Plugin Rolls back thedatabase transactionwhen the record fails.


154



ADB_DATA_MERGER_INSERT_EXCEPTION_INTO_EXCEPTION_TABLE_MSG-100065.

Data Merger Schema

{0} insert the data

{1} into exception

table {2}.

Trace BW-Plugin When record fails anddata is inserted in theexception table.


ADB_DATA_MERGER_OPAQUE_TABLE_NOT_FOUND_MSG-100066.

Data Merger Schema

{0} the opaque

exception table is

not found.

Trace BW-Plugin When trying to insertrecord in opaqueexception table andtable is not found.


ADB_DATA_MERGER_INSERT_MSG_INTO_OPAQUE_TABLE_MSG-100067.

Data Merger Schema

{0} insert the data

{1} into opaque

exception table {2}.

Trace BW-Plugin When record fails toinsert in target tableand exception table,tries to insert record inopaque exceptiontable.


ADB_DATA_MERGER_DELETE_CASCADE_DELETE_CHILD_DATA_MSG-100068.

Data Merger Schema

{0} delete related

child records. {1}

Trace BW-Plugin If opcode is 3, deleteschild data records.


ADB_DATA_MERGER_DELETE_CASCADE_FETCH_CHILD_DATA_MSG-100069.

Data Merger Schema

{0} query related

child records.{1}

Trace BW-Plugin If opcode is 4, fetcheschild data records.


155



ADB_DATA_MERGER_CREATE_STMT_FAILED_MSG-100070.

Data Merger Schema

{0} throw exception

{1} when create

statement for Data

{2}.

Trace BW-Plugin When createstatement andinitialize parametersfail.


ADB_DATA_MERGER_REUSE_DBSTMT_FAILED_MSG-100071.

Data Merger Schema

{0} the statement in

cache can't be

reused {1}.

Trace BW-Plugin If statement parameterlist is not equal tocolumn name, reusedatabase statementfails.


ADB_DATA_MERGER_SET_STMT_TO_STORE_MSG-100072.

Data Merger Schema

{0} cache statement

{1} for table {2}.

Trace BW-Plugin When fails to setstatement in store.


ADB_DATA_MERGER_ERROR_BIND_STATEMENT_IS_NULL_MSG-100073.

Data Merger Schema

{0} can't bind the

statement because of

the statement is

null.

Trace BW-Plugin Fails to bind statementwhen statement isnull.


ADB_DATA_MERGER_STMT_BIND_PARAM_FAILED_MSG-100074.

Data Merger Schema

{0} throw exception

{1} when bind

parameter to

statement {2}.

Trace BW-Plugin Fails when not able tobind parameters to thestatement.


156



ADB_DATA_MERGER_PRE_COMMIT_SUCCESSFUL_MSG-100075.

Data Merger Schema

{0} call pre-commit

procedure

successfully.

Trace BW-Plugin Successfully calls pre-commit storedprocedure.


ADB_DATA_MERGER_PRE_COMMIT_UNSUCCESSFUL_MSG-100076.

Data Merger Schema

{0} call pre-commit

procedure

unsuccessfully.

Trace BW-Plugin Not able to call pre-commit storedprocedure.


ADB_DATA_MERGER_ERROR_PRECOMMIT_OUTPUT_PARAMTER_SPTEXT-100077.

Data Merger Schema

{0} the pre-commit

procedure output

parameter SP_TEXT is

{1}.

Trace BW-Plugin If pre-commitprocedure outputparameter SP_TEXT isnull or blank.


ADB_DATA_MERGER_PRINT_PRE_COMMIT_PROCEDURE_RESULT-100078.

Data Merger Schema

{0} result of pre-

commit stored

procedure {1} is

\n{2}\n\t.

Trace BW-Plugin Prints result of pre-commit storedprocedure along withservice name and pre-commit storedprocedure name.


ADB_DATA_MERGER_START_HANDLE_NORMAL_EXCEPTION-100079.

Data Merger Schema

{0} start handle

normal exception.

Trace BW-Plugin Handles normalexception.


157



ADB_DATA_MERGER_CREATE_STMT_FAILED-100080.

Data Merger Schema

{0} throw exception

\n\t\u0020{1}\n\t

\u0020 when create

statement for Data

\n\t\u0020{2}\n\t.

Trace BW-Plugin Fails to createstatement andinitialize parameters.


ADB_DATA_MERGER_STMT_BIND_PARAM_FAILED-100081.

Data Merger Schema

{0} throw exception

\n{1}\n when bind

parameter to

statement \n\t

\u0020{2}\n\t.

Trace BW-Plugin Fails to bindparameters to thestatement.


ADB_DATA_MERGER_RECEIVE_GROUPMSG-100082.

Data Merger Schema

{0} receive a group

message which

contain {1}

record(s). \n\t.

Trace BW-Plugin Receives groupmessage whichcontains n records.


ADB_DATA_MERGER_START_TO_HANDLE_ONE_MSG_ITEM-100084.

Data Merger Schema

{0} start to handle

the {1} item for the

group message. \n\t

Trace BW-Plugin Starts to handle eachitem one at a time forgroup message.


ADB_DATA_MERGER_FLUSH_BULK_INSERT-100085.

Data Merger Schema

{0} flush Bulk-

Insert.\n\t.

Trace BW-Plugin Flushes bulk-Insert ifbulk insert statementis not null.


158



ADB_DATA_MERGER_AFFECT_DATABASE_ROWS-100086.

Data Merger Schema

{0} {1} row(s)

affected.\n\t.

Trace BW-Plugin When database row isaffected due tosuccessful statementexecution.


ADB_DATA_MERGER_EXECUTE_STATEMENT_SUCCESSFUL_COUNT-100087.

Data Merger Schema

{0} execute database

statement successful

count is {1}\n\t.

Trace BW-Plugin Displays count ofstatements executedsuccessfully on thedatabase.


ADB_DATA_MERGER_NO_DATA_CHANGE_IN_DATABASE-100088.

Data Merger Schema

{0} no data change

in the database.\n

\t.

Trace BW-Plugin No change in databaseif count of statementsexecuted successfullyon the database is 0.


ADB_DATA_MERGER_RECEIVE_SINGLEMSG-100089.

Data Merger Schema

{0} receive a single

message.\n\t.

Trace BW-Plugin Data Merger schemareceives a singlemessage.


ADB_DATA_MERGER_HANDLE_EXCEPTION_ROLLBACK_DATA-100090.

Data Merger Schema

{0} prepare roll

back the exception

data \n\t.

Trace BW-Plugin Perform roll backoperation if there isany exception inprocessing the data.


ADB_DATA_MERGER_HANDLE_EXPTION_START-100091 DataMerger Schema {0}

cache data size {1},

start handle

exception\n {2} \n

\t.

Trace BW-Plugin Starts handling thesubcache exception.


159



ADB_DATA_MERGER_HANDLE_EXPCEPTION_DATA_COUNT-100092.

Data Merger Schema

{0} exception cache

data size is {1},

executed successful

data size is {2} \n

\t.

Trace BW-Plugin Handles subcacheexception data count.


ADB_DATA_MERGER_HANDLE_EXCEPTION_DATA_POSITION-100093.

Data Merger Schema

{0} handle exception

data {1} of {2} \n

\t.

Trace BW-Plugin Add all the messagesin the errorList to theexception table or theopaque exceptiontable.


ADB_DATA_MERGER_HANDLE_NORMAL_EXCEPTION-100094.

Data Merger Schema

{0} finish handle

normal exception\n

\t.

Trace BW-Plugin Finishes handlingnormal exception.


ADB_DATA_MERGER_BULKINSERT_CONFIRMING_MESSAGE_SUCCESS-100097.

Data Merger Schema

{0} Confirming {1}

message(s)

Successfully

Trace BW-Plugin Confirms count ofbatch commit datamessages successfully.


ADB_DATA_MERGER_PRINT_STMT_BOUNDS-100098.

Data Merger Schema

{0} statement

bounds:{1}

Trace BW-Plugin Displays messagewhen batch executionhappens in bulkinsert.


160



ADB_DATA_MERGER_STATEMENT_IS_NULL_WHEN_EXECUTE-100099.

Data Merger Schema

{0} can't execute

the statement

because of the

statement is null

Trace BW-Plugin If the statement isnull, cannot executethe statement.


ADB_DATA_MERGER_HANDLE_NEED_EXECUTE_DATA-100100.

Data Merger Schema

{0} handle {1} of

{2} need execute

data

Trace BW-Plugin Displays which data isbeing executed forbulk insert handling.


ADB_DATA_MERGER_HANDLE_ERROR_DATA-100101.

Data Merger Schema

{0} handle {1} of

{2} error data.

Trace BW-Plugin Displays which data isbeing handled forbulk insert errorhandling.


ADB_DATA_MERGER_NOT_CONFIRMING_MESSAGE-100102.

Data Merger Schema

{0} didn't confirm

error message "{1}",

since this error

message can't be

inserted into

exception/opaque

table.

Trace BW-Plugin When error messagecannot be insertedinto exception table oropaque exceptiontable.


ADB_DATA_MERGER_HANDLE_CONTINUE_DATA-100103.

Data Merger Schema

{0} handle {1} of

{2} continue

operation data.

Trace BW-Plugin Displays which data isbeing processedfurther for bulk inserterror handling.


161



ADB_DATA_MERGER_FINISH_BULK_INSERT_ERROR_EXCEPTION-100104.

Data Merger Schema

{0} finish handle

bulk insert error

exception.

Trace BW-Plugin When finish handlingbulk insert errorexception.


ADB_DATA_MERGER_HANDLE_CONTINUE_HANDLE_DATA-100105.

Data Merger Schema

{0} continue handle

bulk insert data.

Trace BW-Plugin Continue handle bulkinsert data whileprocessing bulk insertdata error handling.


ADB_DATA_MERGER_HANDLE_BULK_INSERT_ERROR_EXCEPTION-100106.

Data Merger Schema

{0} start handle

bulk insert error

exception.

Trace BW-Plugin Starts handling bulkinsert errorexceptions.


ADB_DATA_MERGER_HANDLE_EXCEPTION_EXECUTE_UPDATE_COUNT-100107.

Data Merger Schema

{0} execute update

count result {1}.

Trace BW-Plugin Displays logs whenupdate count result isexecuted.


ADB_EXCEPTION_DISPLAY_MESSAGE-200003.

Exception :{0}

Debug BW-Plugin Displays the exceptionmessage.

This is a debugmessage andresolution is notapplicable.

ADB_DATA_MERGER_VALIDATION_ERROR-500027.

{0}

Error BW-Plugin Validates the DataMerger with SharedResource and JDBCConnection


162



ADB_DATA_MERGER_INPUT_ERROR-500028.

{0}

Error BW-Plugin Displays error if erroroccurs while readinginput data.


ADB_DATA_MERGER_UNKNOWN_ERROR-500029.

Activity {0} failed

due to unknown error

in the process {1}.

Error BW-Plugin Fails due to unknownerror in the process.


ADB_DATA_MERGER_BEGIN_TRANSACTION_FAILED_MSG-500030.

Data Merger Schema

{0} throw exception

{1} when begin

transaction.

Error BW-Plugin Throws error whenfails to begintransaction.


ADB_DATA_MERGER_ROLLBACK_TRANSACTION_FAILED_MSG-500031.

Data Merger Schema

{0} throw exception

{1} when roll back

transaction.

Error BW-Plugin Throws error whenfails to roll back thetransaction.


EXCEPTION_OCCURED_RETRIEVE_RESULT-500032.

IOException occurred

while retrieving XML

Output.

Error BW-Plugin Throws error whenIOException occurswhile retrieving XMLoutput.


ADB_DATA_MERGER_PRINT_STMT_SQL-100108

Data Merger Schema

{0} statement SQL:

\n\t

\u0020\u0020\u0020-

\u0020{1}\n\t

Trace BW-Plugin Displays the SQLstatement.


163



ADB_DATA_MERGER_CREATE_STMT - 100109

Data Merger Schema

{0} create

statement.\n\t

Trace BW-Plugin When the SQLstatement is created.


ADB_DATA_MERGER_BIND_STMT - 100110

Data Merger Schema

{0} bind statement.

\n\t

Trace BW-Plugin When the SQLstatement is binding.


ADB_DATA_MERGER_EXECUTE_STMT -100111

Data Merger Schema

{0} execute

statement.\n\t

Trace BW-Plugin When the SQLstatement is executed.


164


Documents

TIBCO ActiveMatrix BusinessWorks Plug-in for …...The plug-in supports capturing of change data (insert, update, or delete data) from and merging change data request into a relational