tibco activematrix businessworks™ plug-in for siebel user ......license agreement, the license(s)...

TIBCO ActiveMatrix BusinessWorks™

Plug-in for SiebelUser's GuideSoftware Release 7.0October 2017

Two-Second Advantage®

Important Information

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

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

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

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

TIBCO, the TIBCO logo, Two-Second Advantage, TIB, Information Bus, Rendezvous, TIBCORendezvous, and TIBCO Messaging Appliance are either registered trademarks or trademarks ofTIBCO Software Inc. in the United States and/or other countries.

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

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

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

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

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

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

2

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

Copyright © 2017 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

3


Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Comparison between Adapter and Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Supported and Non-supported Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Siebel Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

User Interface Elements in the Siebel Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Creating a Siebel Connection using the Siebel Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Siebel Objects Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

User Interface Elements in the Siebel Objects Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Creating a Siebel Schema using the Siebel Objects Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Examples Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Siebel Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Invoke Business Object Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Sample Plugin Project for Invoke Business Object Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Sample Plug-in Project to show the Parent-Child Relationship using Invoke Business Object Activity . . . . . . . . . . . . . . . 36


Invoke Business Service Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Sample Plugin Project for Invoke Business Service Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40


Invoke Integration Object Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Sample Plugin Project for Invoke Integration Object Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44


Invoke Workflow Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Sample Plugin Project for Invoke Workflow Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46


Management of Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4


Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Setting up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

5


Figures

Siebel Connection - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Siebel Connection - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Siebel Objects Editor - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Siebel Objects Editor - Siebel Objects Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Console View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Example for Invoke Business Object Activity Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Example for Parent-Child Relationship using the Invoke Business Object Activity Process . . . . . . . . . . . . . . . . . . . . . . . . .36

Example for Establishing Parent-Child Relationship using Siebel Objects Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Example for Invoke Business Service Activity Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Example for Invoke Integration Object Activity Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Example for Invoke Workflow Activity Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

6


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-siebel. To directly access documentation for this product, double-click the following file:

TIBCO_HOME/release_notes/TIB_bwpluginsiebel_version_docinfo.html

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

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel Installation

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel Release Notes

The following documents provide additional information and can be found on the TIBCODocumentation site:

● TIBCO ActiveMatrix BusinessWorks documentation

● TIBCO Enterprise Administrator User's Guide

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.

7


https://docs.tibco.com

https://docs.tibco.com

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

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

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

https://support.tibco.com

https://support.tibco.com

https://ideas.tibco.com/

https://community.tibco.com

Product Overview

TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel is a bridge between TIBCO ActiveMatrixBusinessWorks and the Siebel server.

TIBCO ActiveMatrix BusinessWorks is a leading integration platform that can integrate a wide varietyof technologies and systems within enterprise and on cloud. TIBCO ActiveMatrix BusinessWorksincludes an Eclipse-based graphical user interface (GUI) provided by TIBCO Business Studio™ fordesign, testing, and deployment. If you are not familiar with TIBCO ActiveMatrix BusinessWorksbefore using the plug-in. See the TIBCO ActiveMatrix BusinessWorks documentation for more details.

TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel plugs into TIBCO ActiveMatrix BusinessWorksand adds the Siebel Palette to TIBCO Business Studio. You can create a connection between the plug-inand a Siebel server, and then configure a process that performs the activities in the Siebel palette. Seethe topic Getting Started for more details about how to use the plug-in.

TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel provides the following activities:

● InvokeBusinessObject Activity

● InvokeBusinessService Activity

● InvokeIntegrationObject Activity

● InvokeWorkflow Activity

8


Comparison between Adapter and Plug-in

This topic is useful for users, who have previously used the TIBCO ActiveMatrix® Adapter for Siebel, tohelp understand differences in the plug-in where supported features have overlap with adapter.

Comparison between Adapter for Siebel and Plug-in for Siebel

FeatureTIBCO ActiveMatrix® Adapterfor Siebel

TIBCO ActiveMatrixBusinessWorks™ Plug-in forSiebel

Service Provided Publication service, Suscriptionservice, Request-Responseservice, and Request-ResponseInvocation service.

The plug-in is a replacement ofthe Siebel Adapter and the AEPalette available in TIBCOBusinessWorks. The activitesprovided in the plug-in aresimilar to the Server Typesavailable in the SiebelAdapter's Request-Responsewith an Invoke Adapter Serviceactivity.

Transport Type RV and JMS The plug-in is native to TIBCOBusinessWorks and no longerrequires messaging.

TRA Properties TRA properties are maintainedin TIBCO Administrator and/oradsbl.tra file.

TRA properties are notapplicable in plug-in.

UAN Schema Support Supported XML message is native toTIBCO BusinessWorks anddoes not require anyconfigurations. Any replyschema would automatically bein XML format.

Reply Schema, RequestSchema, and CustomAESchema

Custom schema supported Custom schema not supported.

Invoke Workflows Integration Object and Non-Siebel Event supported

Integration Object supported.

Parent-Child Schemas Business Object and IntegrationObject supported

Business Object supported.

Non-Siebel BusinessComponents

Supported Not supported

Errors from Siebel Server Reply message containsinformation on error fromSiebel Server

Fault message is created.

9


FeatureTIBCO ActiveMatrix® Adapterfor Siebel

TIBCO ActiveMatrixBusinessWorks™ Plug-in forSiebel

Schema Management Schemas are maintainedrelative to connection objectused during download ofschema.

Schemas are maintainedrelative to the Schema SharedResource.

Server Request andAsynchronous WorkflowRequest


Connection Transport Types TCP/IP and HTTP aresupported

TCP/IP is supported

Connection Connection configuration isfrom the Adapter service.

Connection configuration isfrom the Siebel Connectionshared resource maintained inthe Siebel Schema sharedresource referenced by theplug-in activity.

Schema: Literal Match, AEMessage Field, Formatted,Default


10


Supported and Non-supported Data Types

The following is the complete list of data types, some that are supported and some that are notsupported by TIBCO ActiveMatrix BusinessWorks Plug-in for Siebel.

Data Type Description Supported?

DTYPE_BOOL Data is stored as Y or N. It is displayed as TRUEor FALSE and checked or unchecked.

Supported

DTYPE_CURRENCY Data is stored as currency. Supported

DTYPE_DATE Data is stored as date. Supported

DTYPE_DATETIME Data is stored as date and time. Supported

DTYPE_UTCDATETIME Data that includes both the date and the timecomponent is stored in the database in UTC time(UTC is GMT excluding adjustments for daylightsavings time)

Supported

DTYPE_ID Contains primary key data, which isautomatically generated by the application.

Supported

DTYPE_INTEGER Data is stored as whole numbers. The range spans-2147483647 to 2147483647.

Supported

DTYPE_NOTE Data is stored as a long string. The string sizecannot exceed a size of 16 KB. If the length is notexplicitly defined the default length is 16 KB.

NotSupported

DTYPE_NUMBER Data is stored as a number. Supported

DTYPE_PHONE Data is stored as a phone number. Supported

DTYPE_TEXT Data is stored as a string. The string size cannotexceed a size of 2000 bytes. The default size is 255.

Supported

DTYPE_TIME Data is stored as time. NotSupported

11


Getting Started

This tutorial is designed for the beginners who want to use TIBCO ActiveMatrix BusinessWorks Plug-infor Siebel in TIBCO Business Studio.All the operations are performed in TIBCO Business Studio. See the topic TIBCO Business StudioOverview to familiarise yourself with TIBCO Business Studio.

Procedure

1. Creating a Project

2. Creating a Siebel Connection using the Siebel Connection Resource

3. Configuring a Process

4. Testing a Process

5. Deploying an Application

TIBCO Business Studio Overview

TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resourcesin your workspace. A workspace is the central location on your machine where all data files are stored.

The workbench consists of:

1. Menu: contains menu items such as File, Edit, Diagram, Navigate, Search, Project, Run, Window,and Help.

2. Toolbar: contains buttons for frequently used commands such as New , Save , Enable/

Disable Business Studio Capabilities , Create a new BusinessWorks Application Module ,

Create a new BusinessWorks Shared Module , Debug , Run , and so on.

12


3. Perspective: contains an initial set and layout of views that are required to perform a certain task.TIBCO Business Studio launches the Modeling perspective by default. You can change theperspective from the menu Window > Open Perspective > Perspective_Name.

4. View: displays resources. For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in your workspace, and the Propertiesview displays the properties for the selected resource. You can open a view from the menu Window> Show View > View_Name.

5. Editor: provides a canvas to configure, edit, or browse a resource. Double-click a resource in a viewto open the appropriate editor for the selected resource. For example, double-click an ActiveMatrixBusinessWorks process businessobject.bwp in the Project Explorer view to open the process in theeditor.

6. Palette: contains a set of widgets and a palette library. A palette groups activities that perform similartasks, and provides quick access to activities when 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.

Procedure

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

● On Microsoft Windows, click Start > All Programs > TIBCO > Studio for Designers● On Mac OS and 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, click BusinessWorks Application Module and click Next to open theNew BusinessWorks Application Module wizard.

4. In the Project dialog, 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.

13


Result

Siebel Connection ResourceThe Siebel Connection is a shared resource that you should use to establish a connection from theActiveMatrix BusinessWorks Plug-in to the Siebel Repository or Siebel Server.

● User Interface Elements in the Siebel Connection Resource

● Creating a Siebel Connection using the Siebel Connection Resource

User Interface Elements in the Siebel Connection ResourceThe user interface elements, and their description, in the Siebel Connection resource are as follows:

Configuration Tab

Siebel Connection - Configuration Tab

14


Siebel Connection - General Fields

Field Descritpion

Package When you create a new Siebel Connection usingthe Siebel Connection Wizard, the value enteredfor the Package field will be displayed for thisfield. For details see the topic Create a SiebelConnection using the Siebel ConnectionResource.

The hyperlink that shows the count ofSiebel Connection references, does notconsider the reference that exists inthe Siebel Objects Editor.

Name When you create a new Siebel Connection usingthe Siebel Connection Wizard, the value enteredfor the Resource Name field will be displayedfor this field. For details see the topic Create aSiebel Connection using the Siebel ConnectionResource.

If the name of the Siebel Connectionshared resource is changed, it does notget automatically updated in theSiebel Objects Editor.

Description Provide a description for the connection that willbe established,

Siebel Connection - Configuration Fields

Field Descritpion

Host The name, or the IP address, of the machine onwhich the Siebel server is installed. The formatof the host name should be <HostName or IPAddress:Port Number>. For example,MySiebelServerHost:7666.

Enterprise Server The Siebel Enterprise under which the SiebelServer is installed.

Object Manager The name of the Application Object Managerthat you want to access. This can be a user-defined component or one of the followingpredefined components: SCCObjMgr_enu,SSEObjMgr, ISSObjMgr, SSVObjMgr. Foradditional information, see the "AdministrationGuide of the Siebel Server".

15


Field Descritpion

Language Select the language to be used while connectingto the Siebel application from the drop-downlist. Some of the possible values are enu, chs,cht, csy, and dan. You should provide the samevalue given at the time of the Siebel applicationsinstallation.

Currently only enu-English(American) is supported.

Transport The method of transport. Currently only TCP/IPis supported.

Encryption Select whether encryption has to be performedor not. Encryption, if performed, will be done inthe RSA method. The default value is None. Toget connected in the RSA mode, you have tomake the corresponding change in the SiebelServer setup. Additionally, your Siebel Setupshould be capable of working in RSA mode.

Compression Specify the type of compression that should beused for network communication. The defaultvalue is ZLIB. When using Resonate, ifcompression is required on the client as well asthe server side, it must be specified for the clientas well as the server side. The server, and theclient, will compress the communication asdefined by you. If you do not use Resonate, theserver drives the compression and the client-sidesettings will be ignored.

User Name Specify the username for the account to accessthe application. For example, sadmin.

Password Specify the password for the account to accessthe application.

Maximum Number of Reconnect Attempts Specify the maximum number of reconnectattempts that should be performed in case oftemporary or permanent network failure. Thedefault value is -1 and it indicates that thereconnect attempt will be indefinite.

Interval between Reconnect Attempts(ms) Specify the interval between reconnect attempts(in milliseconds)

Test Connection A button, when clicked, checks the connectionbetween the plugin and the Siebel server.

16


Advanced Tab

Siebel Connection - Configuration Tab

Siebel Connection - Trace Configuration Fields

Field Descritpion

Enable SQL Siebel Trace Select this check box if you want to enable SQLSiebel trace.

SQL Trace File Provide the name of the Log file to store the SQLtrace. The log file will get generated at the Siebelserver.

Creating a Siebel Connection using the Siebel Connection ResourceAfter creating a project, you have to add a Siebel Connection shared resource to create a connectionbetween the plug-in and the Siebel server.

Prerequisites

The Siebel Connection shared resource is available at the Resources level. Ensure that you have createda project, as described in the topic Creating a Project.

See the topic User Interface Elements in the Siebel Connection Resource to know more about the fieldsand their descriptions.

Procedure

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

2. Right-click the Resources folder and click New > Siebel Connection to open the Siebel Connectionwizard.

3. The Resource Folder, Package Name, and the Resource Name fields are provided by default. If you donot want to use the default configurations, change them accordingly. Click the Finish button to openthe Siebel Connection resource.

4. Provide values for the following fields in the General section of the Configuration tab.

17


● Description

5. Provide values for the following fields in the Siebel Connection Configuration section of theConfiguration tab.

● Host - Mandatory field

● Enterprise Server - Mandatory field

● Object Manager - Mandatory field

● Language

● Transport

● Encryption

● Compression

● User Name - Mandatory field

● Password - Mandatory field

● Maximum Number of Reconnect Attempts

● Interval between Reconnect Attempts(ms)

6. If you want to enable SQL Trace, perform the following steps:a) Click the Advanced tab.b) Select the Enable SQL Siebel Trace check box.c) In the SQL Trace File field enter the name of the Log file for storing the SQL trace.d) Click the Configuration tab to take the control back to the Configuration tab.

7. Click the Test Connection button to check whether the connection has been successfully establishedor not. If the connection is unsuccessful, make the necessary changes and test the connection again.

Siebel Objects EditorThe Siebel Objects Editor is schema editor which is used to define the schema or the object andcomponents of Siebel that will be utilized by the ActiveMatrix BusinessWorks Plug-in to the Siebelsystem.

Only two objects are supported. They are:

● Business Object

● Integration Object

If you create a copy of Sample.sblObject and rename it to Sample1.sblObject, the renamed copydoes not behave like an isolated copy because it continues to reference the activities of the original.

18


User Interface Elements in the Siebel Objects EditorThe user interface elements, and their description, in the Siebel Objects Editor are as follows:

Configuration Tab

Siebel Objects Editor - Configuration Tab

Configuration Tab Fields

Field Descritpion

Name Name of the Siebel schema object.

Description Add a description for the Siebel schema object.

SiebelConnection

Mandatory Field.

Select a Siebel connection from the available list. To create a Siebel connection seethe topic Create a Siebel Connection using the Siebel Connection Resource formore details.

19


Siebel Objects Tab

Siebel Objects Editor - Siebel Objects Tab

Siebel Objects Tab Fields

Field Descritpion

Business Objects Use this component to add Business objects. For more details on adding Businessobjects see the topic Creating a Siebel Schema using the Siebel Objects Editor.

IntegrationObjects

Use this component to add Integration objects. For more details on addingIntegration objects see the topic Creating a Siebel Schema using the SiebelObjects Editor.

Creating a Siebel Schema using the Siebel Objects EditorAfter establishing a connection with the Siebel server you need to setup a Siebel schema or Siebelobjects reference using the Siebel Objects editor.

Prerequisites

The Siebel Connection shared resource is available at the Resources level. Ensure that you have createda project, as described in the topic Creating a Project.

See the topic User Interface Elements in the Siebel Objects Editor to know more about the fields andtheir descriptions.

Procedure

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

2. Right-click the TIBCO Resource folder and click New > Other.

3. Click TIBCO Resource > Siebel Object Editor > Next.The Create Siebel Objects dialog is displayed.

4. Enter an appropriate name for the Name field and click the Finish button.The Siebel Objects Editor opens.

5. Click the select siebel connection resource button.The Siebel Connection dialog box is displayed.

20


6. Select an appropriate connection and click the OK button.The control passes back to the Siebel Objects Editor.

7. Click the Siebel Objects tab and select any

8. The following objects are available:

21


Siebel ObjectName Details

Business Objects1. Right-click the Business Objects and click Add Business Object. The

Select Business Component dialog is displayed.

2. Type in the object name you want to locate and the matching object namewill be displayed in the Business Objects textarea and the BusinessComponents textarea will get populated on the basis of the selectedBusiness Objects. By default, the Business Objects field is selected firstand accordingly the Business Components field gets populated.

3. Select an appropriate value for the Business Objects field and theBusiness Components field and click the OK button.

The Business Objects name is case-sensitive.

4. Right click the newly added business object and you get the followingoptions:

● Add Business Component- Click this option to add a sub businesscomponent.

● Add MVL-

Currently this option is not supported.

● Remove- Click this option to delete the added business component.

5. Click the Fetch Fields button to fetch all the fields for the businesscomponent from the Siebel server.

6. ● The basic operations can be performed only if the fieldshave been fetched from the previous step.

● For the downloaded schema, the filter option is case-sensitive and it will generate different results for the samestring of different patterns. For example, Filter account*and Filter Account* will generate different results.

You can perform the the following two basic operations:

● Click Select All to select all the fields

● Click Deselect All to deselect all the selected fields.

7. You can also perform the following advanced operations:

● Click Show All to display all the fields

● Click Show Used to display only the fields selected by you

● Click Show Required to display the fields with Required column setto Yes.

● Click Show Readonly to display fields with Readonly column set toYes.

● Click Show Calculated to display fields with Calculated column setto Yes.

● Click Show MVG to display fields where MVG has some value.

22



Currently this option is not supported.

23



BusinessComponentFields

The following list of fields are the column fields for the business component.If you select any of the following fields they get included in the schema forperforming the operation through the activity.

● Use- The Siebel field to be included.

● Key- Fields defined as user keys combine to uniquely define a Siebelrecord for a Business Component. Check the checkbox next to a SiebelBusiness Component or field to define it as a user key. All fields that youselect as user keys combine to uniquely define a Siebel record for aBusiness Component. For example, the Account Name and Location canbe selected as user keys to uniquely define an Account in the Siebelsystem.

Key field is ignored if you perform the Query operation.

● Field Name- Displays the name of the Siebel field.

● Match Field- The name of the parent Business Component field. Thisparent name defines the parent of the parent-child relationship for all itssecondary Business Components.

The name of the parent Business Component field. The parent namedefines the parent of a parent-child relationship for all its secondaryBusiness Components. The value you specify in the Match Field column,for a primary Business Component, is used as the default search criteriato create or retrieve the parent and corresponding chid component.

In the case of secondary Business Components, the match fieldestablishes the relationship with the parent Business Component to allowthe plugin to retrieve a subset of the child records related to theparticular parent component.

For example, if the match field for the Account field of Contact is set tomatch the value for the Name field of the parent Account, you canretrieve the list of contacts related to the Account.

Match Field is only supported for single parent-childrelationship.

● Read Only- The Siebel field is designated as a Read Only in the Siebelrepository. Read Only fields cannot be subscribed.

● Required- The Siebel field is designated as a Required field in the Siebelrepository.

● Calculate- The Siebel field is computed based on other Siebel fields. Acalculated field cannot be subscribed.

● MVG- The Siebel field belongs to a Siebel Multi Value Group.

Currently MVG is not supported.

● MVL- Name of the Siebel Multi Value Link for the field in the aboveMulti Value Group. A Multi Value field cannot be subscribed. Tosubscribe to a MVL field, a child MVL Business Component is required.

Currently MVL is not supported.

24



● Pick List- Name of the Pick List if the field is controlled by a Siebel PickList component.

● Type- Name of the Siebel data type.

● Hidden- To be selected if the Siebel field is designated as a Hidden fieldin the Siebel repository. A hidden field cannot be subscribed.

● Inactive- To be selected if the Siebel field is inactive in the Siebelrepository. Inactive fields are unavailable for users. You cannot changethe configuration.

25



IntegrationObjects 1. Right-click the Integration Objects and click Add Integration Object.

The Select Integration Component dialog is displayed.

2. Type in the object name you want to locate and the matching object namewill be displayed in the Integration Objects textarea and the IntegrationComponents textarea will get populated on the basis of the selectedIntegration Objects. By default, the Integration Objects field is selectedfirst and accordingly the Integration Components field gets populated.

The Integration Object name is case-sensitive.

3. Select an appropriate value for the Integration Objects field and theIntegration Components field and click the OK button.

4. Right click the newly added integration object and you get the followingoptions:

● Add Integration Component- Click this option to add a subintegration component.

● Remove- Click this option to delete the added integrationcomponent.

5. Click the Fetch Fields button to fetch all the fields for the integrationcomponent from the Siebel server.

6. ● The basic operations can be performed only if the fieldshave been fetched from the previous step.

● For the downloaded schema, the filter option is case-sensitive and it will generate different results for the samestring of different patterns. For example, Filter account*and Filter Account* will generate different results.

You can perform the the following two basic operations:

● Click Select All to select all the fields

● Click Deselect All to deselect all the selected fields.

7. You can also perform the following advanced operations:

● Click Show All to display all the fields

● Click Show Used to display only the fields selected by you

● Click Show Required to display the fields with the Requiredcolumn set to Yes.

● Click Show Inactive to display the fields with the Inactive columnset to Yes.

26



IntegrationComponentFields

The following list of fields are the column fields for the integrationcomponent. If you select any of the following fields they get included in theschema for performing the operation through the activity.

● Use- If you select this field the integration field gets included in theintegration components schema for the plug-in service.

● Name- Displays the name of the integration components field.

● XML Tag- The XML name of the integration field in the Siebel repository.This is a display field.

● Required- When displayed as selected, the Siebel integration field isdesignated as a Required field in the Siebel repository. This is a displayfield, the values for this field are provided from Siebel.

● Inactive- If you select this field it indicates that the integration field isinactive in the Siebel repository. Inactive fields are unavailable for users.Users cannot change the configuration.

● User Key- Displays the name of the user key field in the Siebel repositoryof which this field is a part.

In Siebel, integration component fields are grouped together as user keys. Itassists in identifying a single record in an integration component for anintegration object. There may be multiple user keys for a single integrationcomponent. Each field can be present in the multiple user keys. The palettedoes not display all the information required for user keys. Please verifywith the Siebel Tools to ensure you select the proper user key.

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

Prerequisites

● Ensure that you have created an empty process when creating a project. For more details see thetopic Creating a Project.

● Ensure that the Siebel connection is created and established. See the topic Creating a SiebelConnection using the Siebel Connection Resource for more details.

● Ensure that the Siebel Object schema is created using the Siebel Objects editor. See the topic Creatinga Siebel Schema using the Siebel Objects Editor for more details.

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 Timer activity from the General Activities palette and theInvokeBusinessObject activity from the Siebel palette.

None of the Siebel plugin activities are starter activities. To execute the Siebel pluginactivities you need to use a starter activity like timer from the General section.

27


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

4. Configure the added Siebel activity, as described in the topic Siebel Palette.

A Siebel connection is required when configuring the Siebel activities. See the topic Creating a Siebel Connection using the Siebel Connection Resource for more details onhow to create a Siebel connection.

5. Select the operation that you want to perform.

6. Select the Business Component schema using the picker.

7. Provide values in the Input tab.

8. Click File > Save to save the project.

Testing a ProcessAfter configuring, you have to 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 the 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 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.

Console View

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

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

28


Result

Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process into a runtime environment, and then use the bwadmin utility to manage thedeployed application.

Before deploying an application, you must generate an application archive, which is an enterprisearchive (EAR) file that is created in TIBCO Business Studio. See TIBCO Business Studio for moreinformation.

Deploying an application involves the following tasks:

1. Uploading an application archive

2. Deploying an application archive

3. Starting an application

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

29


Examples Overview

The examples shipped with TIBCO ActiveMatrix BusinessWorks™ Plug-in for Siebel demonstrate thebasic usage of the plug-in.

After installing the plug-in, you can find a sample project in the TIBCO_HOME/bw/palettes/siebel/version_number/samples directory. The sample project is compressed to a ZIP file. Before running asample project, you have to import it. For more information, see Importing Sample Projects.

The sample project contains examples for the following components:

● sample_plugin_project.businessobject

This component shows how to perform the Insert, Upsert, Query, and Delete operations using theInvoke Business Object activity.

For more information, see the Sample Plugin Project for Invoke Business Object Activity topic.

● sample_plugin_project.businessservice

This component shows how to perform the Insert, Upsert, Update, Query, and Delete operationsusing the Invoke Business Service activity.

For more information, see the Sample Plugin Project for Invoke Business Service Activity topic.

● sample_plugin_project.integrationobject

This component shows how to perform the Insert, Upsert, Update, Query, and Delete operationsusing the Invoke Integration Object activity.

For more information, see the Sample Plugin Project for Invoke Integration Object Activity topic.

● sample_plugin_project.parentChild_businessObject

This component shows how the parent-child relationship is established using the Invoke BusinessObject Activity by performing Insert, Upsert, and Query operations and passing the logged detailsto the Log file.

For more information, see the Sample Plug-in Project to show the Parent-Child Relationship usingthe Invoke Business Object Activity topic.

● sample_plugin_project.workflow

This component shows how to perform the Insert and Delete operations using the Invoke Workflowactivity.

For more information, see the Sample Plugin Project for Invoke Business Workflow topic.

Importing Sample ProjectsBefore running a sample project, you have to import it to TIBCO Business Studio™.

Procedure

1. Start TIBCO Business Studio.

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

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

4. In the Import Projects dialog, click Select archive file, and then click Browse next to it to locate asample project. For example, select the siebel_plugin_examples.zip file, and then click Open.

30


The sample projects are located in the TIBCO_HOME/bw/palettes/siebel/version_number/samples directory.

5. Click Finish.

After importing the examples, if you create a copy of Sample.sblObject and rename it toSample1.sblObject, the renamed copy does not behave like an isolated copy because itcontinues to reference the activities of the original.

Result

The siebel_plugin_examples project is imported to TIBCO Business Studio.

Importing Sample Projects

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

Prerequisites

You have to import the sample_plugin_examples project before setting it up. For more information, seethe Importing Sample Projects topic.

Procedure

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

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

3. The values are stored here. You can modify the values if needed.

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

31


Siebel Palette

The Siebel palette contains the following activities:

● Invoke Business Object Activity

● Invoke Business Service Activity

● Invoke Integration Object Activity

● Invoke Workflow Activity

Invoke Business Object ActivityYou can use the InvokeBusinessObject Activity to select and configure the Siebel business object orcomponent to perform the insert, upsert, delete, and query operations using the Siebel fields.

General

The following table lists the configurations in the General tab of the Invoke Business Object activity:

FieldModuleProperty? Description

Name The name of the activity will be displayed.

Siebel Connection Yes Specify the Siebel Connection type that should beused. See the topic Creating a Siebel Connectionusing the Siebel Connection Resource for moredetails.

1. Click the search icon. A dialog box is displayedlisting the connections.

2. Select an appropriate connection.

32



Operation Specify the operation that has to be performed usingthe activity. The following operations can beperformed using the activity:

● Insert- for inserting a new record

● Upsert- for inserting a record if the record doesnot exist or for updating a record if it exists.

● Delete- for deleting an existing record

● Query- for querying or searching a record orrecords

● The operations Insert, Upsert, andDelete will be performed even if userselects and provides the values for theHidden, Inactive, Calculated, and theRead only fields. There will not be anychanges on the Siebel server for thesefields.

● The Upsert operation cannot beperformed on multiple records andalso on records having parent-childrelationship. In both cases an exceptionis displayed.

● If the Delete operation finds multiplerecords, it deletes all the recordswithout prompting you for aconfirmation. For example, if youprovide an input of a* and performthe delete operation, all recordsstarting from the letter a gets deleted.

● If you Query multiple records at theparent level, only the first parentrecord will have the child record in theoutput.

● If you execute a Query operationwithout input values provided to theselected fields, an error is displayed onthe console.

● If a parent-child relationship exists, theDelete operation is not performed.

33



Siebel Object Reference Only the Business Object is supported bythis activity.

Specify the object for reference created using thesiebel objects editor. See the topic Creating a SiebelSchema using the Siebel Objects Editor for moredetails.

1. Click the search icon. The Siebel Business Objectdialog is displayed.

2. Select an appropriate object.

Description

In the Description tab, you can enter a short description for the Invoke Business Object activity.

Input

The values in the Input tab will be populated based on the object selected in the Siebel ObjectReference field.

Duplication or adding multiple Item fields in the Input tab is not allowed as Siebel supports only asingle parent or a single parent-child relationship in the nodes.

Output

If the Query operation is successful, the data received from Siebel server gets displayed on the Outputtab.

For the Invoke Business Object activity only the status and Object ID are displayed as the output. If theprocess executes without any error, it will show the ID, which is received from the Siebel server. If theprocess fails a Fault will be generated. The error or an exception will be displayed in the Fault tab.

Fault

In the Fault tab, you can find the error message and error message code of the Invoke Business Objectactivity. See the Error Codes topic for more detailed explanation of errors.

The following table lists the error schema elements in the Fault tab of the Invoke Business Objectactivity:

Error Schema Element Data Type Description

SiebelPluginException String Exceptions like key field validation, match fieldvalidation, etc will be displayed.

SiebelJDBException String Will display an exception related to the Siebeloperation. The exception will be generated eitherby the Siebel server or due to operation failure.

34


Sample Plugin Project for Invoke Business Object ActivityYou can use the example businessobject.bwp to understand how the Invoke Business Object activitybehaves. The example shows the Insert, Upsert, Query, and Delete operation on the business object.

The following figure describes the Invoke Business Object activity process:

Example for Invoke Business Object Activity Process

The Invoke Business Object Activity process perfoms the following operations:

● The Insert operation inserts the value for the field or fields that are defined in the schema.

● The Upsert operation upserts the value for the field or fields that are defined in the schema. TheUpsert operation inserts the value for the fields that are defined in the schema if the record does notexist, and updates the value for the fields if the record exists.

● The Query operation queries or searches the the field or pattern that is defined in the schema.

● The Delete operation deletes the value for the field, or fields that are defined in the schema.

Running the ProjectTo run the project for the Invoke Business Object activity process, perform the following steps:

Procedure

1. In the Project Explorer view, expand the Processes > sample_plugin_project resource, and thendouble-click businessobject.bwp.

2. Click Run > Debug Configurations...The Debug Configurations dialog opens.

3. Expland the BusinessWorks Application option and select BWApplication.

4. In the Applications tab, all processes will be selected. Click the Deselect All button and select thesample_plugin_object.businessobject option.

5. Click the Apply button and click the Debug button.

6. Click Debug to run the process.

7. Click the icon to stop the process.

35


Sample Plug-in Project to show the Parent-Child Relationship using Invoke BusinessObject Activity

You can use the example parentChild_businessObject.bwp to understand how the parent-childrelationship works using the Invoke Business Object activity. The example shows the Insert, Upsert, andQuery operation on the business object.

The following figure describes the parent-child relationship using the Invoke Business Object activityprocess:

Example for Parent-Child Relationship using the Invoke Business Object Activity Process

The following figure shows the parent-child relationship established using the Siebel Objects Editor:

Example for Establishing Parent-Child Relationship using Siebel Objects Editor

The Invoke Business Object Activity process perfoms the following operations:




● The Log stores the logs of the operations performed.

36


Running the ProjectTo run the project for the Parent-Child Business Object process, perform the following steps:

Procedure

1. In the Project Explorer view, expand the Processes > sample_plugin_project resource, and thendouble-click parentChild_businessObject.bwp.



4. In the Applications tab, all processes will be selected. Click the Deselect All button and select thesample_plugin_object.parentChild_businessObject option.




Invoke Business Service ActivityYou can use the InvokeBusinessService Activity to select and configure (insert, upsert, update, delete, orquery) the Siebel business services and the Siebel fields.

General

The following table lists the configurations in the General tab of the Invoke Business Service activity:

Field

ModuleProperty? Description



Business Service Only EAI Siebel Adapter service is supported.

1. Click the Fetch button. The Business Servicesdialog is displayed.

2. Select the value EAI Siebel Adapter.

3. Click the OK button.

37


Field


Business Service Method Specify the service method that has to be performedusing the activity. The following operations can beperformed using the activity:




● Update- for updating an existing record.


● The Update operation cannot beperformed on a user-key field. Forexample, if you want to update theLocation field from City1 to City 2,and if the Location field is a user-key,the update operation will generate aFault.

● The Upsert operation cannot beperformed on multiple records. Anexception is displayed if Upsert isperformed on multiple records.


● If the Delete operation finds multiplerecords, it deletes all the recordswithout prompting you for aconfirmation. For example, if youprovide an input of a* and perform thedelete operation, all records startingfrom the letter a gets deleted.

● If you perform Delete operation on arecord, the output data for the recordwill not have any values.

38


Field


Siebel Object Reference Only the Integration Object is supportedby this activity.

Specify the object for reference created using theeditor. See the topic Creating a Siebel Schema usingthe Siebel Objects Editor for more details.

1. Click the search icon. The Siebel IntegrationObject dialog is displayed.


Description

In the Description tab, you can enter a short description for the Invoke Business Service activity.

Input


Duplication or adding multiple Item fields in the Input tab is not allowed as Siebel only supports asingle parent node.

Output

The values in the Output tab will be populated based on the values passed to the fields of the objects inthe Input tab. If the values are appropriate, the output will be appropriate. If the values are notappropriate, an error or an exception will be displayed in the Fault tab.

Fault

In the Fault tab, you can find the error message and error message code of the Invoke Business Serviceactivity. See the Error Codes topic for more detailed explanation of errors.



SiebelPluginException String Will display an exception at runtime if the userhas selected the attributes, has not assigned anyvalues to the attributes, and is trying to performthe Insert, Upsert, Query, or Delete operation.


39


Sample Plugin Project for Invoke Business Service ActivityYou can use the example businessservice.bwp to understand how the Invoke Business Serviceactivity behaves. The example shows the Insert, Upsert, Update, Query, and Delete operation on theworkflow.

The following figure describes the Invoke Business Service activity process:

Example for Invoke Business Service Activity Process

The Invoke Business Service Activity process perfoms the following operations:



● The Update operation updates the value for the field or fields that are defined in the schema.


● The Delete operation deletes the value for the field or fields that are defined in the schema.

Running the ProjectTo run the project for the Invoke Business Service activity process, perform the following steps:

Procedure

1. In the Project Explorer view, expand the Processes > sample_plugin_project resource, and thendouble-click businessservice.bwp.



4. In the Applications tab, all processes will be selected. Click the Deselect All button and select thesample_plugin_object.businessservice option.



40



Invoke Integration Object ActivityYou can use the InvokeIntegrationObject Activity to perform the insert, upsert, update, delete, or queryoperation using the integration object or component.

General

The following table lists the configurations in the General tab of the Invoke Integration Object activity:

Field




41


Field


Operation Specify the operation that has to be performed usingthe activity. The following operations can beperformed using the activity:



● Update- for updating an existing record.



● The Update operation cannot beperformed on a user-key field. Forexample, if you want to update theLocation field from City1 to City 2,and if the Location field is a user-key,the update operation will generate anerror.

● The Upsert operation cannot beperformed on multiple records. Anexception is displayed if Upsert isperformed on multiple records.

● If you perform the Delete operation ona record, the output data for the recordwill have no values.


● If the Delete operation finds multiplerecords, it deletes all the recordswithout prompting you for aconfirmation. For example, if youprovide an input of a* and perform thedelete operation, all records startingfrom the letter a gets deleted.

42


Field


Siebel Object Reference Only the Integration Object is supportedby this activity.




Description

In the Description tab, you can enter a short description for the Invoke Integration Object activity.

Input



Output

The values in the Output tab will be populated based on the values passed to the fields of the objects inthe Input tab. If the process execution completes successfuly, you can see the output, otherwise a Faultwill be displayed.

Fault

In the Fault tab, you can find the error message and error message code of the Invoke IntegrationObject activity. See the Error Codes topic for more detailed explanation of errors.

The following table lists the error schema elements in the Fault tab of the Invoke Integration Objectactivity:


SiebelPluginException String Will display an exception at runtime if the userhas selected the attributes, has not assigned anyvalues to the attributes, and is trying to performthe Insert, Upsert, Query, or Delete operation.


43


Sample Plugin Project for Invoke Integration Object ActivityYou can use the example integrationobject.bwp to understand how the Invoke Integration Objectactivity behaves. The example shows the Insert, Upsert, Update, Query, and Delete operation on theintegration object.

The following figure describes the Invoke Integration Object activity process:

Example for Invoke Integration Object Activity Process

The Invoke Integration Object Activity process perfoms the following operations:



● The Update operation updates the value for the field or fields that are defined in the schema.


● The Delete operation deletes the value for the field or fields that are defined in the schema.

Running the ProjectTo run the project for the Invoke Integration Object activity process, perform the following steps:

Procedure

1. In the Project Explorer view, expand the Processes > sample_plugin_project resource, and thendouble-click integrationobject.bwp.



4. In the Applications tab, all processes will be selected. Click the Deselect All button and select thesample_plugin_object.integrationobject option.



44



Invoke Workflow ActivityYou can use the InvokeWorkflow Activity to perform operations on the Integeration object through theworkflow process which exists on the Siebel server.

General

The following table lists the configurations in the General tab of the Invoke Workflow activity:




Workflow Process The following workflow processes are supported:

● TIBCO Sample Workflow Invocation from

Subscriber for Integration Object


Subscriber for Integration

Object_Insert


Subscriber for Integration

Object_Delete

1. Type TIBCO* in the Workflow Process field.

2. Click the Fetch button. The Workflow Processdialog is displayed.

3. Select the value TIBCO Sample WorkflowInvocation from Subscriber for Integration Object.

4. Click the OK button.

Integration Object Name Only the Integration Object is supportedby this activity.




45


Description

In the Description tab, you can enter a short description for the Invoke Business Service activity.

Input



Output

The values in the Output tab will be populated based on the values passed to the fields of the objects inthe Input tab. If the process execution completes successfuly, you can see the output, otherwise a Faultwill be displayed.

Fault

In the Fault tab, you can find the error message and error message code of the Invoke Business Serviceactivity. See the Error Codes topic for more detailed explanation of errors.



SiebelPluginException String Will display an exception at runtime if the userhas executed the activity by selecting theworkflow processes TIBCO Sample WorkflowInvocation from Subscriber for

Integration Object_Delete or TIBCO SampleWorkflow Invocation from Subscriber for

Integration Object_Insert, and has not givenvalues to any of the attributes in the Input tab.


Sample Plugin Project for Invoke Workflow ActivityYou can use the example workflow.bwp to understand how the Invoke Workflow activity behaves. Theexample shows the use of TIBCO Sample Workflow Invocation from Subscriber forIntegration Object_Insert and TIBCO Sample Workflow Invocation from Subscriber forIntegration Object_Delete workflows which performs the Insert and Delete operations on theIntegration Object respectively.

The following figure describes the Invoke Workflow activity process:

46


Example for Invoke Workflow Activity Process

● The workflow process TIBCO Sample Workflow Invocation from Subscriber forIntegration Object_Insert inserts the value for the field or fields that are defined in the inputschema.

● The workflow process TIBCO Sample Workflow Invocation from Subscriber forIntegration Object_Delete deletes the value for the field or fields that are defined in the inputschema.

Running the ProjectTo run the project for the Invoke Workflow activity process, perform the following steps:

Procedure

1. In the Project Explorer view, expand the Processes > sample_plugin_project resource, and thendouble-click workflow.bwp.



4. In the Applications tab, all processes will be selected. Click the Deselect All button and select thesample_plugin_object.workflow option.




47


Management of Logs

When an error occurs, you can check logs to trace and troubleshoot the 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 the topic 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 message taggedwith Info indicates that a significant processing step is reached, and logged fortracking or auditing purposes. Only info messages preceding a tracking identifier areconsidered as significant steps.

Warn Indicates that an abnormal condition occurred. Processing continues, but for bestpractice, you can contact the administrator to investigate it.

Error Indicates that an unrecoverable error occurred. Depending on the severity of theerror, 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.

If you do not configure any log levels, the plug-in uses the default log level of TIBCO ActiveMatrixBusinessWorks. The default log level 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:<logger name="com.tibco.bw.palette.siebel.runtime"> <level value="DEBUG"/></logger>

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

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

48


3. Optional: Add the following node in the BusinessWorks Palette and Activity loggers area tospecify a log level for an activity:<logger name="com.tibco.bw.palette.siebel.runtime.ActivityNameActivity"> <level value="DEBUG"/></logger>

For example, you can set the log level to Debug for all the activities as follows:

● For the Invoke Business Object activity:<logger name="com.tibco.bw.palette.siebel.runtime.InvokeBOActivity"> <level value="DEBUG"/></logger>

● For the Invoke Integration Object activity:<logger name="com.tibco.bw.palette.siebel.runtime.InvokeIOActivity"> <level value="DEBUG"/></logger>

● For the Invoke Business Service activity:<logger name="com.tibco.bw.palette.siebel.runtime.InvokeBSActivity"> <level value="DEBUG"/></logger>

● For the Invoke Workflow activity:<logger name="com.tibco.bw.palette.siebel.runtime.InvokeWFActivity"> <level value="DEBUG"/></logger>

The activities that are not configured with specific log levels use the log level configuredfor the plug-in.

4. Save the file.

Exporting Logs to a FileYou can update the logback.xml file to export plug-in logs to a file.

Procedure

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

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

node_name directory to find the logback.xml file.

2. Add the following node to specify the file where the log is exported:<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-siebel.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 log.

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

4. Save the file.

49


Error Codes

The following table lists error codes, detailed explanation of each error, and where applicable, ways tosolve different errors.

Error Code Role Category Description Solution

TIBCO-BW-PALETTE-Siebel-500000

Not Parent/Child

Match Field or Value

found for Business

Component: [{0}]

Error BW-Plug-in

Match-field is notspecified to the parentand the child attributefor the BusinessComponent.

Specify thematch-field tothe parent andchild attribute ofthe BusinessComponent.


Insert operation

failed on business

component. : [{0}]

Error BW-Plug-in

Refer the error messageor the error trace fordescription.

As per the errormessage, takethe appropriatesteps or referthe Siebeldocumentation.


No Match Field found

or Match Field has

empty or "" value for

Business Component:

[{0}]

Error BW-Plug-in

Values are not providedto the match-fieldattribute for theBusiness Component.

Specify thevalue for thematch-fieldattribute of theBusinessComponent.


Input Search Criteria

is blank or null set

for Business

Component:[{0}]

Error BW-Plug-in

Input parameters areNULL or blank for theBusiness Component.

Specify valuesfor the inputparameters.


No Record Found, for

business component:

[{0}] :- Record not

available at Siebel

server.

Error BW-Plug-in

No records are presentin the Siebel server forthe input parametersspecified for theBusiness Component.

Specify differentvalues for theinputparameters.


Record already exist

on business

component. : [{0}]

Error BW-Plug-in

Record with the samevalues are alreadypresent in the Siebelserver for the BusinessComponent.

Provide uniquevalues for theattributes of theBusinessComponent.

50




Error occurs when

invoking Integration

Object Activity for

Method: [{0}], Siebel

Error Message: [{1}]

Error BW-Plug-in


As per the errormessage, takeappropriatesteps or referthe Siebeldocumentation.



when invoking

Integration Object

Activity for Method:

[{0}]

Error BW-Plug-in

Record with the samevalues are alreadypresent in the Siebelserver for theIntegration Object.

Provide uniquevalues for theattributes of theIntegrationObject.


No Record Found, when

invoking Integration

Object Activity for

Method: [{0}]

Error BW-Plug-in

No records are presentin the Siebel server forthe input parametersspecified for theIntegration Object.





for Invoke

Integration Object

Activity:[{0}]

Error BW-Plug-in

Input parameters areNULL or blank for theIntegration Object.




when invoking Invoke

Business Service

Activity for Business

Service: [{0}],

Method: [{1}]

Error BW-Plug-in

Record with the samevalues are alreadypresent in the Siebelserver for the BusinessService.

Providedifferent valuesfor the attributesof the BusinessService.



invoking Invoke

Business Service


Service: [{0}],

Method: [{1}]

Error BW-Plug-in



51




Error occurs when

invoking Invoke

Business Service


Service: [{0}],

Method: [{1}], Siebel

Error Message: [{2}]

Error BW-Plug-in






for Invoke Business

Service Activity

Error BW-Plug-in

Input parameters areNULL or blank for theBusiness Service.

Specify thevalues for theinputparameters.




for Invoke

Integration Object

Activity

Error BW-Plug-in

Input parameters areNULL or blank for theIntegration Object.

Specify thevalues for theinputparameters.


Multiple Records

Found for business

component:[{0}],

while performing

update operation, so

no update operation

performed

Error BW-Plug-in

Update operationcannot be performedwhen multiple recordsare present for theBusiness Component inthe Siebel server.

Provide validvalues for theinputparameters. Thevalue should bea unique recordand should bepresent in theSiebel server forperforming theupdateoperation.


Error occurs on

executeQuery api of

Siebel Business

component:[{0}]

Error BW-Plug-in



52




Error occurs on

delete api of Siebel

Business component:

[{0}]

Error BW-Plug-in




Error occurs on write

api of Siebel

Business component:

[{0}]

Error BW-Plug-in




No user key provided

or user key value is

blank when invoking

Integration Object


[{0}]

Error BW-Plug-in

Value for the user keyattribute is not providedor is kept blank for theIntegration Object.

Specify thevalue for theuser keyattribute.


No Matching record

Found, when invoking

Integration Object


[{0}]

Error BW-Plug-in

No matching record wasfound in the Siebelserver for the providedinput paramters, for theIntegration object, whenthe update operationwas performed.

Provide validvalues for theinputparameters ofthe IntegrationObject.



or user key is blank


Business Service


Service: [{0}],

Method: [{1}]

Error BW-Plug-in



53




No Matching record


Invoke Business

Service Activity for

Business Service:

[{0}], Method: [{1}]

Error BW-Plug-in

No matching record wasfound in the Siebelserver for the providedinput paramters, for theIntegration object, whenthe update operationwas performed for theBusiness Serviceactivity.




invoking Invoke

WorkFlow Activity for

WorkFlow Process:

[{0}]

Error BW-Plug-in




Error occurs when

invoking Invoke


WorkFlow Process:

[{0}], Siebel Error

Message: [{1}]

Error BW-Plug-in





or user key is blank



WorkFlow Process:

[{0}]

Error BW-Plug-in




No Matching record


Invoke WorkFlow

Activity for WorkFlow

Process: [{0}]

Error BW-Plug-in

No matching recordfound in siebel serverfor the input paramtersprovided for Integrationobject when performingupdate operation forInvoke Workflowactivity.


54




No key provided or

key is blank. [{0}]

Error BW-Plug-in

No matching record wasfound in the Siebelserver for the providedinput paramters, for theIntegration object, whenthe update operationwas performed for theInvoke Workflowactivity.

Specify at leastone keyattribute, orprovide valuesfor the keyattribute of theBusinessComponent.


The username or

password you have

entered is not

correct.: [{0}]

Configuration

BW-Plug-in

The username orpassword is incorrect.

Specify thecorrectusername orpassword.


Error occurs when

connecting to Siebel

with Config: [{0}],

Detail: [{1}]

Configuration

BW-Plug-in

The configurationdetails provided for theSiebel connection areincorrect.

Specify validconfigurationdetails.


Error in enabling SQL

trace: [{0}]

Error BW-Plug-in

Error occurs when aninvalid trace file nameor or an invalid trace filepath is provided in theadvanced section of theSiebel Connection.

Provide validtrace file nameor path.


No value provided for

SQL Trace File: [{0}]

Error BW-Plug-in

Error occurs when the"Enable SQL SiebelTrace" check-box ischecked and the "SQLtrace file" is kept blank,or if there is no inputprovided for theadvanced section of theSiebel Connection.

Specify SQLTrace File in theadvancedsection of theSiebelConnection.


Error occurs when

performing delete for

Business Component:

[{0}].Delete is only

allowed with primary

business component

that does not have

child objects.

Error BW-Plug-in

Delete operation cannotbe performed for theBusiness Object that haschild objects.

Do not performdelete operationfor the primaryBusinessComponent thathas any childobject or childobjects.

55






for Invoke WorkFlow

Activity.

Error BW-Plug-in

Input parameters areNULL or blank for theWorkflow.

Specify valuesfor the inputparameters.


Given Input fields

are inappropriate for

Business Component:

[{0}]

Error BW-Plug-in

Error occurs wheninappropriate inputfields are selected forthe BusinessComponent.

Provideappropriateinput fields ofthe BusinessComponent.

56


tibco activematrix businessworks™ plug-in for siebel user ......license agreement, the license(s)...

Documents