TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database ...

TIBCO ActiveMatrix BusinessWorks™

Plug-in for Database

User's GuideSoftware Release 8.3.2January 2020

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 OF 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 is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, ActiveMatrix BusinessWorks, Business Studio, TIBCOBusiness Studio, and TIBCO ActiveMatrix BusinessWorks Plug-in for Database are either registeredtrademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

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, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version 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.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

2

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

https://www.tibco.com/patents

Copyright © 1999-2020. TIBCO Software Inc. All Rights Reserved.

3


Contents

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

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

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

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

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Creating a JDBC Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Creating an ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Debugging and Running a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Deploying Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

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

DBPoller Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

DBMerger Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

DBRequester Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Creating a Schema by Using the ADB Configuration Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Adding a Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Adding a Parent Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Adding a Child Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

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

Refresh the Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

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

Adding a Procedure to an RPC Custom Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Table Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Publishing Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Child Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

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

Child Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Opaque Exception Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

ADB Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

Data Event Poller Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Data Merger Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4


Data Requester Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Migrating Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Migrating Projects from Adapter to Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Migrating Active Database Adapter Configuration to JDBC Connection Resource and ADB Configuration Resource in the Plug-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Changes Seen in the Project After Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

Migrating Projects with Adapter Subscriber Activity and Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

Adapter Subscriber Activity Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

Publication Service Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Migrating Projects with Publish to Adapter Activity and Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Publish to Adapter Activity Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Subscription Service Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Migrating Projects with Invoke an Adapter Request-Response Server Activity and Request-Response Service . . . . . . . . . 75

Invoke an Adapter Request-Response Server Activity Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . .76

Request-Response Service Fields Not Supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Working with the Preference File (JSON) for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Output Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

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

Mapping DB2 Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

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

Mapping MySQL Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Mapping Oracle Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Mapping PostgreSQL Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

Mapping Sybase Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Mapping Teradata Datatype to XSD Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

Enabling Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88

Disabling Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Unlocking the MUTEX Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Viewing Client Information Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

Refactoring a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Error Handling by Data Merger Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90

Normal Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

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

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

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

Entity Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

5


Configuring Sybase Database by Using Custom JDBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Configuring Teradata Database by Using Custom JDBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Deploying an Application with Teradata Database Through CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Hints Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106

Log Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

6


Figures

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

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

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

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

Data Event Poller: Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

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

Data Merger Activity: Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Data Merger Activity: Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Data Merger Activity: Fault Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Data Requester Activity: General Tab: Request Reply Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Data Requester Activity: General Tab: RPC Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Data Requester Activity: General Tab: RPC Mode with Custom Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

Data Requester Activity: Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Data Requester Activity: Input Tab with Request Reply Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_EXECUTE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_BATCHEXECUTE) . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Data Requester Activity: Input Tab with RPC Mode (Operation: Custom Operation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Data Requester Activity: Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Data Requester Activity: Output Tab with Request Reply Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_EXECUTE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_BATCHEXECUTE) . . . . . . . . . . . . . . . . . . . . . . . . 67

Data Requester Activity: Output Tab with RPC Mode (Operation: Custom Operation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Data Requester Activity: Fault Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Setting Custom Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Driver Details and User Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94

Test Connection Pop-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94

Plug-in Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Setting Custom Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Custom Driver Runtime Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Java File to be Edited . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

Debug Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

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.

Product-Specific Documentation

The following documents for this product are available on the TIBCO ActiveMatrix BusinessWorks™Plug-in for Database Product Documentation page.

● 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 Examples

● 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

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

Plug-in 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. It also supports submitting oneor more SQL statements, stored procedures, and functions, and getting a reply. The plug-in supportsJDBC-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, Microsoft Azure SQLServer, Sybase, and Teradata.

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, anddata of other columns is retrieved through the table's join operation.

● Publish the data of a child table. (The Publish Child Data option).

● Order the data of the child table in ascending or descending order. (Child Table Order By option).

● Receive confirmation on event consumption (configured by using the Confirmer activity) andchange the record status to completed (C).

● Specify the maximum number of database records to be published per event to start anActiveMatrix BusinessWorks™ job. (Record per event option).

● Specify a Polling Interval and the maximum number of records to be retrieved for each pollingwhen a polling batch is used. (Polling Interval (ms) and Batch Size (Max Rows) options).

● Improve the performance in a high-load scenario by using load balancing. Load balancingdistributes the workload across application nodes.

● Insert, delete, and update records in the parent and child tables.

● Republish records with status as failed, scheduled, or pending (Failed (F) Records, Scheduled (S)Records, and Pending (P) Records options).

● Specify the schema mapping options for design time and runtime (Design Time and Runtimeoptions).

● Improve the performance of queries by using hints for Oracle and MSSQL databases.

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 the exception table and the opaque exception table.

● Specify the 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 InsertSize” 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).

9


● Specify the schema mapping options for design time and runtime (Design Time and Runtimeoptions).

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

● Submit and run one or more SQL statements, stored procedures, and functions.

● Process the requests and return the result as a reply.

These features can be implemented by 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)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 the stage table at a specifiedinterval.

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

● Data Requester - You can use this activity to submit and run one or more SQL statements, storedprocedures, and functions. The result is returned as a reply.

10


Comparison between Adapter and Plug-In

For users who have previously used the ActiveMatrix® Adapter for Database, this topic explains thedifferences in the plug-in where supported features have overlap with adapter.

FeatureActiveMatrix® Adapter forDatabase

ActiveMatrixBusinessWorks™ Plug-in forDatabase

Services Provided Publication service,Subscription service and RPCservice, and Alerter Service

The plug-in is a replacement ofthe ADB Adapter and AEPalette available inActiveMatrix 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.

The Data Requester activity isequivalent to the adapter'sRequest-Reply service. Itallows an application to submitone or more SQL statements,stored procedures, andfunctions to be processed.

Transport Type JMS and Rendezvous The plug-in is native toActiveMatrix BusinessWorksand does not requiremessaging.

Message Format The ADB Adapter is developedby using Adapter SDK librariesand outputs the message byusing AE Schema.

The plug-in is native toActiveMatrix BusinessWorksand 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

11




Stage Table Yes Yes

Triggers Generation Direct apply/SQL statementgenerated

or

save generated SQL into file

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 or by everyactivity invocation.

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 Yes

Database vendors● IBM DB2

● Microsoft SQL Server

● MySQL

● Oracle Database

● PostgreSQL

● Sybase

● Teradata

● IBM DB2

● Microsoft SQL server

● MySQL

● Oracle Database

● PostgreSQL

● Sybase

● Teradata

Database Driver support● Native Database Drivers

supported

● DataDirect Driverssupported

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

● DataDirect Driverssupported.

12




Set Database client information Yes Yes

Publish Batch confirm size/timeout

Yes No

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 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 ActiveMatrixBusinessWorks engine andActiveMatrix BusinessWorksprocess 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 beforecommitting a transaction.

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 differentActiveMatrix BusinessWorksprocess jobs or ActiveMatrixBusinessWorks process nodesare packed as batches.

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

Request Reply A request can contain one ormore SQL statements, storedprocedures, functions, orpackages to be executed as atransaction. The text of the SQLstatement follows theconventions for JDBC SQLsyntax. All SQL statementssupported by the DBMS areallowed and placeholders,represented by a question mark(?), are permitted in the SQLstatement. The SQL statementsconform to the JDBC rules. Forperformance reasons, it is goodpractice to use a SQLstatement. The ‘?’ conventionmust only be used to bindbinary data or call storedprocedures.

A response from the adapter toa client application has a resultcode and one or more resultsets. Each result set containsnested self-describingmessages. Each of thesemessages encodes a result rowthat returned after executing aquery. A response can alsoreturn an error code and errordescription if the request is notsuccessful.

Yes

15




Remote Procedure Call (RPC) The adapter can be configuredto act as a remote procedurecall (RPC) server on behalf of aclient.

Yes

RPC Standard Operation(SQL_EXECUTE)

SQL_EXECUTE takes a singleSQL statement and processes it.

Yes

RPC Standard Operation(SQL_BATCHEXECUTE)

SQL_BATCHEXECUTE takes asequence of SQL statementsand processes them.

Yes

RPC one way messaging Yes No

Maximum rows Specifies the maximum numberof rows to be fetched at theservice level. This can be usedto limit the memory usage ofthe adapter. The unfetchedrows are ignored by theadapter.

Yes

Statement Cache The number of cachestatements for a generic RPCrequest/reply service.

The number of statementscached by the adapter isexecuted directly for repeatedrequests. If the cache is full, theadapter removes the oldestmessage from the cache andadds the new statement.

The default value is 1.

The size of the cache dependson the number of statementsprovided as input.

16


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.

ActiveMatrix BusinessWorks uses the Eclipse GUI provided by TIBCO Business Studio™ to definebusiness processes and generate Enterprise Archives (EAR files). The EAR file is deployed and run inthe ActiveMatrix BusinessWorks runtime, and also is managed by using TIBCO® EnterpriseAdministrator (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 ActiveMatrix BusinessWorks. Anapplication module is a resource unit that is named, versioned, and packaged as a part of theapplication.

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. For more information, see the TIBCOActiveMatrix BusinessWorks documentation.

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.

17


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.

18


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.

19


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.

20


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 the DataMerger activity as described in Data Merger Activity.

7. Configure the DataRequester activity as described in Data Requester Activity.

An ADB Configuration shared resource is required when configuring the activities. Formore information about how to create the shared resource, see Creating an ADBConfiguration Shared Resource

8. Click File > Save to save the project.

21


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. For details, see Log Management.

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. For details, see Log Management.

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:

22


● 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. For more information on this, see the TIBCO ActiveMatrixBusinessWorks Administration documentation.

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.

23


ADB Configuration Shared Resource

You can use the ADB Configuration shared resource to establish a connection from the ActiveMatrixBusinessWorks Plug-in for Database 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 by 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

● Schemas

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.

ADB Configuration shared resource: Connection Page

The Connection page consists of two sections:

● General

● Configuration

24


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.

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.

Schemas Page

The type of service and the associated tables to generate XSD schema and database triggers are definedon the Schemas page.

25


ADB Configuration shared resource: Schemas Page

The Schemas section on the left lists the schema type. You can add or remove schemas. You can add thefollowing schema types:

● DBPoller

● DBMerger

● DBRequester

When a new DBPoller, DBMerger, or DBRequester schema is added, a corresponding section isdisplayed on the right and consists of different tabs corresponding to the activity. The followingsections describe the fields on these tabs for each activity:

● DBPoller Schema

● DBMerger Schema

● DBRequester Schema

DBPoller SchemaWhen you create a new DBPoller schema, a corresponding section is created on the Schemas page.

Tabs on the Schemas Page

The Schemas page consists of the following tabs:

● Configuration

● Schema

● Options

● Child Table Order By

● DB2

The Configuration tab contains the following fields:

26


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

27



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.

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 set 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:

28


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.

29



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 by Using the ADB Configuration SharedResource.

Publish ChildData

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

The default is true.

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.

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 for the Data Event Poller activity:

30


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.

Select Columns The Order By Clause column cannot be edited; you can add the fields of thetable by selecting them by 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.

When you use the DB2 connection, the DB2 tab is available on the Schemas page. The DB2 tab containsthe following fields for the Data Event 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.

DBMerger SchemaWhen you create a new DBMerger schema, a corresponding section is created on the Schemas page.



32


● Configuration

● Schema

● Options

● Child Exception Table Mapping

● DB2

The Configuration tab contains the following fields:

Shared Resource > Schemas Page > Configuration Tab


Name No You can update the schema name.


Description No A short description for the schema.

The Schema tab contains the following UI options:

33


Shared Resource > Schemas Page > Schema Tab


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.

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 set 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 Merger activity:

34


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 Exception Table Mappings tab to create a child exception table.

The Child Exception Table Mappings tab contains the following fields:

35


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.

When you use the DB2 connection, the DB2 tab is available on the Schemas page. The DB2 tab containsthe following fields for the Data Merger activity:

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.

DBRequester SchemaWhen you create a new DBRequester schema, a corresponding section is created on the Schemas page.



● Configuration● Schema

The Configuration tab contains the following fields for the Data Requester activity:

36


Shared Resource > Schemas Page > Configuration Tab for Data Requester activity

Field Description

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

Description Description of the table.

Mode The mode of operation - Request-Reply or Remote Procedure Call.

Use CustomOperations

Enable creating custom schema for your operations.

Displayed only when the mode is RPC.

The Schema tab is displayed for both - the Request Reply and RPC modes. However, the AddOperation button is enabled only when the mode is RPC and a custom operation is selected. TheRefresh button is enabled only when the mode is RPC, a custom operation is selected, and theoperation is added by using the Add Operation button. The Schema tab contains the following UIoptions:

37


Shared Resource > Schemas Page > Schema Tab for Data Requester activity


Add a stored procedure.

Reflect the changes made in the stored procedures added earlier anddisplays a newly added procedure.

Creating a Schema by Using the ADB Configuration Shared ResourceYou can use the ADB Configuration Shared Resource to create a schema to use in the processes youcreate by using the activities provided by this plug-in.

Adding a Shared ResourcePerform the following steps to add a shared resource for the DataEventPoller activity, DataMergeractivity, and the DataRequester activity.

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, DBMerger, or DBRequester as required, and then clickAdd. As soon as a new DBPoller, DBMerger, or DBRequester schema is added, a correspondingsection is created on the right.

38


The schema for DataRequester activity has the following modes:

● Request Reply mode takes a sequence of statements as a request and replies back toactivity as output.

● Remote Procedure Call (RPC) mode can be used to configure the plug-in to act asremote procedure call server on behalf of a client.

Adding a Parent Table

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

You can add a parent table only to DB Poller and DB Merger schemas. To add a parent table from theconnected Database (through JDBC connection) for the DataEventPoller activity and the DataMergeractivity:

Procedure

1. On the ADB Configuration page, navigate to the Schemas > Schema tab.

2. Click Add table . The Select Table wizard is displayed.

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

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

All the tables available in the specified schemas are displayed.

39


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

Adding a Child TableYou can add a child table only to DB Poller and DB Merger schemas. To add a child table from theconnected Database (through JDBC connection) for the DataEventPoller activity and the DataMergeractivity:

40


Procedure


2. Select the parent table and click Add Child table .

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

3. Fetch the table and click Finish.

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

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 by using Join To for the DataEventPolleractivity and the DataMerger activity. For applying a Join To relation between a parent and child table,you must set at least one field as the User Key in the child table or clear the Allow Key Columns checkbox.

Procedure

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

41


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.

42


Refresh the Schema

Refresh the existing schema or change the columns used, by using Refresh Schema from DB .

Specifying the Columns of an Order By Clause for a Child TableWhen a child table is added to a parent table, it is displayed on 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. To specify the columns of an Order By clause for a child tablefor the DataEventPoller activity and the DataMerger activity:

Procedure


2. Click Select Columns on the Child Table Order By tab.The Select Child Table Order By Columns wizard opens.

43


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

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

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

5. Click Finish.

Adding a Procedure to an RPC Custom OperationTo add a procedure to an RPC custom operation:

Procedure

1. In the ADB Configuration window, select DBRequester and add a schema with RPC mode.

2. Select the Use Custom Operations check box.

3. On the Schema tab, click Add Operation .

The Select Stored Procedure window is displayed. By default, the Operation Name field displays allthe procedures from the default schema that you have specified on the Operation Name tab.

44


4. In the Select Stored Procedure dialog box, specify Operation Name.

● To select the default procedure (Operation Name), click Fetch and then click Finish.

● To select another procedure, set the filters as required and click Finish.

Hint: You can click Reset to clear existing data and select another operation name and filters.

The operation you select is displayed on the Schema tab.

5. Optional: Set filters as required to fetch the procedure and click Finish.

6. To select a different operation name and filters, click Reset.The operation you selected is displayed on the Schema tab.

45


Table ReferenceWhen ActiveMatrix BusinessWorks Plug-in for Database publishes data to or retrieves data from asource 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 detectnew 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.

46



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

47



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.

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.

48


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.

ADB_MSG BLOB Raw bytes of the message.

The default column size is 1 M.

49


ADB Palette

ActiveMatrix BusinessWorks Plug-in for Database achieves its functionality with the help of Data EventPoller activity, Data Merger activity, and Data Requester activity.

The Data Event Poller Activity, Data Merger Activity and the Data Requester Activity use the ADBConfiguration shared resource created 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 ActiveMatrix BusinessWorks Plug-in for Database must berefactored. 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 has the following fields:

Field

Literal Value/ProcessProperty/ModuleProperty? Description

Name No The name to be displayed as the label for the activity inthe process.


ConfigurationResource

Yes Shared configuration resource containing informationabout the ADB Configuration connection.

50


Field


Schema No The DBPoller schema which is configured with theschema table is based on the XSD generated by theDBPoller schema.

● Apply Trigger: Applies the trigger script to thedatabase.

● Generate Trigger: Saves the trigger script to a specificfile and 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 thespecified location:

— An SQL file containing the script for triggering thedatabase

— A cleanup SQL file which contains a script toclean up created publishing table, triggers,sequences, and so on.

The filenames are created based on the name of theschema.

You cannot apply or generate the trigger if youare offline; you must be connected to thedatabase to fetch table metadata.

AcknowledgmentMode

No Mode of acknowledgment of the activity.

● Client: The Data Event Poller activity waits for theconfirmation and the delivery status of the records ischanged to P. After you get the confirmation, thestatus changes to C.

● Auto: The Data Event Poller activity does not wait forconfirmation and changes the delivery status directlyto C.

Description

Provide a short description for the activity.

Advanced

This tab has the following fields:

51


Data Event Poller: Advanced Tab

Field


Sequence Key No This field can contain an XPath expression that specifiesthe processes that must 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 ActiveMatrixBusinessWorks job. The default value is 1.

Polling Interval(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.

Read Commit(DB2/Teradata)

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.

Hints (Oracle/MSSQL)

Yes Hints help improve the performance of your queries.

When Data Event Poller activity executes a polloperation to fetch data from a table, using hints greatlyenhances the performance.

52


Field


Load Balancing Options

Enable LoadBalancing

Yes Load balancing distributes the workload acrossActiveMatrix BusinessWorks Application nodes toimprove the performance in a high-load scenario.ActiveMatrix BusinessWorks Application nodes withthe same mutex name are in the same load balancegroup.

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

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.

Pending (P)Records

Yes If this check box is selected, records that have a pendingstatus are republished when the application is 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.

53


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

Fault

Data Event Poller Activity: Fault Tab

The Fault tab lists the following errors that might occur when you use 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.

54


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:

Field


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



Yes Shared configuration resource containing information aboutthe ADB Configuration connection.

Schema No The DBMerger schema which is configured with the schematable is based on the XSD generated by the DBMergerschema.

● 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 cleanup the 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


55


Advanced

Data Merger Activity: Advanced Tab


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

56


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.

57


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.

58


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



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



Data Requester ActivityThe Data Requester activity allows an application to submit one or more SQL statements, storedprocedures, and functions to be processed. The plug-in processes the request and returns the results asa reply.

General

The General tab contains the following fields:

Data Requester Activity: General Tab: Request Reply Mode

59


Data Requester Activity: General Tab: RPC Mode

Data Requester Activity: General Tab: RPC Mode with Custom Operations

The RPC custom operations schema is used when you want to integrate with third-party applications todescribe the actual input and output values of a database operation or a stored procedure. You can usethe RPC custom operation mode to define your operations and specify the stored procedures to be runat design time.

Field


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



Yes Shared configuration resource containing information aboutthe ADB Configuration connection.

Schema No The DBRequester schema which is configured with RequestReply mode or Remote Procedure Call (RPC) mode.

The Request Reply mode takes a sequence of statements as arequest and sends the reply back to the reply subject.

The RPC mode is used to configure the plug-in to act as aremote procedure call server on behalf of a client.

Same procedure name cannot be used within andacross schemas.

60


Field


Operation No Type of RPC operation.

● RPC Standard operation

— SQL_EXECUTE - A single SQL statement isprocessed.

— SQL_BATCHEXECUTE - A sequence of SQLstatements is processed.

● RPC Custom operation

If you have configured custom operations and storedprocedures in the ADB Configuration resource, a list ofthose stored procedures is displayed. You can select anyone of them.

Description


Advanced


Data Requester Activity: Advanced Tab

Field


Operation Options

Maximum Rows Yes Specifies the maximum number of rows to be fetched.This can be used to limit the memory usage of the plug-in. The unfetched rows are ignored by the plug-in.

At run time, the plug-in fetches the number of rowsaccording to the value set in the operation level insteadof the service level.

61


Field


Statement Cache Yes The number of cache statements for a generic RPCrequest/reply service.

The size of the cache depends on the number ofstatements provided as input.

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.

Input

This tab displays the input schema.

Data Requester Activity: Input Tab with Request Reply Mode

62


Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_EXECUTE)

To execute multiple SQL statements, you must provide the input as multiple item elements forstatements with their individual SQL string as can be seen in the following image:

Data Requester Activity: Input Tab with RPC Mode (Operation: SQL_BATCHEXECUTE)

Input Schema Description

Fields for the Request Reply mode:

Field Description

MAXROWS The maximum number of rows to retrieve.

SQL_STRING The SQL string used to specify the SQL statement to be executed.

CLOSURE Closure argument. The reply returns this closure argument untouched.

POSITION Specify the index of the input parameter to bind the input data.

63


Field Description

NAME● Specify the column name from the database table if binding either of the

following data types: DATE, TIME, TIMESTAMP, BINARY, and BLOB.

● Specify the column name from the database table if you are using theBIND variable to pass parameters to the SELECT statement for Sybasedatabase.

PARAMTYPE Specify if the parameter is the INPUT parameter or OUTPUT. Use IN/OUT.

DATA Specify the input data to bind to the input parameter in the SQL String.

Data Requester Activity: Input Tab with RPC Mode (Operation: Custom Operation)

Fields for the RPC mode:

Field Description

MAXROWS The maximum number of rows to retrieve.

SQL The SQL string used to specify the SQL statement to be executed. This stringis automatically generated by the palette.

CACHE True if users want the agent to cache the statement for performanceoptimization.

PACKAGE Read only. Uses the call operation form to modify the package of the storedprocedure.

SCHEMA Read only. Uses the call operation form to modify the schema of the storedprocedure.

INBINDS Input parameters of the stored procedure.

Output

This tab displays the output schema.

64


Data Requester Activity: Output Tab

65


Data Requester Activity: Output Tab with Request Reply Mode

66


Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_EXECUTE)

Data Requester Activity: Output Tab with RPC Mode (Operation: SQL_BATCHEXECUTE)

67


Data Requester Activity: Output Tab with RPC Mode (Operation: Custom Operation)

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

Field Description

STATUS SUCCESS if the stored procedure or SQL statement is executed successfully.

FAILURE if an error occurs. Error details are stored in the ERROR_DESCfield.

SQL The SQL string used to specify the SQL statement to be executed.

ERROR_DESC In case if the status is FAILURE, error description is stored here.

CLOSURE Closure argument obtained from the request.

OUTBINDS The output parameters of the stored procedure.

RESULTSETS The result set(s) returned by the stored procedure or SQL statement.

Fault

Data Requester Activity: Fault Tab

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

68




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



69


Migrating Projects

You can migrate a project that is created by using TIBCO ActiveMatrix® Adapter for Database 7.2.0 andActiveMatrix BusinessWorks 5.x project created in TIBCO Designer™ to ActiveMatrix BusinessWorks6.x or TIBCO BusinessWorks™ Container Edition by using the migration tool in TIBCO Business Studio.

You must use the migration tool to migrate projects to ActiveMatrix BusinessWorks Plug-in forDatabase. Migration is supported for the following project specifications:

Project Specification Supported for Migration To

Projects created in ActiveMatrix® Adapter forDatabase 7.2.0 ● ActiveMatrix BusinessWorks 6.x

● TIBCO BusinessWorks Container EditionActiveMatrix BusinessWorks 5.x projects createdin TIBCO Designer

Migration Restrictions

● You can migrate ActiveMatrix BusinessWorks 5.x projects to ActiveMatrix BusinessWorks 6.x.However, you cannot migrate version 6.x projects to version 5.x.

● Migration is based on the information received from the adapter palette activities.

Considerations When Migrating Projects

● To avoid post migration issues, ensure that correct connection parameters are provided in theproject or in the JSON reference file at the time of migration.

● Ensure that your user workspace is the same as the ActiveMatrix BusinessWorks 6.x target directory(the location where you want to migrate the projects). When running the command for migrationfrom the CLI, migration fails if the user workspace directory and the ActiveMatrix BusinessWorks6.x target directory are not the same. For example, bwmigrator.exe -data <user workspace> -projectDir <BusinessWorks 6.x target directory> <BusinessWorks 5.x project

location>.

● Global variables are migrated to ActiveMatrix BusinessWorks 6.x project only if they are created inActiveMatrix BusinessWorks 5.x project and are referred in one of the ActiveMatrix BusinessWorks5.x projects or are mentioned in the JSON reference file as a global variable.

● If there is an ActiveMatrix BusinessWorks 5.x generic activity that uses the Database Adapter AEschema in the ActiveMatrix BusinessWorks 5.x project, after migration you must manually correctthe ActiveMatrix BusinessWorks 6.x generic activities to use the plug-in activity schema.

● Migration requires online schema, which means it retrieves the schema from the Database serverduring migration for the respective activity.

● After migration, you might notice some additional files (such as ae folder and ae2xsd.xsd file inthe Schemas folder and the AESchemas folder) that you do not require. Ignore such files.

● A validation error occurs in the migrated ActiveMatrix BusinessWorks 6.x project when oneActiveMatrix BusinessWorks 5.x project is saved with two different names and both the projects aremigrated to the plug-in. To resolve this issue, delete the Namespaces/Imports from Process >Dependencies.

It is recommended to review the TIBCO ActiveMatrix BusinessWorks 6.x Migration guide for additionalinformation such as naming conventions, and more.

70


Migrating Projects from Adapter to Plug-InYou can migrate ActiveMatrix® Adapter for Database projects (created in TIBCO Designer) toActiveMatrix BusinessWorks Plug-in for Database in the following manner:

Procedure

1. In TIBCO Business Studio, go to Project > Migrate BW Projects.

2. In the Project Migration Wizard, to migrate multiple 5.x projects, select the Migrate MultipleBusinessWorks 5.x Projects option.

Only shared resources and schema files can be migrated as a shared module. The Migrateas Shared Module check box does not apply to event source activities.

3. In the Select Project Location section, click Browse to add the location to the Select Project(s) to beMigrated field and select the project you want to migrate.

4. Select the migrated project location by clicking Browse next to the Select Migrated Project Locationfield.

5. Click Migrate Project.6. Click Start Migration.

In ActiveMatrix BusinessWorks 6.5.0 and later, skip this step.

7. After the migration is completed, click Finish.

Migrating Active Database Adapter Configuration to JDBC ConnectionResource and ADB Configuration Resource in the Plug-In

You can migrate Active Database Adapter configuration from ActiveMatrix® Adapter for Databaseprojects created in the TIBCO Designer to JDBC connection resource and ADB configuration resource inActiveMatrix BusinessWorks Plug-in for Database in the following manner:

Procedure

1. In TIBCO Business Studio, go to Project > Migrate BW Projects.

2. In the Project Migration Wizard, the default selection is Migrate Single BusinessWorks 5.x Project.Select the Migrate as Shared Module check box to migrate the 5.x project as a shared resource.

Only shared resources and schema files can be migrated as a shared module. The Migrateas Shared Module check box does not apply to event source activities.

3. In the Select Project Location section, click Browse to add the location to the Select Project(s) to beMigrated field and select the project you want to migrate.


5. Click Migrate Project.6. Click Start Migration.

In ActiveMatrix BusinessWorks 6.5.0 and later, skip this step and click Finish.

7. After the migration is completed, click Finish.

Changes Seen in the Project After MigrationThe following changes are seen in the project after migration:

71


● An additional module property is created for the URL field after migration when the URL is used asa global variable in an ActiveMatrix BusinessWorks 5.x project.

● If the design time and run time connections in the adapter's active database configuration aredifferent, then the JDBC shared resource connection in the plug-in fetches data from the run timeconnection after migration.

Migrating Projects with Adapter Subscriber Activity and Publication ServiceYou can migrate projects that use the Adapter Subscriber from the ActiveEnterprise Adapter paletteand Publication service of ActiveMatrix Database Adapter for Database to the Data Event PollerActivity in ActiveMatrix BusinessWorks Plug-in for Database in the following manner:

Procedure

1. Start TIBCO Business Studio.

2. On the menu bar, click Project > Migrate BW Projects.

3. In the Project Migration Wizard, the default selection is Migrate Single BusinessWorks 5.x Projectin the Migration Project Type section. Click Migrate Multiple BusinessWorks 5.x Projects tomigrate multiple 5.x projects.

4. In the Select Project Location section, click Browse to add the project location to the SelectProject(s) to be Migrated field and select the project you want to migrate.


6. Click Migrate Project.

7. Click Start Migration.


8. After the migration is completed, click Finish.Name of the migrated shared resource is the name of the ActiveDatabase Adapter Configurationand the extension of the shared resource. For example,ActiveDatabaseConfiguration.adbResource.

All the configurations of the Publication service are migrated to the respective fields of DBPoller onthe Schema tab of the ADB Configuration resource.

All the fields of the Adapter Subscriber activity and Publication service are migrated to the General> Advanced tab of the Data Event Poller activity.

On the General tab of the migrated Data Event Poller activity, the migrated shared resource ismapped to the Configuration Resource field. The schema selected in the Publication service ismapped to the schema picker of the migrated Data Event Poller activity.

In the migrated activity, the fields that are not present in the Publication service but arepresent in the Data Event Poller activity have default values. These fields can beconfigured by using the JSON preference file. For more information about the JSONpreference file, see Working with Preference File (JSON) for Migration.

Adapter Subscriber Activity Fields Not Supported for MigrationWhen migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database there are some fields in the Adapter Subscriber activity of the Database AdapterConfiguration that are not supported during migration.

Fields not supported on the Configuration tab

72


The following fields on the Configuration tab of the Adapter Subscriber activity in ActiveMatrixAdapter for Database are not supported:

● Adapter Service

● Custom AESchema

● Custom AESchema Reference

The Transport, Misc, Output, and Error Output tabs of the Adapter Subscriber activity inActiveMatrix® Adapter for Database are not supported for migration.

Publication Service Fields Not Supported for MigrationWhen migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database, there are some fields in the Adapter Services (Publication Service) of the DatabaseAdapter Configuration that are not supported during migration.


The following fields on the Configuration tab of the Publication service in ActiveMatrix® Adapter forDatabase are not supported:

● Transport Type

● Wire Format

● Quality of Service

● Connection Factory Type

● Delivery Mode

● Polling Method

● Use Polling Batch Size

● Publisher Batch Confirm Size

● Publisher Batch Confirm Timeout

● Publish to ActiveSpaces

Fields not supported on the Publisher Options tab

The following fields on the Publisher Options tab of the Publication service in ActiveMatrix® Adapterfor Database are not supported:

● Update Mode

● Enable Loop Detection

● Do Not Generate Triggers

● Enable Group Messaging

● Number of Publisher Service Threads

Fields not supported on the Advanced tab

The following fields on the Advanced tab of the Publication service in ActiveMatrix® Adapter forDatabase are not supported:

● Destination

● Message Subject

● Endpoint Reference

● Class Reference

73


Migrating Projects with Publish to Adapter Activity and SubscriptionService

You can migrate projects that use the Publish to Adapter from the ActiveEnterprise Adapter palette andSubscription service of ActiveMatrix® Adapter for Database to the Data Merger activity inActiveMatrix BusinessWorks Plug-in for Database.

Prerequisites

The following prerequisite applies:

● An ActiveMatrix BusinessWorks 5.x project by using the Subscription service and Publish toAdapter activity must use an event source activity, such as a timer, as a starter activity.

Procedure









8. After migration is completed, click Finish.The name of the migrated shared resource is the name of the Active Database AdapterConfiguration and the extension of the shared resource. (For example,ActiveDatabaseConfiguration.adbResource).

All the configurations of the Subscription service are migrated to the respective fields of DBMergeron the Schema tab of the ADB Configuration resource.

All the fields of the Publish to Adapter activity are migrated to the General > Advanced tab of theData Merger activity.

On the General tab of the migrated Data Merger activity, the migrated shared resource is mappedto the Configuration Resource field. The schema selected in the Subscription service is mapped tothe schema picker of the migrated Data Merger activity.

In the migrated activity, the fields that are not present in the Subscription service but arepresent in the Data Merger activity have default values. These fields can be configured byusing the JSON preference file. For more information about the JSON preference file, see Working with Preference File (JSON) for Migration.

Publish to Adapter Activity Fields Not Supported for MigrationWhen migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database there are some fields in the Publish to Adapter activity of the Database AdapterConfiguration that are not supported during migration.


74


The following fields on the Configuration tab of the Publish to Adapter activity in ActiveMatrix®Adapter for Database are not supported:

● Adapter Service

● Custom AESchema

The Transport, Output, and Error Output tabs of the Publish to Adapter activity in ActiveMatrix®Adapter for Database are not supported for migration.

Subscription Service Fields Not Supported for MigrationWhen migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database there are some fields in the Subscription service of the Database AdapterConfiguration that are not supported during migration.


The following fields on the Configuration tab of the Subscription service of ActiveMatrix® Adapter forDatabase are not supported:

● Transport Type


● Wire Format


● Delivery Mode

● Use Separate Session

Fields not supported for Subscription Options

The following fields on the Subscription Options tab of the Subscription service of ActiveMatrix®Adapter for Database are not supported:

● Reply Sender Quality of Service

● Rendezvous Maximum Queue Size


The following fields on the Advanced tab of the Subscription service of ActiveMatrix® Adapter forDatabase are not supported:

● Destination

● Message Subject


● Class Reference

Migrating Projects with Invoke an Adapter Request-Response ServerActivity and Request-Response Service

You can migrate projects that use the Invoke an Adapter Request-Response Server from the Adapterpalette and Request-Response service of ActiveMatrix® Adapter for Database to the Data RequesterActivity in TIBCO ActiveMatrix BusinessWorks Plug-in for Database.

Prerequisites

The following prerequisite applies:

75


● An ActiveMatrix BusinessWorks 5.x project by using the Request Response service and Invoke anAdapter Request-Response Server activity must use an event source activity (such as a timer) as thestarter activity.

Procedure









8. After migration is completed, click Finish.Name of the migrated shared resource is the name of the ActiveDatabase Adapter Configurationand the extension of the shared resource. For example,ActiveDatabaseConfiguration.adbResource.

All the configurations of the Request-Response service are migrated to the respective fields ofDBRequester on the Schema tab of the ADB Configuration resource.

All the fields of Invoke an Adapter Request-Response Server activity are migrated to the General >Advanced tab of the Data Requester activity.

On the General tab of the migrated Data Requester activity, the migrated shared resource ismapped to the Configuration Resource field. The schema selected in the Request-Response serviceis mapped to the schema picker of the migrated Data Requester activity.

In the migrated activity, the fields that are not present in the Request-Response service butare present in the Data Requester activity have default values. These fields can beconfigured by using the JSON preference file. For more information about the JSONpreference file, see Working with Preference File (JSON) for Migration.

You must specify the schema name while adding the procedure on the Call Operation tab of theRequest-Response service.

Invoke an Adapter Request-Response Server Activity Fields Not Supported forMigration

When migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database there are some fields in the Invoke an Adapter Request-Response Server activity ofthe Database Adapter Configuration that are not supported during migration.


The following fields on the Configuration tab of the Invoke an Adapter Request-Response Serveractivity in ActiveMatrix® Adapter for Database are not supported:

● Adapter Service

● One Way

76


The Transport, Output, and Error Output tabs of the Invoke an Adapter Request-Response Serveractivity in ActiveMatrix® Adapter for Database are not supported for migration.

Request-Response Service Fields Not Supported for MigrationWhen migrating projects from ActiveMatrix® Adapter for Database to ActiveMatrix BusinessWorksPlug-in for Database there are some fields in the Request-Response Service of the Database AdapterConfiguration that are not supported during migration.


The following fields on the Configuration tab of the Request-Response Service in ActiveMatrixBusinessWorks Plug-in for Database are not supported:


● Transport Type

● Wire Format


● Delivery Mode

● Use Separate Session


The following fields on the Advanced tab of the Request-Response Service in ActiveMatrixBusinessWorks Plug-in for Database are not supported:

● Destination

● Message Subject


● Class Reference

Working with the Preference File (JSON) for MigrationWhen you want to migrate a project created in ActiveMatrix BusinessWorks 5.x to a ActiveMatrixBusinessWorks 6.x or TIBCO BusinessWorks Container Edition and use the feature of preferences thenyou must create a adapter2plugin.json file in the root folder of ActiveMatrix BusinessWorks 5.xproject.

All the property values that you provide in the TRA file for a ActiveMatrix BusinessWorks 5.x project,are not migrated with the project. You must therefore provide all these property values in a preferencefile. This preference file is in JSON format. A template of the preference file is installed in the toolsfolder of the plug-in at the following location:

TIBCO_HOME/bw/palettes/adb/version/tools/adapter2plugin.json_template

You can also use the preference file to:

● Override the configuration defined in the ActiveMatrix BusinessWorks 5.x project and the adapterservices that are carried over to the plug-in.

● Provide the configuration available in the plug-in but not available in the ActiveMatrixBusinessWorks 5.x project.

77


● You must use the JSON preference file template provided in the tools folder for reference only.Copy the template file from the tools folder and paste in the root directory of the project asadapter2plugin.json. Then edit the preference file and provide the necessary properties and theircorresponding values.

The values can be literals or references to module properties that pertain to global variables in theActiveMatrix BusinessWorks 5.x project.

● The file created under the root folder of the ActiveMatrix BusinessWorks 5.x projects does notcontain only the Database plug-in but also other plug-ins that support adapter migration.

Note the following points prior to using the JSON preference file for a ActiveMatrix BusinessWorks5.x project:

● The location and filename of the adapter2plugin.json preference file is not configurable.

● The usage of the preference file does not support the creation of new module properties in migratedprojects. For example, you must not specify a module property %%test%% in the preferences if itdoes not exist as a global variable in the ActiveMatrix BusinessWorks 5.x project.

● Properties provided in the preference file take priority. Therefore, if you have provided the value ofa field and also provided a value for the same field in the preference file, the value in the preferencefile is given priority.

● The following table names are declared in the preference file and also as global variables. These arenot migrated as module properties in the plug-in:

— A publishing table

— An exception table

— An opaque exception table

● The usage of preference file is applicable to all adapter configurations in the ActiveMatrixBusinessWorks 5.x project during migration.

● Since the module properties in ActiveMatrix BusinessWorks 6.x project are case sensitive, themodule properties in the preference file must have the same case as the ActiveMatrixBusinessWorks 5.x project.

● When any value is applied from the preference file, the MigrationReport.log contains logs withkey and value in uppercase.

● You must obfuscate the password used in the JSON file. Use the bwobfuscator utility in the<TIBCO_HOME>/bw/version/bin folder to obfuscate the password. Any other password obfuscatorsdo not work. For more information about how to use the bwobfuscator, see the TIBCOActiveMatrix™ BusinessWorks Application Development guide.

To configure as a literal value:

To set the value of Default Schema on the Connection tab of ADB Configuration as xyz in the JSONfile, set the value as

"defaultSchema" : "xyz"

To configure as a module property:

To use a module property in the JSON file, you must first declare a global variable with the same nameand a value in the ActiveMatrix BusinessWorks 5.x project and then add the module property to theJSON file.

To set the value of Default Schema on the Connection tab of ADB Configuration as a global variable,add the global variable in the ActiveMatrix BusinessWorks 5.x project as defaultSchemaGV and set itsvalue as xyz. Now, in the JSON file, set the value as

"defaultSchema" : "%%defaultSchemaGV%%"

78


An ActiveMatrix BusinessWorks 5.x project is migrated only if you provide correct values in the JSONpreference file. Otherwise, an error occurs when you run the project.

79


Advanced Topics

When you use ActiveMatrix BusinessWorks Plug-in for Database, you can use advanced configurationand 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

● Configuring Sybase Database by Using Custom JDBC driver

● Configuring Teradata Database By Using Custom JDBC Driver

● Deploying an Application with Teradata Database Through CLI

● Hints Usage

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

80


Adapter AE Datatype Plug-in XSD Type

binary base64Binary

string string

adbDateTime string

Mapping DB2 Datatype to XSD Type

Database Type XSD Type

integer double

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

81


Mapping Microsoft SQL Server Datatype to 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

82


Mapping MySQL Datatype to XSD Type


bigint long

bigint unsigned double

binary base64binary

bit base64binary

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

83



tinyint int

tinyint unsigned int

tinytext string

varbinary base64binary

varchar string

year string

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

84


Database Type XSD TypeCases for Numeric andNumber

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

85


Mapping Sybase Datatype to XSD Type


binary base64Binary

bit int

char string

datetime string

decimal double

float double

int double

money double

numeric double

real double

smalldatetime string

smallint int

smallmoney double

tinyint int

varbinary base64Binary

varchar string

Mapping Teradata Datatype to XSD Type


integer int

real double

char string

date string

decimal double

numeric int

86



float double

smallint int

time string

time with timezone

string

timestamp string

timestamp withtime zone

string

byte base64Binary

varbyte base64Binary

byteint int

varchar string

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 ActiveMatrix BusinessWorks, refer to the TIBCOActiveMatrix BusinessWorks™ Administration guide.

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.

87


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 statuschanges from N to S, the MUTEX table releases the lock from the table. If you try to forcefullyshutdown the application node, the MUTEX table gets locked and the configurations associated withMUTEX table do not work. To release a lock on a MUTEX table, manual intervention is required.

Only Database Administrators can execute the scripts to unlock the MUTEX table. The administratorsmust fetch the ID and serial number of the locked session and then terminate the particular session thathas acquired the lock. See the examples for Oracle and Microsoft SQL Server databases for details.

Unlocking the MUTEX Table: Example for Oracle Database

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);

88


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

Unlocking the MUTEX Table: Microsoft SQL Server Database

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

89


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:

90


● 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 supports the Oracle and MSSQL databases only.

● 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 an 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 M4) 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.

91


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(_).

92


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.

Configuring Sybase Database by Using Custom JDBC DriverYou can configure Sybase Database by using the custom JDBC driver.

Procedure

Follow the same steps to configure the Sybase database by using JDBC custom driver onTIBCO BusinessWorks™ Container Edition Studio.

1. In TIBCO Business Studio, go to Windows and click Preferences.

2. Select the option Allow use of custom driver under BusinessWorks > Palettes > JDBC, click Apply,and then click OK.

Setting Custom Driver

3. Create a new JDBC connection resource and select custom.jdbc.driver from the Database Driver list.Enter the Driver details and user credentials in the project that you have created.

93


Driver Details and User Credentials

4. Click Test Connection. A pop-up window is displayed.

Test Connection Pop-up

5. Click OK. A new Plug-in Project with a prepopulated project name is displayed. Click Next.

94


Plug-in Details

6. Click Finish. A custom project is created in the workspace named ascom.tibco.custom.driver.project.name with compilation errors.

Errors

7. Go to JDBC connection resource and click Test Connection again. A connection is establishedsuccessfully.

95


JDBC Connection

After the connection is established successfully, delete the custom plug-in project"com.tibco.custom.driver.project.name" from the workspace that was created earlier and run theactivity. The activity runs successfully.

If the custom project is not present in the workspace and if you click again on the TestConnection button in the JDBC Connection shared resource, then every time the customproject is created in the workspace as mentioned in the steps in this section. You have todelete the same custom project before running the activity.

Configuring Teradata Database by Using Custom JDBC DriverYou can configure Teradata Database by using a custom JDBC driver.

If you are using the Data Merger or Data Requester activities, you can insert maximum 16 records inthe Teradata database concurrently.

Procedure

Follow the same steps to configure the Teradata database by using JDBC custom driver onTIBCO Business Studio (Container Edition).

1. In TIBCO Business Studio, go to Window > Preferences.

2. In the left pane, under BusinessWorks > Palettes > JDBC, set the directory preference as follows:TIBCO_HOME/bw/version_number/config/design/thirdparty.

3. Select the option Allow use of custom driver, click Apply, and then click OK.

96


Setting Custom Driver

4. Copy the TeraData JDBC server jar files such as terajdbc4.jar and tdgssconfig.jar to thedirectory preference location selected in the earlier step.

5. If you have already configured the JDBC driver, skip this step. Otherwise, restart TIBCO BusinessStudio

6. Create a JDBC connection. Use the driver details and user credentials as follows:

● Database Driver: custom.jdbc.driver

● Database URL: jdbc:teradata://<host>/database=<db_name>, TMODE=<mode>

● Database Driver: com.teradata.jdbc.TeraDriver

● Database Name: <db_name>

● Jar File: terajdbc4.jar,tdgssconfig.jar

Ensure that there is no whitespace in the database URL and in the comma separated list ofJAR files.

97


JDBC Connection

7. Click Test Connection.The Custom Driver Runtime Support pop-up window is displayed. Click OK.

Custom Driver Runtime Support

A new plug-in project is created.

8. In the New Plug-in Project window, click Next.

9. In the next New Plug-in Project window, click Next.

10. Click Finish. A custom project is created in the workspace with compilation errors.

11. Open the Java file present in the src folder of the new project and make relevant changes to thecode as can be seen in the following image:

98


Java File to be Edited

If you have a different DataSource class name, make changes in the code accordingly. Also, ensureto set an additional property of the DataSource name in the setProperties method as per yourTeraData credentials. The compilation errors are now resolved.

Ensure that the IP address of the Data Source name matches the IP address in theDatabase URL provided when creating the JDBC connection.

99


12. Go to the JDBC connection and test the connection again. The connection is successfully established.

JDBC Connection

13. To verify that the JDBC connection is done, go to Run > Debug Configurations.

14. In the left pane, click BusinessWorks Applications > BWApplication.

15. In the right pane, click the Bundles tab and ensure that the name of new project created earlier isdisplayed and the check box is selected.

Debug Configuration

100


Deploying an Application with Teradata Database Through CLIIf you have a TIBCO ActiveMatrix BusinessWorks Plug-in for Database application that uses a Teradatadatabase, follow these steps to deploy the application through CLI:

Prerequisites

1. To start the agent, run the ./bwagent command from BW_HOME/bw/version_number/bin.

2. To start the administrator, run the ./bwadmin command from BW_HOME/bw/version_number/bin.

3. To change the mode to enterprise, run the mode enterprise command. This command is requiredto run the deployed application.

You must follow the procedure as described in this section if you want to deploy your application onTIBCO Business Studio server.

Procedure

Design Time

1. Create a BusinessWorks application with a JDBC shared resource and a ADB activity like younormally do.

2. Copy the tdgssconfig.jar and the terajdbc4.jar files to the BW_HOME/bw/version_number/config/design/thirdparty folder.

3. Go back to TIBCO Business Studio and click the JDBC shared resource Test Connection button.A notification pops up that you need to add the Runtime environment for the custom driver. ClickOK and then you are prompted to create the custom driver.

101


4. Follow the instructions to create the custom driver and click Test Connection.A successful connection is established.

5. Continue to set up your JDBC connection so that it connects with the design time.

Run Time

6. In TIBCO Business Studio, go to Run > Run Configuration.

7. Click Bundles tab and ensure that the custom driver is selected.

Deploying the Application on TIBCO Business Studio Server

8. Go to the custom driver created earlier and open the manifest.mf file.

9. Go to the Dependencies tab and add the javax.xml.parsers. This is a mandatory step because theTeradata JAR files are dependent on some xml parsers to work. Click Save.

102


10. Export the project to TIBCO_HOME/bw/version_number/system/shared. The project is exported asa JAR.

11. Select the custom project and clear the classpath, project, and build.properties check boxes.Provide the export destination and the JAR file name and then click Next.

12. Select the Use existing manifest from the workspace radio button.

103


13. Click Browse to select the manifest file from the custom project and click OK and then Finish.

14. The file selected earlier is exported as a JAR file.

104


15. Go back to TIBCO Business Studio. Right-click the name of the project and select DeployApplication.

16. Follow the wizard to create the domain, appspace, and appnode.You can see the application in running state.

What to do next

1. To start the administrator, go to BW_HOME/bw/version_number/bin and run the command ./bwadmin.

2. Go to the directory yourDomain/yourAppSpace/yourAppNode-xxxx, where xxxx is the portnumber and in most cases is 6081.

3. To get the log of the currently picked appnode, run the getlogfile appnode command.

If you want to see debug options from the getlogfile then go to the BW_HOME/bw/version_number/domains/your-Domain/appnodes/youAppNodeName/youAppNodeName-xxxx/logback.xml.

Append the following code for the ADB palette:<logger name="com.tibco.bw.palette.adbplugin.runtime"><level value="DEBUG"/></logger>

Append the following code for the JDBC shared resource:<logger name="com.tibco.bw.sharedresource.jdbc.runtime"> <level value="DEBUG"/> </logger>

105


To push application with Teradata database connection on docker, prerequisite steps must be followed.You follow steps to create JAR file as mentioned earlier. After the JAR file is created, unzip the JAR file.A folder is created. Move this folder under BWCE_HOME/bwce/version_number/docker/resources/addons/jars

Hints UsageYou can use hints with the Data Event Poller activity when performing a polling operation to fetch datafrom a table. Hints help improve the performance of your queries. Note that hints are available only forthe Oracle and MSSQL databases.

Syntax

You can add hints on the Advanced tab of the Data Event Poller activity.

Syntax for Oracle database/*+INDEX(<tablename>,<indexname>)*/;/*+INDEX(<tablename>,<indexname>)*/

Syntax for MSSQL database/*+WITHNOLOCK(<tablename>)*/

where,tablename is the name of the table you want to poll.

indexname is the index created on that table.

You can provide hints on multiple tables by using a semicolon to separate each table. You can use anytables and in any order - publishing table, child tables, or reference table.

Examples

The following examples show the usage of hints:

● To force an index scan when polling an Oracle database, type the hint as follows:

/*+INDEX(P1,P1_INDX)*/

where,p1 is the publisher table.

P1_INDX is the index created on the publishing table.

The plug-in processes this select query on the publishing table as follows:SELECT /*+INDEX(P1,P1_INDX)*/ * FROM P1 WHERE ID = ?

106


● To force an index scan when the plug-in fetches records from a child table, type the hint as follows:

/*+INDEX(C1,C1_INDEX)*/

where,C1 is the child table

C1_INDEX is the index created on the child table.

The plug-in processes this select query on the child table as follows:SELECT /*+INDEX(C1,C1_INDEX)*/ * FROM C1 WHERE ID = ?

● To use the WITHNOLOCK hint when polling an MSSQL database, type the hint as follows:

/*WITHNOLOCK(P1)*/

where,P1 is the publishing table.

The plug-in processes this select query on the publishing table as follows:SELECT * FROM P1 WITH(NOLOCK) WHERE id = ?

107


Log Management

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.

108


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 Data Requester activity to the Debug options, you must add thefollowing node:<logger name="com.tibco.bw.palette.adbplugin.runtime.datarequester.DataRequesterActivity"> <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.

109


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.

110


Error Codes

There are error codes for four types of roles - trace, debug, warn, and error. The following tables listthese error codes for the database palette and the shared resource:

Role: Trace

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 inpublishing tablefrom S to F.



DataEventPoller Schema

{0} execute fault status

updater {1}.

Trace BW-Plugin

Execute update ofADB_L_DELIVERY_STATUS inpublishing tablefrom S to F.




{0} No record found.

Trace BW-Plugin

Polling is in progressand no data is foundin parent or childtable for publishing.




{0} execute pub table

updater {1}.

Trace BW-Plugin

SQL query used forupdating publishingtable.




{0} batch update {1}.

Trace BW-Plugin

Number of recordsupdated duringbatch processing.




{0} release multi-

threading semaphore after

marking records.

Trace BW-Plugin

Release thepublishing tablesemaphore to allowother threads pollthe publishing table.


111






{0} release table {1}

lock in load balance

mode.

Trace BW-Plugin

Release the table lockin load balancemode.




{0} execute publishing

table selector {1}.

Trace BW-Plugin

Select columns frompublishing table withADB_L_DELIVERY_STATUS = 'N'.




{0} builds publishing

table selector.

Trace BW-Plugin

Build selectstatement forfetching data frompublishing table.




{0} binds publishing

table selector, polling

batch size is {1}.

Trace BW-Plugin

Set parameter valuesfor the select queryon publishing table.





table max sequence

selector {1}.

Trace BW-Plugin

SelectMAX(ADB_SEQUENCE) from tablewhereADB_L_DELIVERY= 'N'.





table max sequence

selector.

Trace BW-Plugin

Build selectstatement forfetching maximumADB_SEQUENCEvalue.





table mini sequence

selector {1}.

Trace BW-Plugin

SELECTMIN(ADB_SEQUENCE) from table whereADB_L_DELIVERY= 'N'.


112







table mini sequence

selector.

Trace BW-Plugin

Build selectstatement forfetching minimumADB_SEQUENCEvalue.




{0} selects record data

from reference object

table {1}.

Trace BW-Plugin

SQL query for selectfrom reference objector source table.




{0} builds pub table

updater.

Trace BW-Plugin

Build update queryfor publishing table.




{0} binds pub table

updater.

Trace BW-Plugin

Set parameter valuesfor the update queryon publishing table.




{0} build 'S' to 'N'

updater.

Trace BW-Plugin

Build update queryfor publishing tableto changeADB_L_DELIVERY_STATUS from S to N.




{0} bind 'S' to 'N'

updater.

Trace BW-Plugin

Set parameter valuesfor updatingADB_L_DELIVERY_STATUS inpublishing tablefrom S to N.




{0} execute 'S' to 'N'

updater {1}.

Trace BW-Plugin

Execute update ofADB_L_DELIVERY_STATUS inpublishing tablefrom S to N.


113






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




{0} bind reference object

selector.

Trace BW-Plugin

Set parameter valuesfor selecting datafrom referred table.





from reference object

table.

Trace BW-Plugin

Execute select onreferred table.




{0} builds reference

object selector.

Trace BW-Plugin

Build select query forreferred table.




{0} constructs the

instance based on the

source table.

Trace BW-Plugin

If referred table isnot mentioned,update publishingtable based on thesource table.




{0} polling commit for

MySql using native

driver.

Trace BW-Plugin

Displays messagewhen statements arecommitted.


114






{0} Start to fetch data

from child table.

Trace BW-Plugin

Publish Child Data isenabled and threadstarts to fetch datafrom child table.




{0} Finish fetching data

from child table.

Trace BW-Plugin

Publish Child Data isenabled and threadcompleted fetchingdata from child table.




{0} Fetch child data from

{1}.

Trace BW-Plugin

Fetching data fromchild table.




{0} execute child

selector {1}.

Trace BW-Plugin

Select columns forpublishing fromchild table.




{0} build child selector.

Trace BW-Plugin

Build select query forfetching data fromchild table.




{0} bind child selector.

Trace BW-Plugin

Set parameter valuesfor select query tofetch child data.




{0} build fault status

updater.

Trace BW-Plugin

Build update queryto update status to F.




{0} builds

ADB_L_DELIVERY_STATUS N-

>S marker.

Trace BW-Plugin

Build update queryfor Load Balancingmarker.


115







table selector whose

ADB_L_DELIVERY_STATUS is

S.

Trace BW-Plugin

Select query for loadbalancing.




{0} binds

ADB_L_DELIVERY_STATUS N -

> S marker …

Trace BW-Plugin

Sets parametervalues for the loadbalancing query.




{0} acquire table {1}

lock in load balance

mode.

Trace BW-Plugin

DataEventPollerSchema acquiringlock on a table in theload balancingmode.




{0} execute

ADB_L_DELIVERY_STATUS N -

> S marker ... {1}

Trace BW-Plugin

Executes the query inload balancingmode.



Creating the mutex table

{0}.

Trace BW-Plugin

Creates table in DBlock initialization forload balancingmode.





from source table.

Trace BW-Plugin

If referred table isnot mentioned,selects data from thesource table.



Mutex table {0} is

already locked by other

node.

Trace BW-Plugin

Table is alreadylocked by anothernode.


116






{0} failed to construct

result based on source

table because no data

fetched from {1}.

Trace BW-Plugin

Object constructionfailed when no datafound in sourcetable.





DB2.

Trace BW-Plugin

Displays messagewhen statements arecommitted.




{0} auto update status to

'N' statement is: {1}

Trace BW-Plugin

Updates the value ofADB_L_DELIVERY_STATUS in thepublishing tablefrom P, F, and S to N.




{0} auto update status

effect data count is {1}.

Trace BW-Plugin

Displays the count ofthe records whoseADB_L_DELIVERY_STATUS inpublishing table isupdated from P, F,and S to N.


TIBCO-BW-PALETTE-ADBPLUGIN-100049 {0}

Trace BW-Plugin

Displays message onactivity events suchas initialization.



Data Merger Schema {0}

the parent table opcode

{1} is invalid,so discard

the message.

Trace BW-Plugin

Discards themessage when theparent table opcodeis invalid.




bypass one message.

Trace BW-Plugin

If opcode is 10,bypasses themessage.




Message body: {1}.

Trace BW-Plugin

Displays messagebody of Data Mergerschema.


117






will do incremental

operation for child

records.

Trace BW-Plugin

If opcode exists,handles the childdata incrementally.




will do completion

operation for child

records.

Trace BW-Plugin

If opcode does notexist, handles thechild datacompletely.




start DB transaction.

Trace BW-Plugin

Displayed in logswhen databasetransaction starts.




commit DB transaction.

Trace BW-Plugin

Displayed in logswhen databasetransaction iscommitted.




the child table opcode


the child table message.

Trace BW-Plugin

Discards messagewhen the child tableopcode is invalid.




the single table opcode


the single message.

Trace BW-Plugin

Discards messagewhen single tableopcode is invalid.




can't execute the

statement because of the

statement is null.

Trace BW-Plugin

Displayed whentrying to execute anull statement.


118






{1} row(s) affected.

Trace BW-Plugin

When database rowis affected due tosuccessful statementexecution.




will rollback since {1}.

Trace BW-Plugin

Rolls back if you setnot to use anyexception table.




handle [{1}] : {2}

Trace BW-Plugin

Handles theexception messagebased on the errorstatus.




roll back DB transaction.

Trace BW-Plugin

Rolls back thedatabase transactionwhen the recordfails.




insert the data {1} into

exception table {2}.

Trace BW-Plugin

When record failsand data is insertedin the exceptiontable.




the opaque exception

table is not found.

Trace BW-Plugin

When trying to insertrecord in opaqueexception table andtable is not found.




insert the data {1} into

opaque exception table

{2}.

Trace BW-Plugin

When record fails toinsert in target tableand exception table,tries to insert recordin opaque exceptiontable.




delete related child

records. {1}

Trace BW-Plugin

If opcode is 3, deleteschild data records.


119






query related child

records.{1}

Trace BW-Plugin

If opcode is 4, fetcheschild data records.




throw exception {1} when

create statement for Data

{2}.

Trace BW-Plugin

When createstatement andinitialize parametersfail.




the statement in cache

can't be reused {1}.

Trace BW-Plugin

If statementparameter list is notequal to columnname, reuse databasestatement fails.




cache statement {1} for

table {2}.

Trace BW-Plugin

When fails to setstatement in store.




can't bind the statement

because of the statement

is null.

Trace BW-Plugin

Fails to bindstatement whenstatement is null.





bind parameter to

statement {2}.

Trace BW-Plugin

Fails when not ableto bind parametersto the statement.




call pre-commit procedure

successfully.

Trace BW-Plugin

Successfully callspre-commit storedprocedure.


120






call pre-commit procedure

unsuccessfully.

Trace BW-Plugin

Not able to call pre-commit storedprocedure.




the pre-commit procedure

output parameter SP_TEXT

is {1}.

Trace BW-Plugin

If pre-commitprocedure outputparameter SP_TEXTis null or blank.




result of pre-commit

stored procedure {1} is

\n{2}\n\t.

Trace BW-Plugin

Prints result of pre-commit storedprocedure alongwith service nameand pre-commitstored procedurename.




start handle normal

exception.

Trace BW-Plugin

Handles normalexception.




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.




throw exception \n{1}\n

when bind parameter to

statement \n\t\u0020{2}\n

\t.

Trace BW-Plugin

Fails to bindparameters to thestatement.




receive a group message

which contain {1}

record(s). \n\t.

Trace BW-Plugin

Receives groupmessage whichcontains n records.


121






handle Batch data\n\t

Trace BW-Plugin

Displays messagewhen bulk insert isprocessed.




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.




flush Bulk-Insert.\n\t.

Trace BW-Plugin

Flushes bulk-Insert ifbulk insert statementis not null.




{1} row(s) affected.\n\t.

Trace BW-Plugin

When database rowis affected due tosuccessful statementexecution.




execute database

statement successful

count is {1}\n\t.

Trace BW-Plugin

Displays count ofstatements executedsuccessfully on thedatabase.



Data Merger Schema {0} no

data change in the

database.\n\t.

Trace BW-Plugin

No change indatabase if count ofstatements executedsuccessfully on thedatabase is 0.




receive a single

message.\n\t.

Trace BW-Plugin

Data Merger schemareceives a singlemessage.




prepare roll back the

exception data \n\t.

Trace BW-Plugin

Perform roll backoperation if there isany exception inprocessing the data.


122






cache data size {1},

start handle exception\n

{2} \n\t.

Trace BW-Plugin

Starts handling thesubcache exception.




exception cache data size

is {1}, executed

successful data size is

{2} \n\t.

Trace BW-Plugin

Handles subcacheexception data count.




handle exception data {1}

of {2} \n\t.

Trace BW-Plugin

Adds all themessages in theerrorList to theexception table orthe opaque exceptiontable.




finish handle normal

exception\n\t.

Trace BW-Plugin

Finishes handlingnormal exception.




the exception table is

not found.\n\t

Trace BW-Plugin

Displays messagewhen exception tableis not found in thedatabase.




the child exception table

{1} is not found.\n\t

Trace BW-Plugin

Displays messagewhen child exceptiontable is not found inthe database.




Confirming {1} message(s)

Successfully

Trace BW-Plugin

Confirms count ofbatch commit datamessagessuccessfully.


123






statement bounds:{1}

Trace BW-Plugin

Displays messagewhen batchexecution happens inbulk insert.




can't execute the

statement because of the

statement is null

Trace BW-Plugin

If the statement isnull, cannot executethe statement.




handle {1} of {2} need

execute data

Trace BW-Plugin

Displays which datais being executed forbulk insert handling.




handle {1} of {2} error

data.

Trace BW-Plugin

Displays which datais being handled forbulk insert errorhandling.




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 tableor opaque exceptiontable.




handle {1} of {2}

continue operation data.

Trace BW-Plugin

Displays which datais being processedfurther for bulkinsert error handling.




finish handle bulk insert

error exception.

Trace BW-Plugin

When finishhandling bulk inserterror exception.


124






continue handle bulk

insert data.

Trace BW-Plugin

Continue handlebulk insert datawhile processingbulk insert data errorhandling.




start handle bulk insert

error exception.

Trace BW-Plugin

Starts handling bulkinsert errorexceptions.




execute update count

result {1}.

Trace BW-Plugin

Displays logs whenupdate count resultis executed.




statement SQL: \n\t

\u0020\u0020\u0020-

\u0020{1}\n\t

Trace BW-Plugin

Displays the SQLstatement.




create statement.\n\t

Trace BW-Plugin

When the SQLstatement is created.




bind statement.\n\t

Trace BW-Plugin

When the SQLstatement is binding.




execute statement.\n\t

Trace BW-Plugin

When the SQLstatement isexecuted.



{0}.

Trace BW-Plugin

Displays themessage on activityevents such asinitialization.


125





\n\t\u0020Data Requester

Schema {0} begin

transaction.\n\t

Trace BW-Plugin

Displays themessage when atransaction starts.



\n\t\u0020 Data Requester

Schema {0} commit

transaction.\n\t

Trace BW-Plugin

Displays themessage after atransaction iscommitted.




Schema {0} roll back

transaction.\n\t

Trace BW-Plugin

Displays themessage on rollingback a transaction.




Schema {0} Confirming

message Success.\n\t

Trace BW-Plugin

Displays themessage onsuccessful messageconfirmation.




Schema {0} create

statement.\n\t

Trace BW-Plugin

Displays themessage whencreating a statement.




Schema {0} Statement

Cached:\n\t\t{1}\n\t

Trace BW-Plugin

Displays the cachedstatement.




Schema {0} throw

exception:\n\t

\u0020\u0020\u0020-

\u0020{1}\n\t\u0020when

create DB Statement for

Data:\n\t

\u0020\u0020\u0020-

\u0020{2}\n\t

Trace BW-Plugin

Displays themessage when thecreate statementfails.


126







TD.

Trace BW-Plugin

Displays themessage whenstatements arecommitted.




Schema {0} Database

operated successful.\n\t

Trace BW-Plugin

Displays themessage whendatabase operation issuccessful.




Schema {0} Database

operated unsuccessful.\n

\t

Trace BW-Plugin

Displays themessage whendatabase operation isunsuccessful.




Schema {0} throw

exception \n{1}\n when

parse request \n{2}\n\t

Trace BW-Plugin

Displays themessage when parserequest fails.



The acknowledgement mode

selected is {0}.

Trace BW-Plugin

Specifies theacknowledgmentmode (Client orAuto) selected forData Event Polleractivity.


Role: Debug




Activity {0} generated

output:\n{1}.

Debug BW-Plugin

Shows output ofdata poller activityin XML format.

This is a debugmessage andresolution is notapplicable.


Activity {0} provided

input:{1}.

Debug BW-Plugin

Prints the activityinput information ofany of the DataMerger and DataRequester activities.


127





Exception :{0}

Debug BW-Plugin

Displays theexception message.





table selector {1}.

Debug BW-Plugin

Selects columns frompublishing tablewithADB_L_DELIVERY_STATUS = 'N'.




{0} fetched {1} rows.

Debug BW-Plugin

Number of recordsfetched in one pollfrom publishingtable.




{0} job queue size is {1}

when data pushed into the

queue.

Debug BW-Plugin

Displays the size ofjob queue when datais pushed into thequeue while pollingrecords from thepublishing table.




{0} job queue size is {1}

after polling operation

on the queue.

Debug BW-Plugin

Displays the size ofjob queue whenpolling is completed.




{0} job created

successfully.

Debug BW-Plugin

Displays themessage when jobdata is createdsuccessfully.




{0} job creation failed.

Debug BW-Plugin

Displays themessage whencreating job datafails.


Role: Info

128


Error Code and ErrorMessage Role Category Description Resolution



{0} starts polling

message.

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

This is an infomessage andresolution is notapplicable.

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

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



Oracle client info set

successfully in the

connection of {0} ...

Info BW-Plugin Shown when theOracle clientinformation is setsuccessfully.


Role: Warn




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



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




Schema {0} throw

exception \n{1}\n when

begin transaction.\n\t

Warn BW-Plugin Displays themessage when thetransaction fails tostart.

Check errors listedin the errormessage.

129





Schema {0} throw

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

\t\u0020while rolling

back transaction.\n\t

Warn BW-Plugin Displays themessage whenrollback transactionfails.




Schema {0} threw

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

\u0020while executing DB

Statement \n\t\u0020{2}\n

\t

Warn BW-Plugin Displays themessage when astatement executionfails.




Schema {0} threw

exception \n{1}\n while

committing transaction.\n

\t

Warn BW-Plugin Displays themessage when thecommit transactionfails.




Schema {0} threw

exception \n{1}\n while

getting DB procedure

{2}\n\t

Warn BW-Plugin Displays themessage when fetchDB procedure fails.




threw exception {1} in

cascade statement

creation either while

creating prepared DB

statement "{2}" or while

initializing the

parameters "{3}", please

check if the statement

and the column names are

valid.

Warn BW-Plugin Occurs wheninitializingparameters forcascade statementcreation for datamerger schema failsand anSQLException isthrown.

Check if the giventable name is validand connection todatabase is intact.

130





threw exception {1} while

initializing the




valid.

Warn BW-Plugin Occurs wheninitializingparameters forprepare statementcreation for datamerger schema failsand anSQLException isthrown.

Check errors listedin the errormessage and takean appropriateaction.




bind parameter to

statement {2}.

Warn BW-Plugin Occurs whenbinding parametersto statement for datamerger schema failsand anSQLException isthrown.




failed to register OUT

parameter due to

exception {1}, where pre

commit procedure is

"{2}".

Warn BW-Plugin Occurs whenregistering OUTparameter for datamerger schema failsand anSQLException isthrown.





executing statement {2}

Warn BW-Plugin An exception occurswhen executestatement fails.

Check error listedin the errormessage and takean appropriateaction.



threw exception {1}

either while flushing the

bulk insertion data or

while committing the

transaction.

Warn BW-Plugin Occurs whenfinishing bulktransaction for datamerger schema failsand anSQLException isthrown.




failed with exception {1}

while executing pre

commit stored procedure.

Warn BW-Plugin Occurs whenexecuting precommit storedprocedure for datamerger schema failsand anSQLException isthrown.


131





threw exception {1} in

bulk inserter creation

either while creating

prepared DB statement

"{2}" or while

initializing the




valid.

Warn BW-Plugin Occurs wheninitializingparameters for bulkinserter creation fordata merger schemafails and anSQLException isthrown.





while handling exception

rollback. The issue is

either in rollback or in

setting autocommit on

database connection.

Warn BW-Plugin Occurs whenhandling rollbackexception for datamerger schema failsand anSQLException isthrown.




with data {1} failed with

exception [{2}] while

handling normal

exception.

Warn BW-Plugin Occurs whenhandling normalexception for datamerger schema failsand anSQLException isthrown.



\n\t\u0020Data Merger

Schema {0} failed with

exception {1} while

fetching batch commit

data.

Warn BW-Plugin Occurs whenfetching batchcommit data list fordata merger schemafails and anSQLException isthrown.




failed with exception

[{1}] while inserting the

data {2} into opaque

exception table {3}.

Warn BW-Plugin Occurs wheninserting data intoopaque table for datamerger schema failsand anSQLException isthrown.


132






[{1}] while committing

bulk insert data.

Warn BW-Plugin Occurs whencommitting bulkdata insertion fordata merger schemafails and anSQLException isthrown.





while performing

incremental operation.

Warn BW-Plugin Occurs whenperformingincrementaloperation for datamerger schema failsand anSQLException isthrown.





[{1}] while closing the

statement "{2}".

Warn BW-Plugin Occurs when closingstatement for datamerger schema failsand anSQLException isthrown.





[{1}] while executing

insertion of batch bulk

statement "{2}".

Warn BW-Plugin Occurs wheninserting batch bulkstatement for datamerger schema failsand anSQLException isthrown.




with a null value in

where clause threw


initializing the

parameters "{2}" or while

setting the statement

into store for table {3},

please check if the

statement and the column

names are valid.

Warn BW-Plugin Occurs whenfetching statementwith null value inthe where clause fordata merger schemafails and anSQLException isthrown.


133





threw exception [{1}]

while processing the

batch input data {2}.

Warn BW-Plugin Occurs whenexecuting batchinput data for datamerger schema failsand anSQLException isthrown.





while closing result set.

Warn BW-Plugin Occurs when closingresultset for datamerger schema failsand anSQLException isthrown.




threw exception {1}

either while fetching the

date object with data

{2}, attribute {3} and

date string {4}.

Warn BW-Plugin Occurs whenfetching date fordata merger schemafails and anSQLException isthrown.





while creating database

connection.

Warn BW-Plugin Occurs whencreating connectionfor data mergerschema fails and anSQLException isthrown.





to initialize pre commit

stored procedure "{2}".

Warn BW-Plugin Occurs wheninitializing precommit storedprocedure for datamerger schema failsand anSQLException isthrown.





while performing parent

child operation.

Warn BW-Plugin Occurs whenperforming parentchild operation fordata merger schemafails and anSQLException isthrown.


134






setting the parameters

{2}, please check if the

statement [{3}] and the

column names are valid.

Warn BW-Plugin Occurs when settingparameters for datamerger schema failsand anSQLException isthrown.




for data {1} threw


binding bulk inserter to

table {3} with statement

"{4}" where columns are

{5}.

Warn BW-Plugin Occurs whenbinding bulk inserterfor data mergerschema fails and anSQLException isthrown.





processing a group

message which contains

{2} record(s).\n\t

Warn BW-Plugin Occurs whenprocessing groupmessage for datamerger schema failsand anSQLException isthrown.


Role: Error




{0} throw exception {1}

when update entry status.

Error BW-Plugin Occurs if there is aproblem in updating'N' to 'C' inpublishing tableduring transactionand anSQLException isthrown.





when execute publishing

table selector.

Error BW-Plugin Occurs whenexecuteQuery failsfor publishing tableand anSQLException isthrown.


135






when build publishing

table selector.

Error BW-Plugin Occurs whenprepareStatementfails for publishingtable and anSQLException isthrown.





when bind publishing

table selector.

Error BW-Plugin Occurs when settingparameter fails forpublishing table andan SQLException isthrown.





when execute the max

sequence selector.

Error BW-Plugin Occurs whenexecuteQuery failsfor max sequenceselector and anSQLException isthrown.






table max sequence

selector.

Error BW-Plugin Occurs whenprepareStatementfails for maxsequence selectorand anSQLException isthrown.





when execute the mini

sequence selector.

Error BW-Plugin Occurs when there isno DataEventPollertable.






table mini sequence

selector.

Error BW-Plugin Occurs whenprepareStatementfails for minsequence selectorand anSQLException isthrown.


136






when get dbTable whose

name is

publishingTableName.

Error BW-Plugin Occurs when there iserror fetching datafrom publishingtable.





when build pub table

updater.

Error BW-Plugin Occurs whenprepareStatementfails while updatingpublishing table andan SQLException isthrown.





when bind pub table

updater.

Error BW-Plugin Occurs when settingparameter fails whileupdating publishingtable and anSQLException isthrown.





when manipulate S to N

status updater.

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



{0}

Error BW-Plugin Occurs when ADBvalidation fails.


137




{0}

Error BW-Plugin Occurs when there isan ADB SQLException Fault.Scenario 1: Columnsin shared resourceand publishing tableare not same. Createshared resource withtable T columnscol1,col1. In dataevent poller activity,apply triggers. Thepublishing table P_Tis generated. Nowalter the originaltable T and addcolumn col3. Refindschema in sharedresource and fetchcolumnscol1,col1,col3. Nowrun the process.Insert a new recordin table T.





when construct instance

based on publishing

table.

Error BW-Plugin Occurs whenfetching row ofpublishing table.SQLException isthrown.





when fetch child data.

Error BW-Plugin Error fetching rowsof child table and anSQLException isthrown.





when build child

selector.

Error BW-Plugin Occurs whenprepareStatementfails for buildingchild selector and anSQLException isthrown.


138






when bind child selector.

Error BW-Plugin Occurs when settingparameter fails whilebuilding the childquery and anSQLException isthrown.





when build pub load

balancing marker.

Error BW-Plugin Occurs whenprepareStatementfails while buildingthe load balanceupdate query and anSQLException isthrown.





when build pub load

balancing pub table

selector.

Error BW-Plugin Occurs whenfetching the rowsfrom publishingtable for loadbalancing selector.An SQLException isthrown.





when bind pub load

balancing marker.

Error BW-Plugin Occurs when settingparameters fail whilebuilding loadbalancing query. AnSQLException isthrown.





when execute pub load

balancing marker.

Error BW-Plugin Occurs when updatequery fails for loadbalancing. AnSQLException isthrown.





when initialize the

DBLockMechanism.

Error BW-Plugin Occurs wheninitializing the DBLock mechanism.


139






when construct instance

on reference object

table.

Error BW-Plugin Occurs whenfetching a row in thereference table. AnSQLException isthrown.



The mutex table {0}

creation failed, due to

the error {1}. Process

will continue without

Load Balancing.

Error BW-Plugin Occurs whencreating mutex tablein the database fails.An SQLException isthrown.





when manipulate fault

status updater.

Error BW-Plugin Occurs whenupdation ofADB_L_DELIVERY_STATUS inpublishing table inthe database fails.An SQLException isthrown.


TIBCO-BW-PALETTE-ADBPLUGIN- 500027

{0}

Error BW-Plugin Validates the DataMerger with SharedResource and JDBCConnection.



{0}

Error BW-Plugin Displays error iferror occurs whilereading input data.



Activity {0} failed due

to unknown error in the

process {1}.

Error BW-Plugin Fails due tounknown error inthe process.





begin transaction.

Error BW-Plugin Displays error whenfails to begintransaction.


140






roll back transaction.

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



IOException occurred

while retrieving XML

Output.

Error BW-Plugin Displays error ifIOException occurswhen retrievingXML Output.



{0}

Error BW-Plugin Displays error iferror occurs whilereading input data.



{0}

Error BW-Plugin Displays error iferror occurs whilevalidating inputdata.



Database transaction


{0}.

Error BW-Plugin Occurs when thedatabase transactionfails and anSQLException isthrown.



Exception {0} thrown

while getting the string

from column {1}.

Error BW-Plugin Occurs whenfetching string failsand anSQLException isthrown.

Check if the givencolumn index orname is present inthe said table.


Time parse failed with

exception {0}.

Error BW-Plugin Occurs when parsingtime fails and anSQLException isthrown.



DB procedure failed to

register OUT parameter

due to exception {0},

where parameterIndex is

{1} and sqlType is {2}.

Error BW-Plugin Occurs whendatabase procedurefails to register OUTparameter and anSQLException isthrown.


141




Processing of Date object


{0}, where value is {1}.

Error BW-Plugin Occurs whenswitching date typefails and anSQLException isthrown.



Exception {0} while

fetching procedure from

DB, where procedure

schema is {1} and

procedure name is {2}.

Error BW-Plugin Occurs whenfetching procedurefails and anSQLException isthrown.



Exception {0} while

searching string case

from DB meta data, where

source string is {1}.

Error BW-Plugin Occurs whensearching case of astring fails and anSQLException isthrown.



Exception {0} while

fetching table {1} from

DB.

Error BW-Plugin Occurs whenfetching databasetable fails and anSQLException isthrown.



Exception {0} while

fetching table {1} from

DB with schemaName {2},

table does not exist.

Error BW-Plugin Occurs whenintended databasetable does not existand anSQLException isthrown.



Exception {0} while

closing database table

{1} from DB with

schemaName {2}.

Error BW-Plugin Occurs when closingdatabase table failsand anSQLException isthrown.





[{0}] while fetching

output parameter value at

index {1}.

Error BW-Plugin Occurs whenretrieving object failsand anSQLException isthrown.


142






[{0}] while creating the

statement.

Error BW-Plugin Occurs whencreating statementfails and anSQLException isthrown.





[{0}] while creating

PreparedStatement object

for sending parameterized

SQL statement "{1}" to

the database.

Error BW-Plugin Occurs whenpreparing statementfails and anSQLException isthrown.





[{0}] while creating

CallableStatement object

for calling database

stored procedures with

query "{1}".

Error BW-Plugin Occurs whencreating callablestatement fails andan SQLException isthrown.



Database commit

transaction failed with

exception [{0}].

Error BW-Plugin Occurs when committransaction fails andan SQLException isthrown.





[{0}] when autoCommit is

set to {1}.

Error BW-Plugin Occurs when settingauto commit failsand anSQLException isthrown.





[{0}] while closing the

statement "{1}".

Error BW-Plugin Occurs whenreleasing thestatement object'sdatabase and JDBCresources fails andan SQLException isthrown.


143






[{0}] while building

standard result set {1}.

Error BW-Plugin Occurs whenbuilding standardresult set and anSQLException isthrown.





[{0}] while regenerating

time stamp for current

time stamp {1}.

Error BW-Plugin Occurs whenregeneratingtimestamp and anSQLException isthrown.




failed while closing

database connection with

exception [{1}].

Error BW-Plugin Occurs when closingconnection fails andan SQLException isthrown.





[{0}] while fetching meta

data.

Error BW-Plugin Occurs whenfetching metadatafails and anSQLException isthrown.




failed to begin with

exception [{0}].

Error BW-Plugin Occurs whentransaction fails tobegin with autocommit set to falseand anSQLException isthrown.



Database rollback

transaction failed with

exception [{0}].

Error BW-Plugin Occurs whenrollback transactionfails and anSQLException isthrown.


144






[{0}] while retrieving

value of column {1} as an

object in result set.

Error BW-Plugin Occurs whenretrieving object failsand anSQLException isthrown.




Schema threw exception

\n{0}\n while

initializing

parameters.\n\t

Error BW-Plugin Occurs whileinitializingparameters fails andan SQLException isthrown.





[{0}] while closing

result set.

Error BW-Plugin Occurs whenbuilding result setfails and anSQLException isthrown.






value of column {1} as an

integer in result set.

Error BW-Plugin Occurs whenretrieving integerfails and anSQLException isthrown.






value of column {1} as a

clob object in result

set.

Error BW-Plugin Occurs whenretrieving clob objectfails and anSQLException isthrown.





[{0}] while setting

parameter value {1} at

index {2} with SQL type

{3}.

Error BW-Plugin Occurs when settingparameter valuewith SQL type failsand anSQLException isthrown.


145






[{0}] while binding

parameter to statement

with SQL type {1}.

Error BW-Plugin Occurs whenbinding parametervalue with SQL typefails and anSQLException isthrown.





[{0}] while searching

string escape.

Error BW-Plugin Occurs whenretrieving string thatcan be used toescape wildcardcharacters fails andan SQLException isthrown.





[{0}] while binding

parameter to statement.

Error BW-Plugin Occurs whenbinding parameterfails and anSQLException isthrown.





[{0}] while setting value

for parameter {1} of

datatype {2}.

Error BW-Plugin Occurs when settingnull value forparameter fails andan SQLException isthrown.





[{0}] while setting

parameter value {1} at

index {2}.

Error BW-Plugin Occurs when settingthe value of thedesignatedparameter using thegiven object fails andan SQLException isthrown.






query "{1}".

Error BW-Plugin Occurs when queryexecution fails andan SQLException isthrown.


146







update with statement

"{1}".

Error BW-Plugin Occurs whenexecuting updatequery fails and anSQLException isthrown.





[{0}] while adding batch.

Error BW-Plugin Occurs when addinggiven SQL commandto the current list ofcommands fails andan SQLException isthrown.





[{0}] while setting value

for XML where parameter

name is {1} and object

value is {2}.

Error BW-Plugin Occurs when settingvalue for XML failsand anSQLException isthrown.







blob in result set.

Error BW-Plugin Occurs whenretrieving blob objectfails either and anSQLException isthrown.





[{0}] while checking for

the next row in result

set.

Error BW-Plugin Occurs whenmoving cursor tonext row fails and anSQLException isthrown.

Check if the resultset type isTYPE_FORWARD_ONLY, it is vendorspecified whethertheir JDBC driverimplementationreturns false orthrows anSQLException on asubsequent call tonext.

147






[{0}] while building

result set.

Error BW-Plugin Occurs whenbuilding standardresult set fails and anSQLException isthrown.







binary stream in result

set.

Error BW-Plugin Occurs whenretrieving binarystream fails and anSQLException isthrown.





[{0}] while fetching meta

data for result set.

Error BW-Plugin Occurs whenfetching metadatafails and anSQLException isthrown.






batch.

Error BW-Plugin Occurs whenexecution on any ofthe statement from abatch fails or tries toreturn a result setandBatchUpdateException or SQLExceptionis thrown.






result set.

Error BW-Plugin Occurs whenexecution fails whilefetching resultsetobject on the currentresult and anSQLException isthrown.





[{0}] while fetching more

results with statement

"{1}".

Error BW-Plugin Occurs whenexecution fails whilechecking if there aremore results for thestatement and anSQLException isthrown.


148






[{0}] while clearing

batch with statement

"{1}".

Error BW-Plugin Occurs whenemptying aStatement object'scurrent list of SQLcommands and anSQLException isthrown.





[{0}] while setting

maximum rows to {1} with

statement "{2}".

Error BW-Plugin Occurs when settingthe limit for themaximum number ofrows fails and anSQLException isthrown.






update count.

Error BW-Plugin Occurs whenretrieving the updatecount fails and anSQLException isthrown.






object value {1} as CLOB

from database for custom

or standard RPC.

Error BW-Plugin Occurs whenretrieving the clobobject value fails andan SQLException isthrown.






object value {1} as BLOB

from database for custom

or standard RPC.

Error BW-Plugin Occurs whenretrieving the blobobject value and anSQLException isthrown.





[{0}] while converting

data {1} to BLOB.

Error BW-Plugin Occurs whenconverting data toblob and anSQLException isthrown.


149








NCLOB object in result

set.

Error BW-Plugin Occurs whenretrieving NCLOBobject fails and anSQLException isthrown.


Error codes for shared resource


TIBCO-BW-SR-ADBPLUGIN-100001

Logs related to Starting,

stopping,updating shared

resource.

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

This is a tracemessage andresolution is notapplicable


Adding new configuration

for Shared Resource with

name [{0}]

Info BW-Plugin Logs when usercreates new sharedresource.

This is an infomessage andresolution is notapplicable


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.


150


TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database ...

Documents

Transcript of TIBCO ActiveMatrix BusinessWorks™ Plug-in for Database ...