Plug-in for SAP HANA Database TIBCO ActiveMatrix ...€¦ · Getting Started. This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks ™ Plug-in for

TIBCO ActiveMatrix BusinessWorks™

Plug-in for SAP HANA Database

User's GuideSoftware Release 6.0February 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, TIBCO Designer,Rendezvous, and TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCOSoftware 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 SAP HANA Database User's Guide

https://www.tibco.com/patents

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

3


Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Plug-in Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Creating and Configuring a SAP HANA Database Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Creating and Configuring the SAP HANA Database JDBC Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Creating and Configuring the SAP HANA Database OData Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Debugging and Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

SAP HANA Database JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

SAP HANA Database OData Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

SAP HANA Database Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SAP HANA Database JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SAP HANA Database Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SAP HANA Database Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

SAP HANA Database Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

SAP HANA Database Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

SAP HANA Database OData Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Consume SAP HANA Database OData Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

SAP HANA Database Data Type to XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Job Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

JDBC_MultipleOperations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

OData_MultipleOperations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4


Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Log Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5


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

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site at https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-sap-hana-database-6-0-0. To directly access documentation for this product, open the followingfile:

TIBCO_HOME/release_notes/TIB_ bwpluginsaphanadatabase_6.0.0 _docinfo.html

here TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows, thedefault TIBCO_HOME is C:\Program Files\tibco. On UNIX systems, the default TIBCO_HOMEis /opt/tibco.

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for SAP HANA Database Release Notes

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for SAP HANA Database Installation

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.

6


https://docs.tibco.com




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™ is an easy to use integration product suite for enterprise, web,and mobile applications. TIBCO ActiveMatrix BusinessWorks uses the Eclipse graphical user interface(GUI) and TIBCO Business Studio for BusinessWorks™ for defining business processes and the processengine to execute the business processes.

SAP HANA Database is an in-memory, column-oriented, and relational database management systemused as standalone or for SAP applications.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP HANA Database provides the interoperabilitybetween TIBCO ActiveMatrix BusinessWorks and SAP HANA Database. With the plug-in, you canperform operations on SAP HANA Database entities using JDBC and invoke OData services publishedby SAP HANA Database.

ActiveMatrix BusinessWorks™ Plug-in for SAP HANA Database extends TIBCO ActiveMatrixBusinessWorks and adds SAP HANA Database JDBC Connection shared resource, SAP HANADatabase JDBC Palette, SAP HANA Database OData Connection shared resource and SAP HANADatabase OData Palette to TIBCO Business Studio™ for BusinessWorks™ (hereinafter referred to as"TIBCO Business Studio").

● SAP HANA Database JDBC Connection

You can use the SAP HANA Database JDBC Connection shared resource to connect to the SAPHANA Database system using HANA JDBC driver and download entity metadata at design time.

● SAP HANA Database JDBC Palette

The SAP HANA Database JDBC Palette supports the following activities :

● SAP HANA Database Delete : Use this activity to run the delete SQL statements on SAP HANADatabase.

● SAP HANA Database Insert : Use this activity to run the insert SQL statements on SAP HANADatabase.

● SAP HANA Database Query : Use this activity to run the query SQL statements on SAP HANADatabase.

● SAP HANA Database Update : Use this activity to run the update SQL statements on SAPHANA Database.

● SAP HANA Database OData Connection

You can use the SAP HANA Database OData Connection shared resource to view entities exposedas OData services by SAP HANA Database and download entity metadata at design time.

● SAP HANA Database OData Palette

The SAP HANA Database OData Palette supports the following activity:

● Consume SAP HANA Database OData Service: Use this activity to consume OData servicesexposed by SAP HANA Database.

7


Getting Started

This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks™ Plug-in forSAP HANA Database.

All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio™ Concepts guideto familiarize yourself with TIBCO Business Studio.

A basic workflow of using TIBCO ActiveMatrix BusinessWorks Plug-in for SAP HANA Databaseincludes:

● TIBCO Business Studio Overview

● Creating a Project

● Creating and Configuring a SAP HANA Database Connection

● Configuring a Process

● Testing a Process

● Deploying an Application

When configuring the shared resources or activities, you might find that some fields inherit the moduleproperties. If you want to specify those fields, you have to specify the corresponding module propertiesin the Module Properties tab of the Module Properties editor.

TIBCO Business Studio OverviewTIBCO Business Studio for BusinessWorks is an Eclipse-based integration development environmentthat is used to design, develop, and test ActiveMatrix BusinessWorks applications. The studio providesa workbench in which you can create, manage, and navigate resources in your workspace. A workspaceis the central location on your computer where all data files are stored.

UI Element Description

Menu Contains menu items such as File, Edit, Navigate, Search, Project,Run, Window, and Help.

8


UI Element Description

Toolbar Contains buttons for frequently used commands such as:

● New

● Save

● Enable/Disable Business Studio Capabilities

● Create a new BusinessWorks Application Module

● Debug

● Run

Perspectives Contains an initial set and layout of views that are required toperform a certain task. TIBCO Business Studio for BusinessWorkslaunches the Design perspective by default. Use the Designperspective when designing a process and the Debug perspectivewhen testing and debugging a process. To change the perspective,select Window > Open Perspective > perspective_name from themain menu. Or, you can click the icon at the top right-hand side ofthe workbench and select the perspective to open.

Views Lists the resources and helps you navigate within the workbench.For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in yourworkspace, and the Properties view displays the properties for theselected resource. To open a view, select Window > Show View >view_name from the main menu.

Editors Provides a canvas to configure, edit, or browse a resource.Double-click a resource in a view to open the appropriate editorfor the selected resource. For example, double-click on a process(MortgageAppConsumer.bwp) in the Project Explorer view toopen the process in the editor.

Palette Contains a set of widgets and a palette library. A palette groupsactivities that perform similar tasks, and provides quick accesswhen configuring a process.

Creating a ProjectThe first task using the plug-in is creating a project. After creating a project, you can add resources andprocesses.

An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is the smallest unit of resources that is named, versioned, and packaged as part ofan application.

When you import an existing project to the current workspace of TIBCO Business Studio, if you clickSelect root directory in the Import Projects dialog, you must select the Copy projects into workspacecheck box.

9


Procedure

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

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

● MacOS and Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/<version_number>/eclipse directory.

On MacOS, to load the environment variables in the launchd.conf file correctly,ensure that the shell is bash when you start TIBCO Business Studio on a commandline.

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 to openthe New BusinessWorks Application Module wizard.

4. In the Project dialog box, configure the project that you want to create:a) In the Project name field, enter a project name.b) By default, the created project is located in the workspace current in use. If you do not want to

use the default location for the project, clear the Use default location check box and click Browseto select a new location.

c) Use the default version of the application module, or enter a new version in the Version field.d) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating the project.e) Select the Use Java configuration check box if you want to create a Java module.

A Java module provides the Java tooling capabilities.f) Click Finish to create the project.

Result

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

Creating and Configuring a SAP HANA Database ConnectionAfter creating a project, you can add a SAP HANA Database connection shared resource to establishconnection between the plug-in and the SAP HANA Database.

Prerequisites

The SAP HANA Database connection shared resource is available at the Resources level. Ensure thatyou have created a project. See Creating a Project for details.

Creating and Configuring the SAP HANA Database JDBC Connection ResourceYou can use the SAP HANA Database JDBC Connection shared resource to connect to the SAP HANADatabase system using HANA JDBC driver and download entity metadata at design time.

Procedure

1. In the Project Explorer view, right-click Resources folder and select New > SAP HANA DatabaseJDBC Connection to open the SAP HANA Database JDBC Connection wizard.Hint: The project must be expanded to display all the folders.

2. In the New SAP HANA Database JDBC Connection dialog box, the Resource Folder, Package , andResource Name of the SAP HANA Database JDBC Connection are provided by default. If you do

10


not want to use the default configurations, change them accordingly. Click Finish to open the SAPHANA Database JDBC Connection editor.The SAP HANA Database JDBC Connection shared resource is created. The shared resourceconsists of two tabs: Configuration and Schema.

3. Configure the SAP HANA Database JDBC Connection resource in the displayed editor, as describedin SAP HANA Database JDBC Connection.

Creating and Configuring the SAP HANA Database OData Connection ResourceYou can use the SAP HANA Database OData Connection shared resource to view entities exposed asOData services by SAP HANA Database and download entity metadata at design time.

Procedure

1. In the Project Explorer view, right-click Resources folder and select New > SAP HANA DatabaseOData Connection to open the SAP HANA Database OData Connection wizard.Hint: The project must be expanded to display all the folders.

2. In the New SAP HANA Database OData Connection dialog box, the Resource Folder, Package ,and Resource Name of the SAP HANA Database OData Connection are provided by default. If youdo not want to use the default configurations, change them accordingly. Click Finish to open theSAP HANA Database OData Connection editor.The SAP HANA Database OData Connection shared resource is created. The shared resourceconsists of two tabs: Configuration and Schema.

3. Configure the SAP HANA Database OData Connection resource in the displayed editor, asdescribed in SAP HANA Database OData Connection.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to an empty process tocomplete a task.

Prerequisites

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

● Ensure that you have established an SAP HANA Database connection. See Creating andConfiguring a SAP HANA Database Connection for details.

Procedure

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

2. Select an activity from the Palette view and drop it in the Process editor.

3. Drag the icon to create a transition between the activities.

4. Configure the SAP HANA Database JDBC or SAP HANA Database OData activity.See SAP HANA Database Palette for details.

To map the output of the previous activity as the input of the current activity, choose theAutoMap option.

5. Click File > Save.

11


Debugging and Testing a ProcessAfter configuring a process, you can test the process to check whether the process completes your task.

Prerequisites

Ensure that you have configured a process. See Configuring a Process for details.

Procedure

1. On the toolbar, click Debug > Debug Configurations.

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

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

4. In the Debug tab, expand the running process and click an activity.

5. In the upper-right corner, click the Job Data tab, and then click the Output tab to check the activityoutput.

Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process to a runtime environment. After deploying applications, you can manageTIBCO ActiveMatrix BusinessWorks applications by using TIBCO® Enterprise Administrator.

Prerequisites

● Before deploying an application for OData palette, add the following property in the app node'sTRA file:java.property.javax.xml.stream.XMLInputFactory=com.sun.xml.internal.stream.XMLInputFactoryImpl

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

— Creating a Project

— Generating an EAR File

You can deploy an application EAR file in the command-line mode with the bwadmin utility.Deploying an application involves the following tasks:

Procedure

1. Upload an EAR file.

2. Deploy an application.

3. Configure an application.

4. Start an application.See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

12


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

Prerequisites

Create a project by following the steps described in Creating a Project.

Apart from the method described here, there are other ways to generate an EAR file. For moreinformation, see TIBCO ActiveMatrix BusinessWorks Administration.

Procedure

1. In the File Explorer view, 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<name>.<application>_<version>.ear file is generated.

13


SAP HANA Database JDBC Connection

You can use the SAP HANA Database JDBC Connection shared resource to connect to the SAP HANADatabase system using HANA JDBC driver and to download entity metadata at design time.

The SAP HANA Database JDBC Connection window has the following tabs - Configuration and Schema.

The SAP HANA Database JDBC connection created in the shared module is not set to default whenSAP HANA Database plug-in activities are created in the application module. You must manuallyselect the SAP HANA Database JDBC connection from the list of shared modules.

ConfigurationOn the Configuration tab, specify information to connect to SAP HANA Database. The Configurationtab has the following sections: General, Connection, Connection Pool Parameters, and Advanced.

General

The General panel has the following fields:

Field Description

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

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

Description A short description for this shared resource.

Connection

The Connection panel has the following fields:

14


Field Module Property Description

Database URL Yes The URL to connect to the SAP HANA Database.

A template of the URL is supplied for HANA JDBCdriver. Supply the portions of the URL that are in anglebrackets (<>).

Sample URL syntax for SAP HANA JDBC driver:jdbc:sap://<host>:<port>?

databaseName=<dbname>.

Username Yes The user name to connect to the SAP HANA Database.

Password Yes The password to connect to the SAP HANA Database.

ConnectionTimeout(ms)

Yes The time (in milliseconds) to wait for a successfuldatabase connection.

Test Connection No Click the Test Connection button to test whether thespecified configuration fields result in a validconnection to SAP HANA Database.

Catalog No Lists the catalogs available for the selected database.

Connection Pool Parameters

The Connection Pool Parameters panel has the following fields:

FieldModuleProperty Description

Minimum PoolSize

Yes The initial number of connections that are created whenthe pool is started.

Maximum PoolSize

Yes The maximum number of connections that can beallocated from the connection pool at the same time.

Advanced

In the Advanced panel, specify additional information about the number of threads needed forprocessing requests.


Service No. ofThreads

Yes The number of concurrent threads for processingrequests to the activity.

Default value: 8 (A value less than 1 is automaticallychanged to the default value.)

For more information about configuring this field, see Job Tuning section.

15


SchemaThe Schema tab lists the entities that are part of the selected catalog. To filter on specific Entities, enterthe search string for the Entity column.

For this release, only TABLE entity is supported.

On the Schema tab, perform the following tasks:

● Refresh Entity List: Update the entity list and metadata of the entities previously downloaded.

For the changes to reflect in the activity, click on the activity once.

● Download Entity: Download the metadata of the selected entity.

Only one entity can be downloaded at a time.

16


SAP HANA Database OData Connection

SAP HANA Database OData Connection shared resource is used to view entities exposed as ODataservices by SAP HANA Database and to download entity metadata at design time.

The SAP HANA Database OData Connection window has the following tabs - Configuration and Schema.

The SAP HANA Database OData connection created in the shared module is not set to default whenSAP HANA Database plug-in activities are created in the application module. You must manuallyselect the SAP HANA Database OData connection from the shared module.

ConfigurationThe Configuration tab has the following sections: General, Connection, and Advanced.

General

The General panel has the following fields:

Field Description

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

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

Description A short description for this shared resource.

Connection

The Connection panel has the following fields:

17



URL Yes The URL of XS OData file available on SAP HANADatabase.

Supply the portions of the URL that are in anglebrackets (<>).

Sample URL syntax for XS OData: http[s]://<host>:<port>/<repository package>/<xs odata

file name>.xsodata .

User Name Yes The user name to connect to the SAP HANA Database.

Password Yes The password to connect to the SAP HANA Database.

Advanced

In the Advanced panel of the Configuration tab, specify additional information about the number ofthreads needed for processing requests.


Service No. ofThreads

Yes The number of concurrent threads for processingrequests to the activity.

Default value: 8 (A value less than 1 is automaticallychanged to the default value.)

For more information about configuring this field, see Job Tuning section.

SchemaThe Schema tab lists the entities that are exposed as OData services in the XS OData file entered as partof URL in Configuration tab.

For this release, only TABLE entity is supported.

18


On the Schema tab, perform the following tasks:

● Refresh Entity List: Update the entity list.

● Download Entity: Download the metadata of the selected entity.

Only one entity can be downloaded at a time.

Before launching TIBCO Business Studio for BusinessWorks, add the following VM argument to theTIBCO_HOME/studio/<version>/eclipse/TIBCOBusinessStudio.ini file:

-Djavax.xml.stream.XMLInputFactory=com.sun.xml.internal.stream.XMLInputFactoryImpl

19


SAP HANA Database Palette

A palette groups the activities that connect the same external applications together. The ActiveMatrixBusinessWorks Plug-in for SAP HANA Database contains the following palettes.

● SAP HANA Database JDBC Palette

● SAP HANA Database OData Palette

SAP HANA Database JDBC PaletteThe SAP HANA Database JDBC palette is added after installing ActiveMatrix BusinessWorks Plug-infor SAP HANA Database and contains the following activities:

● SAP HANA Database Delete

● SAP HANA Database Insert

● SAP HANA Database Query

● SAP HANA Database Update

SAP HANA Database DeleteUse this activity to run the delete SQL statements on SAP HANA Database. This activity returnsinformation in the form of total rows affected.

General

The following table lists the configurations in the General tab of the SAP HANA Database Deleteactivity:


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

HANA JDBCResource

YesClick to select a SAP HANA Database JDBC Connection sharedresource.

If no matching SAP HANA Database JDBC Connection sharedresource is found, click Create Shared Resource to create one. Formore details, see Creating and Configuring the SAP HANADatabase JDBC Connection Resource.

Entity NoClick to select an entity. The entities downloaded in selectedSAP HANA Database JDBC Connection shared resource will beavailable for selection.

Description

In the Description tab, you can enter a short description for the SAP HANA Database Delete activity.

SQL Builder

The SQL Builder tab displays the metadata of the entity selected in the General tab.

20


Fields Editable Description

Field Name No Displays name of the column.

Data Type No Displays the data type of the column.

Primary Key No Displays if the column is a primary key.

Not Null No Displays if the column accepts null value.

Dimension No Displays the dimension of the column.

Parameter Yes Displays the fields that must be part of the WHERE clause of a deletequery SQL statement.

Input

All the fields in the SQL Builder tab that have Parameter column selected will be part of the Input tab.

The Input tab displays the input schema of the activity as a tree structure. The information in theschema depends on the fields selected on the SQL Builder tab.

It is not mandatory to provide values for fields on the input tab for SAP HANA Database Deleteactivity. A default mapping will be displayed at the ActivityInput element when the activity iscreated for the first time. In case the required symbol is visible, then right-click the ActivityInputelement and click Show Check and Repair > Select ActivityInput field and click OK.

For more information about SAP HANA Database datatype mapping to XSD mapping, see SAP HANADatabase Datatype Mapping to XSD Mapping.

Output

The Output tab displays the rowsAffected field which holds the count of number of rows affectedafter the SAP HANA Database Delete activity is invoked.

The Output tab displays the output schema of the activity as a tree structure. The output is read-only.

Fault

The Fault tab lists exceptions that are thrown by this activity. This activity throws the followingexceptions:

● SapHanaDatabaseJdbcSQLException: Thrown when the error originates from the SAP HANADatabase system.

● SapHanaDatabaseJdbcPluginException: Thrown when the error originates from the plug-in.

Error SchemaElement Datatype Description

msg string The error message returned by the plug-in

msgCode string The error code returned by the plug-in

For more information, see Error Codes.

21


SAP HANA Database InsertUse this activity to run the insert SQL statements on SAP HANA Database. You can insert multiplerows in the database in batches. Error in one batch does not stop the execution of the subsequent batch.The failure record of a batch depends on the behavior of the underlying HANA JDBC driver. If a batchfails to insert one or more records, the detailed message is displayed in logs including the batchnumber, reason of failure, and rows that failed to insert. This activity returns the information in theform of total rows attempted and total rows affected.

General

The following table lists the configurations in the General tab of the SAP HANA Database Insertactivity:



HANA JDBCResource




Batch size Yes All incoming messages to be inserted are stored until this size isreached. Then, a bulk insert operation is performed on the selectedentity.

The default value is 1000.

Description

In the Description tab, you can enter a short description for the SAP HANA Database Insert activity.

SQL Builder

The SQL Builder tab, displays the metadata of the entity selected in the General tab.





22





Values Yes Displays the fields that must be part of the VALUES clause for aninsert SQL statement.

By default, Values column is selected for all the fields.

Input

All the fields in the SQL Builder tab that have Values column checked, will be part of input tab.

The Input tab displays the input schema of the activity as a tree structure. The information in theschema depends on the fields selected on the SQL Builder tab. You must enter information for anymandatory fields


Output

The Output tab displays the rowsAttempted and rowsAffected fields.

The rowsAttempted field holds the count of number of rows that were attempted by SAP HANADatabase Insert activity and rowsAffected field holds the count of number of rows affected after theSAP HANA Database Insert activity is invoked. The difference between these two is the number ofrows that failed to insert.


Fault








SAP HANA Database QueryUse this activity to run the query SQL statements on SAP HANA Database.

General

The following table lists the configurations in the General tab of the SAP HANA Database Queryactivity:

23




HANA JDBCResource



Entity NoClick to select an entity.

The entities downloaded in selected SAP HANA Database JDBCConnection shared resource will be available for selection.

Maximumrows

Yes The maximum number of rows to retrieve. To retrieve all rows,specify 0.

Default value: 100.

Description

In the Description tab enter a short description for the SAP HANA Database Query activity.

SQL Builder

The SQL Builder tab displays the metadata of the entity selected in the General tab.







Selected Yes Displays the fields that must be part of the SELECT query of an SQLstatement. By default, the Selected column is selected for all thefields.

Parameter Yes Displays the fields that must be part of the WHERE clause of a querySQL statement.

Input

All the fields in the SQL Builder tab that have Parameter column selected, will be part of the Input tab.

24


The Input tab displays the input schema of the activity as a tree structure. The information in theschema depends on the fields selected on the SQL Builder tab.

It is not mandatory to provide values for fields on the input tab for SAP HANA Database Queryactivity. A default mapping will be displayed at the ActivityInput element when the activity iscreated for the first time. If the required symbol is visible, then right-click the ActivityInput elementand click Show Check and Repair > Select ActivityInput field and click OK.


Output

All the fields in the SQL Builder tab that have Selected column selected will be part of Output tab.Output of SAP HANA Database Query activity holds multiple records.

The Output tab displays the output schema of the activity as a tree structure. The output is read-only.The information in the schema depends on the fields selected on the SQL Builder tab.

Fault








SAP HANA Database UpdateUse this activity to run the update SQL statements on SAP HANA Database. You can update multiplerows in the database. This activity returns the information in the form of total rows affected.

General

The following table lists the configurations in the General tab of the SAP HANA Database Updateactivity:



25



HANA JDBCResource




Description

In the Description tab, you can enter a short description for the SAP HANA Database Update activity.

SQL Builder

The SQL Builder tab, displays the metadata of the entity selected in the General tab.







Values Yes Displays the fields that must be part of the SET clause for an updateSQL statement.

By default Values column is selected for all the fields.

Parameter Yes Displays the fields that must be part of the WHERE clause of an updateSQL statement.

Input

All the fields in the SQL Builder tab that have Values and Parameter column checked, will be part ofinput tab.

The Input tab displays the input schema of the activity as a tree structure. The information in theschema depends on the fields selected on the SQL Builder tab. You must enter information for anymandatory fields


26


Output

The Output tab displays the rowsAffected field which holds the count of number of rows affectedafter the SAP HANA Database Update activity is invoked..


Fault








SAP HANA Database OData PaletteThe SAP HANA Database OData palette is added after installing ActiveMatrix BusinessWorks Plug-infor SAP HANA Database.

The SAP HANA Database OData palette contains the Consume SAP HANA Database OData Serviceactivity.

Consume SAP HANA Database OData ServiceSAP HANA Database provides capability of exposing database table data as OData service.

The Consume SAP HANA Database OData Service activity helps you consume the OData servicesfrom TIBCO ActiveMatrix BusinessWorks. The following operations are supported by SAP HANADatabase: GET, POST, PUT, and DELETE.

General

The following table lists the configurations in the General tab of the Consume SAP HANA DatabaseOData Service activity:


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

27



HANA ODataResource

YesClick to select a SAP HANA Database ODataConnection shared resource.

If no matching SAP HANA Database OData Connectionshared resource is found, click Create Shared Resource tocreate one. For more details, see Creating andConfiguring the SAP HANA Database OData ConnectionResource.

Entity NoClick to select an entity. The entities downloaded inselected SAP HANA Database OData Connection sharedresource will be available for selection.

Service No Service corresponding to the selected Entity.

Operation No Select the operation. The operation visible depends on thetype of the service.

Valid option examples: GET, PUT, POST, and DELETE.

Underscores are used only for parameters. Ifthe service name contains an underscore (_),the underscore is automatically removed fromthe displayed service name.

Description

In the Description tab enter a short description for the Consume SAP HANA Database OData Serviceactivity.

Input

The input is generated based on the Service and the Operation selected by the user in the General tab.The Input tab displays the input schema of the activity as a tree structure. The information in theschema varies based on the fields selected on the General tab. You must enter information as requiredfor any mandatory fields.


Output

The Output tab shows the response of the invoked service. The Output tab displays the output schemaof the activity as a tree structure. The output is read-only. The information in the schema depends onthe fields selected on the General tab.

Output Item Data Type Description

ResultCount Integer This ResultCount field from Output counts how many records arereturned after the Consume SAP HANA Database OData Serviceactivity is invoked.

28


Fault

The Fault tab lists exceptions that are thrown by this activity. The Consume SAP HANA DatabaseOData Service activity throws the following exceptions:

● SapHanaDatabaseODataSystemException: Thrown when the error originates from the SAP HANADatabase system.

● SapHanaDatabaseODataPluginException: Thrown when the error originates from the plug-in.





29


SAP HANA Database Data Type to XSD Mapping

The following tables list the SAP HANA Database data types and corresponding XSD data types.

Supported SAP HANA Data Types for SAP HANA Database JDBC Palette

SAP HANA Database Data Type XSD Type

NVARCHAR

VARCHAR

CHAR

CLOB

NCLOB

SHORTTEXT

ALPHANUM

string

INTEGER int

TINYINT unsignedByte

SMALLINT short

BIGINT long

DOUBLE

REAL

FLOAT

SMALLDECIMAL

double

DECIMAL decimal

DATE date

TIME time

TIMESTAMP

SECONDDATE

dateTime

BINARY

VARBINARY

BLOB

base64Binary

BOOLEAN boolean

30


Supported SAP HANA Data Types for SAP HANA Database OData Palette

SAP HANA Database Data Type XSD Type

NVARCHAR

VARCHAR

NCHAR

CHAR

string

INTEGER int

TINYINT unsignedByte

SMALLINT short

BIGINT long

DOUBLE double

DECIMAL

SMALLDECIMAL

decimal

REAL

FLOAT

float

TIME time

DATE

SECONDDATE

LONGDATE

TIMESTAMP

dateTime

BINARY

VARBINARY

base64Binary

31


Job Tuning

You can configure the SAP HANA Database activities to control the number of messages processedconcurrently.

For details on job tuning, see "Engine and Job Tuning" in TIBCO ActiveMatrix BusinessWorksAdministration. To control the number of messages being processed concurrently, you can use theService No. of Threads property.

The Service No. of Threads must be configured based on the number of ActiveMatrix BusinessWorksengine threads available and the response time for completing the operation.

For example, if the response time for generating output by the activity is similar to the throughput forinvoking the activity, then the Service No. of Threads field value must match the number ofActiveMatrix BusinessWorks engine threads. If the response time for generating output by the activityis greater, then configure the Service No. of Threads accordingly.

32


Working with Sample Projects

The sample projects provided with the plug-in help you understand how ActiveMatrix BusinessWorksPlug-in for SAP HANA Database works.The sample projects are located in the TIBCO_HOME/bw/palettes/saphanadatabase/<version_number>/samples directory. The following sample projects are available:

● JDBC_MultipleOperations

● OData_MultipleOperations

Importing Sample ProjectsBefore running the project, you need to import the sample project to TIBCO Business Studio forBusinessWorks.

To import the project:

Procedure

1. Start TIBCO Business Studio.

2. From the menu bar, click File > Import.

3. In the Import dialog box, expand the General folder, and then click Existing Studio Projects intoWorkspace. Click Next.

4. In the Import Projects dialog box, click Select archive file, and then click Browse.

5. Locate the sample project file, and then click Open.For example, the sample project JDBC_MultipleOperations is located in the TIBCO_HOME/bw/palettes/saphanadatabase/<version_number>/samples directory.

6. Click Finish.

Result

The selected sample project is imported to TIBCO Business Studio for BusinessWorks

JDBC_MultipleOperationsThe JDBC_MultipleOperations project contains one process: JDBC_MultipleOperations process.

JDBC_MultipleOperations Process

This ActiveMatrix BusinessWorks process provides an example where multiple operations like Insert,Query, Update, and Delete are performed on SAP HANA Database entity EMPLOYEE.

The following figure describes the JDBC_MultipleOperations process:

33


Setting Up the ProjectBefore running the project, you have to set it up.

Prerequisites

1. Run EMPLOYEE.sql script on SAP HANA Database under SYSTEM catalog. Script can be located inthe TIBCO_HOME/bw/palettes/saphanadatabase/<version_number>/samples directory.

2. Import the JDBC_MultipleOperations project before setting it up. For more information, see Importing Sample Projects.

Procedure

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

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

3. In the Module Properties panel, set the value of the Database_URL, Username, Password.

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

Running the ProjectAfter setting up the project, you can run it to see how the plug-in works.

Prerequisites

Ensure that you have set the project before running it. For more information, see Setting Up the Project.

To run the JDBC_MultipleOperations process,

Procedure

1. From the menu, click Run > Run Configurations .

2. In the Run Configurations dialog box, expand BusinessWorks Application, and then clickBWApplication.

34


3. On the Applications tab, all the sample applications are selected. You can clear the sampleapplications that you do not want to run.

4. Click Run to run the process.

5. Click the icon to stop the process.

OData_MultipleOperationsThe OData_MultipleOperations project contains one process: OData_MultipleOperations process.

OData_MultipleOperations Process

This ActiveMatrix BusinessWorks process provides an example where a REST service is used to invokeDELETE, GET, POST, and PUT operations on SAP HANA Database entity EMPLOYEE.

The following figure describes the OData_MultipleOperations process:

Setting Up the ProjectBefore running the project, you have to set it up.

Prerequisites

1. Run EMPLOYEE.sql script on SAP HANA DATABASE under SYSTEM catalog. Script can be locatedin the TIBCO_HOME/bw/palettes/saphanadatabase/<version_number>/samples directory.

2. Expose EMPLOYEE entity as OData service.

For information on Exposing Database Entity as OData service, see SAP HANAdocumentation.

3. Import the OData_MultipleOperations project before setting it up. For more information, see Importing Sample Projects.

35


Procedure

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

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

3. In the Module Properties panel, set the value of the Database_URL, UserName, Password.

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

Running the ProjectAfter setting up the project, you can run it to see how the plug-in works.

Prerequisites

Ensure that you have set the project before running it. For more information, see Setting up the Project.

To run the OData_MultipleOperations process,

Procedure

1. From the menu, click Run > Run Configurations .

2. In the Run Configurations dialog box, expand BusinessWorks Application, and then clickBWApplication.

3. On the Applications tab, all the sample applications are selected. You can clear the sampleapplications that you do not want to run.

4. On the Arguments tab, under VM arguments panel, add the following property:-Djavax.xml.stream.XMLInputFactory=com.sun.xml.internal.stream.XMLInputFactoryImpl

5. Click Run to run the process.

36


6. Click the icon to stop the process.

37


Troubleshooting

This topic contains basic troubleshooting information for a project.If errors occur when you run a process in TIBCO Business Studio for BusinessWorks, first clean up theproject. Cleaning deletes all the old files and reorganizes the project.

Procedure

1. In the Project Explorer view, right-click the project and click Refresh.

2. Select Project > Clean to start the cleaning process.

38


Log Management

When an error occurs, you can check logs to trace and troubleshoot plug-in exceptions.

By default, error logs are displayed in the Console view when you run a process in 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.

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

Log Level Description

Trace Includes all information regarding the running process.

Debug Indicates a developer-defined tracing message.

Info Indicates normal plug-in operations. No action is required. A tracing messagetagged with Info indicates that a significant processing step is reached, andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

Warn Indicates that an abnormal condition occurred. Processing continues, butspecial attention from the administrator is recommended.

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

Setting Up Log LevelsYou can configure a different log level for the plug-in and plug-in activities to trace different messages.

By default, the plug-in uses the default log level of TIBCO ActiveMatrix BusinessWorks. The default loglevel of TIBCO ActiveMatrix BusinessWorks is Error.

Procedure

1. Navigate to the TIBCO_HOME\bw\version_number\config\design\logback directory, and openthe logback.xml file.

2. Add the following node in the BusinessWorks Palette and Activity loggers area to specify a loglevel for the plug-in:

● For SAP HANA Database JDBC palette:<logger name="com.tibco.bw.palette.saphanadb.jdbc.runtime"> <level value="TRACE"/> </logger>

● For SAP HANA Database OData palette:<logger name="com.tibco.bw.palette.saphanadb.odata.runtime"> <level value="TRACE"/> </logger>

The value of the level element can be Error, Info, Debug or Trace.

If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

39


3. Optional: Optional: Add one of the following nodes in the BusinessWorks Palette and ActivityLoggers area to specify a log level for the activity.

● For SAP HANA Database JDBC activities, set the following parameters:<logger name="com.tibco.bw.palette.saphanadb.jdbc.runtime.query"> <level value="TRACE"/></logger>

<logger name="com.tibco.bw.palette.saphanadb.jdbc.runtime.delete"> <level value="TRACE"/></logger>

<logger name="com.tibco.bw.palette.saphanadb.jdbc.runtime.insert"> <level value="TRACE"/></logger>

<logger name="com.tibco.bw.palette.saphanadb.jdbc.runtime.update"> <level value="TRACE"/></logger>

● For SAP HANA Database OData activity, set the following parameters:<logger name="com.tibco.bw.palette.saphanadb.odata.runtime.consumeodata"> <level value="TRACE"/></logger>

The activities that are not configured with specific log levels use the default log level of theplug-in.

4. To control the debug log level for the SAP HANA Database Configuration shared resource, set thefollowing parameters:

● For SAP HANA Database JDBC Connection shared resource:<logger name="com.tibco.bw.sharedresource.saphanadb.jdbc.runtime"> <level value="TRACE"/> </logger>

● For SAP HANA Database OData Connection shared resource:<logger name="com.tibco.bw.sharedresource.saphanadb.odata.runtime"> <level value="TRACE"/> </logger>

5. Save the file.

Exporting Logs to a FileTo export plug-in logs to a file, you must modify the logback.xml file.

Procedure

1. On Windows, navigate to TIBCO_HOME\bw\version_number\config\design\logback directoryand open the logback.xml file.

After deploying an application in TIBCO Enterprise Administrator, navigate to theTIBCO_HOME\bw\version_number\domains\domain_name\appnodes\appspace_name

\appnode_name directory and locate the logback.xml file.

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

The value of the file element is the absolute path of the file that stores the exported logs.

40


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

4. Save the file.

41


Error Codes

The following table lists the error codes, explanation of each error, where applicable.

Error Codes for SAP HANA Database JDBC Palette

Error Code and Error Message Role Category Description

TIBCO-BW-PALETTE-SAP_HANA_DATABASE_JDBC-100001

{0}

Trace BW-Plug-in Message is shown whileprinting events for activity.


Connection successful with SAP

HANA database using

DatabaseURL: {0}

Trace BW-Plug-in Message is shown onsuccessful connection withSAP HANA Database.


\nStart of the Activity {0},

\nInput received: \n {1} \n

Debug BW-Plug-in Prints activity input.


\nActivity {0}, Output data:

\n {1} \n Exit of Activity {2}

Debug BW-Plug-in Prints activity output.


Query formed: {0}

Debug BW-Plug-in Prints query formed


Batch Size entered: {0}

Debug BW-Plug-in Message is shown for SAPHANA Database Insertactivity and prints batch size.


Maximum rows entered: {0}

Debug BW-Plug-in Message is shown for SAPHANA Database Queryactivity and prints maximumrows entered.

42




No input received for

activity : {0}

Warn BW-Plug-in Message is shown for SAPHANA Database Insertactivity and SAP HANADatabase Update activity ifno input is received forvalues node.


Unexpected error occurred.{0}

Error BW-Plug-in Message is shown when anunidentified error occurswhile executing the activity.


Failed to initialize activity.

{0}\nActivity

Name={1}\nProcess={2}\nModule

={3}\nDeploymentUnit={4}:{5}

Error BW-Plug-in Message is shown wheninitialization fails for anactivity.


Failed to decrypt obfuscated

password for field : {0}

Error BW-Plug-in Message is shown whendecryption of obfuscatedpassword fails.


Failed to connect SAP HANA

Database. {0}

Error BW-Plug-in Message is shown whenconnection with SAP HANADatabase is not successful.


Failed to create Prepared

Statement.{0}

Error BW-Plug-in Message is shown whenprepared statement creationfails.


Failed to set max rows.{0}

Error BW-Plug-in Message is shown for SAPHANA Database Queryactivity if error occurs whensetting maximum rows.


Failed to set parameters in

prepared statement.{0}

Error BW-Plug-in Message is shown when erroroccurs while settingparameters in preparedstatement.

43




Failed to retrieve values from

ResultSet.{0}

Error BW-Plug-in Message is shown for SAPHANA Database Queryactivity if error occurs whenretrieving values fromResultSet.


Failed to execute query: {0}\n

Error Message: {1}

Error BW-Plug-in Message is shown when erroroccurs in executing a query.


Failed to close ResultSet.{0}

Error BW-Plug-in Message is shown for SAPHANA Database Queryactivity if error occurs inclosing a ResultSet.


Failed to close Prepared

Statement.{0}

Error BW-Plug-in Message is shown when erroroccurs in closing preparedstatement.


Failed to close SAP HANA

Database Connection. {0}

Error BW-Plug-in Message is shown when erroroccurs in closing closingconnection.


Error occurred when generating

XML Output for activity. {0}

Error BW-Plug-in Message is shown when erroroccurs while generatingoutput for an activity.


Invalid number of maximum rows

entered in Activity: {0}.

Value must be greater than or

equal to 0, value was {1}

Error BW-Plug-in Message is shown for SAPHANA Database Queryactivity if you input negativevalue for maximum rows.

44




Invalid number of batch size

entered in Activity: {0}.

Value must be greater than 0,

value was {1}

Error BW-Plug-in Message is shown for SAPHANA Database Insertactivity if you input anegative value or zero forbatch size.


{0}

Error BW-Plug-in Message is shown for SAPHANA Database Insertactivity if insert of one ormore records fails.

TIBCO-BW-SR-SAP_HANA_DATABASE_JDBC_CONNECTION-200001

Creating Shared Resource {0}

Debug BW-Plug-in Message is shown whilecreating the shared resource.

TIBCO-BW-SR-SAP_HANA_DATABASE_JDBC_CONNECTION- 200002

Starting Shared Resource {0}

Debug BW-Plug-in Message is shown whileexecuting the sharedresource.


Stopping Shared Resource {0}.

Debug BW-Plug-in Message is shown whilestopping the shared resource.


Deleting Shared Resource {0}.

Debug BW-Plug-in Message is shown whiledeleting the shared resource.


Number of thread is {0}

Debug BW-Plug-in Message is shown to printnumber of thread.


Minimum pool size is {0}

Debug BW-Plug-in Message is shown to printminimum pool size.


Maximum pool size is {0}

Debug BW-Plug-in Message is shown to printmaximum pool size.

45




Connection pool initialized

for Shared Resource {0}

Debug BW-Plug-in Message is shown whileinitializing connection pool


Connection pool destroyed for

Shared Resource {0}

Debug BW-Plug-in Message is shown whiledestroying connection pool.


Number of thread is invalid,

default to 8

Warn BW-Plug-in Message is shown whennumber of thread entered isless than 1.


Invalid minimum pool size

entered. Value must be greater

than or equal to 0, value was

{0}, defaulted to 0

Warn BW-Plug-in Message is shown whenminimum pool size entered isless than 0.


Invalid maximum pool size

entered. Value must be greater

than 0, value was {0},

defaulted to {1}

Warn BW-Plug-in Message is shown whenmaximum pool size is lessthan 1.


Minimum pool size: {0} should

be less than or equal to

Maximum pool size: {1}.

Setting Maximum pool size to

{2}

Warn BW-Plug-in Message is shown whenminimum pool size is greaterthan maximum pool size.



failed due to [{1}]

Error BW-Plug-in Message is shown when erroroccurs during creation ofshared resource.

46








Failed to initialize

connection pool for Shared

Resource : {0} {1}

Error BW-Plug-in Message is shown whenconnection pool initializationfails.


Failed to close SAP HANA

Database Connection.{0}

Error BW-Plug-in Message is shown when erroroccurs in closing connection.


Failed to destroy connection

pool for Shared Resource: {0}

{1}

Error BW-Plug-in Message is shown when erroroccurs in destroyingconnection pool.

Error Codes for SAP HANA Database OData Palette


TIBCO-BW-PALETTE-SAP_HANA_DATABASE_ODATA-100001

{0}

Trace BW-Plug-in Message is shown whileprinting events for activity.


\nStart of the Activity {0},

service {1}, operation {2}

\nInput received: \n {3} \n

Debug BW-Plug-in Prints activity input.


\nActivity {0}, service {1},

operation {2} Output data: \n

{3} \n Exit of Activity {4}

Debug BW-Plug-in Prints activity output.

47




HTTP Request URL: {0},

Activity Name={1},

Process={2}, Module={3},

DeploymentUnit={4}:{5}.

Debug BW-Plug-in Prints HTTP request URL.


\nJSON input for service: {0},

operation: {1}, Activity

Name={2}, Process={3},

Module={4},

DeploymentUnit={5}:{6} \n{7}

Debug BW-Plug-in Prints JSON input sent to theSAP server for POST andPUT operation.


Unexpected error occurred.{0}

Error BW-Plug-in Message is shown when anunidentified error occurswhile executing an activity.

TIBCO-BW-PALETTE-SAP_HANA_DATABASE_ODATA--500002

Failed to initialize

ConsumeSAPHANADatabaseODataSer

vice activity.{0}\nActivity

Name={1}\nProcess={2}\nModule

={3}\nDeploymentUnit={4}:{5}.

Error BW-Plug-in Message is shown when thereis an initialization of anactivity fails.

TIBCO-BW-PALETTE-SAP_HANA_DATABASE_ODATA--500003





Failed to access output

schema.{0}

Error BW-Plug-in Message is shown when thereis an error while accessingschema.


Failed to read metadata

information.{0}

Error BW-Plug-in Message is shown when thereis an error while reading themetadata.

48




Failed to read the

record.\nURL: {0}{1}

Error BW-Plug-in Message is shown when thereis an error while reading therecord through GEToperation.


Failed to read the feed.\nURL:

{0}{1}

Error BW-Plug-in Message is shown when thereis an error while reading thefeed through GET operation.


Failed to create the


Error BW-Plug-in Message is shown when thereis an error while creating therecord through POSToperation.


Failed to update the


Error BW-Plug-in Message is shown when thereis an error while updating therecord through PUToperation.


Failed to delete the

record.\nURL: {0}\nError

Message: {1}

Error BW-Plug-in Message is shown when thereis an error while deleting therecord through DELETEoperation.


Failed to process data type

{0} for value {1}.{2}

Error BW-Plug-in Message is shown when thereis an error while processingdifferent data types.


Incorrrect URL {0} for {1}

operation

Error BW-Plug-in Message is shown whenincorrect or malformed URLis used for HTTP connection.


Failed to connect to URL {0}

Error BW-Plug-in Message is shown when thereis an error while establishingthe HTTP connection.

49




Entity data model error.{0}

Error BW-Plug-in Message is shown when thereis error while processing datain the third party library.


I/O error.{0}

Error BW-Plug-in Message is shown when thereis I/O error.


Error occurred when generating

XML Output for activity. {0}.

Error BW-Plug-in Message is shown when anerror occurs while generatingan output for an activity


Record not found.\nURL: {0}

Error BW-Plug-in Message is shown when norecord is found through GEToperation.

TIBCO-BW-SR-SAP_HANA_DATABASE_ODATA_CONNECTION-200001

Creating Shared Resource {0}.

Debug BW-Plug-in Message is shown whilecreating the shared resource.

TIBCO-BW-SR-SAP_HANA_DATABASE_ODATA_CONNECTION- 200002

Starting Shared Resource {0}.

Debug BW-Plug-in Message is shown whileexecuting the sharedresource.


Stopping Shared Resource {0}.

Debug BW-Plug-in Message is shown whilestopping the shared resource.


Deleting Shared Resource {0}.

Debug BW-Plug-in Message is shown whiledeleting the shared resource.


Number of thread is {0}.

Debug BW-Plug-in Message is shown to printnumber of thread.

50




Number of thread is invalid,

default to 8.

Warn BW-Plug-in Message is shown wheninput for number of threadsis invalid.



failed due to [{1}].

Error BW-Plug-in Message is shown when erroroccurs while creating ashared resource.

51


Documents

Plug-in for SAP HANA Database TIBCO ActiveMatrix ...€¦ · Getting Started. This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks ™ Plug-in for