tib adrmd examples

7/30/2019 Tib Adrmd Examples

1/116

TIBCO Adapter for Remedy

Examples Guide

Software Release 5.2.2June 2011


2/116

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND ANAGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright laws andtreaties. No part of this document may be reproduced in any form without the written authorization of TIBCOSoftware Inc.

TIBCO, The Power of Now, TIBCO ActiveEnterprise, TIBCO Rendezvous, TIBCO Designer, TIBCO InConcert,TIBCO IntegrationManager, TIBCO Repository, and TIBCO Hawk are either registered trademarks ortrademarks of TIBCO Software Inc. in the United States and/or 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, NOT ALLOPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFICOPERATING SYSTEM PLATFORM.

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

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.

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

Copyright 2002-2011 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information


3/116

TIBCO Adapter for Remedy Examples Guide

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixThird Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Before Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Using TIBCO BusinessWorks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Using TIBCO IntegrationManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Working with dat files in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2 TIBCO BusinessWorks: Working with the Customer Business Object. . . . . . . . . . . .9

Example Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Setup the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Deploy and Run the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 3 TIBCO BusinessWorks: Working with the SalesOrder Business Object . . . . . . . . .17



Test the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 4 TIBCO BusinessWorks: Working with the PurchaseOrder Business Object . . . . . .23


Setup the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Test the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26


4/116


iv | Contents

Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 5 TIBCO BusinessWorks: Working with the Employee Business Object. . . . . . . . . . 29



Test the Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32


Chapter 6 TIBCO BusinessWorks: Working with the ItemMaster Business Object. . . . . . . . . 35

Example Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Setup the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Test the Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38


Chapter 7 TIBCO IntegrationManager: Examples for Employee Business Object. . . . . . . . . . 41

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Publication Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Subscription and Request-Response Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Common Steps for Subscription Service and Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Employee Business Object Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Chapter 8 TIBCO IntegrationManager: Examples for Customer Business Object. . . . . . . . . . 53

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54




Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60


Customer Business Object Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62


Chapter 9 TIBCO IntegrationManager: Examples for Purchase Order Business Object. . . . . 65

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66




5/116


Contents |v


Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72


Purchase Order Business Object Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Chapter 10 TIBCO IntegrationManager: Examples for Sales Order Business Object. . . . . . . .79

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80


Subscription and Request-Response Service Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84




Sales Order Business Object Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 11 TIBCO IntegrationManager: Examples for Item Master Business Object. . . . . . . .91

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92


Subscription and Request-Response Service Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96




Item Master Business Object Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100


Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103


6/116


vi | Contents


7/116


|vii

Preface

This guide describes supported features, platforms, installation, configuration,and overall architecture of TIBCO Adapter for Remedy. The guide assumesfamiliarity with the basic concepts of the TIBCO environment and Remedytechnology.

Topics

Terminology and Acronyms, page viii

Related Documentation, page ix

How to Contact TIBCO Customer Support, page xii


8/116


viii | Terminology and Acronyms

Terminology and Acronyms

Term Definition

AR Action Request

API Application Programming Interface

RPC Remote Procedure Call

AR API Remedy Action Request Server API

NT API Remedy Notification Server API

RV TIBCO Rendezvous protocol; also in certain contexts refers to reliablemessage quality of service, as opposed to certified message.

RVCM TIBCO Rendezvous certified message quality of service.

RVDQ TIBCO Rendezvous distributed queue.

JMS Java Messaging Service

I/O Input-Output


9/116


Preface | ix

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Product Documentation

The following documents form the TIBCO Adapter for Remedy documentationset:

TIBCO Adapter Concepts This manual introduces adapters by explaining

what they are, and explains how to install, configure, deploy and manageadapters.

TIBCO Adapter for Remedy Users Guide This manual explains conceptsrelating to the adapter and the application with which it interacts. Installation,configuration and deployment information is included in this manual.

TIBCO Adapter for Remedy Examples GuideThis manual provides hands- onexamples that demonstrate use of the adapter.

TIBCO Adapter for Remedy Release Notes Read the release notes for a list ofnew and changed features. This document also contains lists of known issuesand closed issues for this release.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO

products. Note that only books that relate to adapters are listed. Each of the booksis available from the doc directory in the products installation area.

TIBCO ActiveEnterprise software:

TIBCO ActiveEnterprise Concepts

TIBCO Designer software:

TIBCO Designer Users Guide

TIBCO Designer Palette Reference

TIBCO Designer Release Notes


10/116


x | Related Documentation

TIBCO Administrator software:

TIBCO Administrator Users Guide

TIBCO Administrator Server Configuration Guide TIBCO Administrator Release Notes

TIBCO BusinessWorks software:

TIBCO BusinessWorks Concepts

TIBCO BusinessWorks QuickStart

TIBCO BusinessWorks Process Design Guide

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Installation

TIBCO BusinessWorks Release Notes

TIBCO IntegrationManager software:

TIBCO IntegrationManager Concepts

TIBCO IntegrationManager Administrators Guide

TIBCO IntegrationManager Process Design Guide

TIBCO IntegrationManager Reference

TIBCO IntegrationManager Release Notes

TIBCO Rendezvous software:

TIBCO Rendezvous Concepts

TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

TIBCO Enterprise Message Service software:

TIBCO Enterprise Message Service Users Guide

TIBCO Enterprise Message Service Installation TIBCO Enterprise Message Service Application Integration

TIBCO Enterprise Message Service Release Notes

TIBCO Hawk software:

TIBCO Hawk Installation and Configuration

TIBCO Hawk Administrators Guide


11/116


Preface |xi

TIBCO Adapter SDK

TIBCO Adapter SDK Concepts

TIBCO Runtime Agent TIBCO Runtime Agent Release Notes

TIBCO Runtime Agent Installation

TIBCO Runtime Agent Domain Utility Users Guide

TIBCO Runtime Agent Upgrading to Release 5.3

Third Party Documentation

Refer to the following Remedy documentation:

Action Request System Concepts Guide

Action Request System Server Administrators Guide

Action Request System Workflow Administrators Guide

Please refer to documentation for your AR version. TIBCO Adapter for Remedy5.2.0 supports AR System versions 6.0.1, 6.1.3, and 7.0.0


12/116


xii | How to Contact TIBCO Customer Support

How to Contact TIBCO Customer Support

For comments or problems with this manual or the software it addresses, pleasecontact TIBCO Support Services as follows.

For an overview of TIBCO Support Services, and information about gettingstarted with TIBCO Product Support, visit this site:

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

If you already have a valid maintenance or support contract, visit this site:

http://support.tibco.com

Entry to this site requires a username and password. If you do not have ausername, you can request one.
http://www.tibco.com/services/supporthttp://support.tibco.com/http://support.tibco.com/http://www.tibco.com/services/support


13/116


|1

Chapter 1 Introduction

This chapter contains an overview of the examples and the prerequisites neededto run the examples. The examples are explained in the later chapters of thisguide.

Topics

Overview, page 2

Prerequisites, page 5


14/116


2 | Chapter 1 Introduction

Overview

The following examples demonstrate the integration between the adapter andtwo TIBCO products, TIBCO BusinessWorks and TIBCO IntegrationManager. Wehave chosen commonly used Business Objects to build an end-to-end enterprisewide integration and demonstrate the adapter capabilities. These BusinessObjects are:

Customer

SalesOrder

PurchaseOrder

Employee

ItemMaster

The examples provide different operations on each of these Business Objects. Abrief description of these operations is given next:

Get

In this operation, TIBCO BusinessWorks requests data to be fetched from theRemedy Action Request System. The Request-Response service is used tosimulate this. TIBCO BusinessWorks reads the request from an XML file andsends the request. The corresponding Request-Response service is executed onthe adapter and the result is returned to TIBCO BusinessWorks. TIBCOBusinessWorks maps the results according to business requirements and the data

is written to an XML file.

Update

Another important requirement in an integration scenario is to update data in anexisting record. The Update operation is simulated in two ways.

The first is a publish-subscribe scenario. Data is published by the adapters

Publication service; the values that need to be updated are modified using aTIBCO BusinessWorks process. The updated message is sent to the adaptersSubscription service and the service updates the values in Remedy ActionRequest System.

O i |3


15/116


Overview |3

Figure 1 Update Operation Using a Publish-Subscribe Scenario

The second is a Request-Response scenario. The values are modified in themapper class in TIBCO BusinessWorks and the request is sent to the adapter.The Request-Response service of the adapter receives the request and updatesthe values in Remedy Action Request System.



16/116



Figure 2 Update Operation Using an Request-Response Scenario

The publish-subscribe scenario is used for the Customer, PurchaseOrder and

ItemMaster Business Objects. The Request-Response scenario is used for theEmployee and SalesOrder Business Objects.

Sync

In this operation, TIBCO Adapter for Remedy publishes a message if there areany changes in the Remedy Action Request System. TIBCO BusinessWorksreceives this message, does the necessary mapping of the fields and writes them

to an XML file.

For publishing an event from Remedy, refer toTIBCO Adapter for Remedy UsersGuide.

Prerequisites |5


17/116


Prerequisites |5

Prerequisites

Location

The examples for all the Business Objects are available inTIBCO_HOME\adapter\adremedy\\examples

Before Starting

1. Install all required software. For a list of required software, see the section onSoftware Requirements in the Installation chapter of the TIBCO Adapter forRemedy Users Guide.

2. Import the form definitions files into Remedy AR System from the location/tibco/adapter/adremedy//examples//.def

3. For Oracle, run the adremedyNotifications.sql script through the SQLprompt. For Microsoft SQL Server, run theadremedyNotifications_SQLSERV.sql . The script is available inTIBCO_HOME\adapter\adremedy\\config.

4. Create the filter for importing data into the AR System usingadremedyFilter_Oracle.def if you are using Oracle oradremedyFilter_SQL.def if you are using SQL. The script is available inTIBCO_HOME\adapter\adremedy\\config\filter.

Using TIBCO BusinessWorks

If you are using the adapter with TIBCO BusinessWorks, the following softwaremust be installed to run the examples:

TIBCO BusinessWorks 5.3.0 or higher

TIBCO Administrator Enterprise Edition 5.3.0

TIBCO Adapter for Remedy 5.2.0

TIBCO Runtime Agent 5.3.2 or higher

TIBCO Enterprise Message Service 4.2.0 or higher

The JMS server must be running and accessible to the machine on which the

adapter is installed.



18/116



The TIBCO BusinessWorks examples use TIBCO Designer to create an EnterpriseArchive File (EAR) and TIBCO Administrator Enterprise Edition to deploy theEAR file.

In TIBCO Administrator, make sure all software components needed by theadapter instance are installed on one or more machines that are part of a TIBCOAdministration Domain and that the software is registered in the domain.

Use the TIBCO Domain Utility to add a machine to a TIBCO AdministrationDomain.

These topics are explained in the TIBCO Administrator documentation set.

Using TIBCO IntegrationManager

If you are using the adapter with TIBCO IntegrationManager, the followingsoftware must be installed to run the examples:

TIBCO IntegrationManager 5.0.x

TIBCO Administrator Repository Edition 5.3.0

TIBCO Adapter for Remedy 5.2.0

TIBCO Runtime Agent 5.3.0

TIBCO Enterprise for JMS 4.3.0

If you are using TIBCO Administrator Repository Edition, you deploy by editingthe adapters properties files and start and stop the adapter on the command line.The TIBCO IntegrationManager examples are deployed using this method.

Working with dat files in TIBCO Designer

The dat files included in the adapter installation are used by all examples exceptthe TIBCO BusinessWorks examples.

You cannot directly open a dat file in TIBCO Designer and make modifications tothe configurations. To be able to do this, you need to carry out the following steps:

The JMS server must be running and accessible to the machine on which theadapter is installed.

Prerequisites |7


19/116


q |

1. Convert the dat file to a multi-file project.

a. Open Designer. In the first screen that is displayed, click Administration.

The screen is shown next.

b. Then click the Convert DAT to Files icon. In the window that is displayed,browse and select the dat file you wish to convert to a multi-file project.Click OK.

2. Click the Open existing project icon from the first TIBCO Designer screen.Browse to the directory where the converted multi-file project is saved.

3. Make configuration changes per your requirements.

4. Export the multi-file project to a dat.



20/116


|

5. Select Project>Export Full Project from the menu. Browse and select thelocation of the directory you wish to save the dat file to. Ensure that thedirectory is different from the multi-file project. Enter the name of the project

and click OK.

|9


21/116


|

Chapter 2 TIBCO BusinessWorks: Working with the

Customer Business Object

This example shows how to use several adapter services within a TIBCOBusinessWorks process to get, update, and synchronize a Customer record storedin Remedy. The example is deployed and run using the TIBCO Administrator

GUI.

Topics

Example Description, page 10

Setup the Example, page 11

Deploy and Run the Example, page 12

Expected Results, page 15

10 | Chapter 2 TIBCO BusinessWorks: Working with the Customer Business Object


22/116


Example Description

This example shows how the adapters Publication, Subscription andRequest-Response services can be used in a TIBCO BusinessWorks process. Theexample has three processes,Get_Customer,Insert_Update_Delete_Customer,and Sync_Customer.

Get_Customer uses the adapters Request-Response service to fetch data fromthe Remedy Action Request System for key values that you specify in an inputXML file.

Get_Customer queries the Remedy Action Request System based on the givenkey values and fetches the data. The data is sent back by the adapter to TIBCOBusinessWorks and is written to an output XML file.

Insert_Update_Delete_Customer uses the adapters Subscription service toeither insert, update, or delete data in the Remedy Action Request System.

In a typical business scenario, an adapter to another application (for example,SAP or Siebel) publishes a message to the TIBCO environment. TIBCO

BusinessWorks receives the messages and writes them to an input XML file.The content of this XML file will contain data to be updated in the RemedyAction Request System. TIBCO Adapter for Remedy uses the Subscriptionservice to update this data in the Remedy Action Request System.

Alternatively, you may specify key values in the input XML file.Insert_Update_Delete_Customer inserts, updates, or deletes the Customerdetails in the Remedy Action Request System, based on the operation type

specified in the input XML file. Sync_Customer uses the adapters Publication service to send a message out

of Remedy Action Request System whenever Customer Business Objectdetails are modified or updated in the Remedy Action Request System. Anychange to the data in Remedy Action Request System triggers theSync_Customer process.

On receiving the modified data, TIBCO BusinessWorks logs it to an XML file.

The adapter will publish data only if the Customer form is configured for

publishing. To configure the Customer form for publishing, see the sectionConfiguring a Remedy Form for Publishing in the TIBCO Adapter for RemedyUsers Guide.

Setup the Example |11


23/116


Setup the Example

Before starting the example you must import the sample project zip file and saveit in a new project.

Task A Get_Customer, Insert_Update_Delete_Customer and

Sync_Customer Setup:

In TIBCO Designer:

1. In the initial dialog box, click Open New Project and specify a name for theproject.

2. Click Project>Import Full Project.

3. Click the Zip Archive tab and browse to locate the Customer_RV.zip file. Thefile is located in the/tibco/adapter/adremedy//examples/bu

sinessworks/Customer folder.

4. Save as a multi-file project by the name Customer.

5. Select Customer Enterprise Archive in the project panel.

6. Click Browse and specify the name of the archive and the location where it isto be created.

7. Click Build Archive in the Configuration tab. This creates an archive file.

8. Exit TIBCO Designer.



24/116


Deploy and Run the Example

Perform the following tasks to deploy and run the example.

Task A Deploy the Example

In TIBCO Administrator:

1. Click the Installed Software link on the left panel. Check if TIBCO Adapterfor Remedy is registered. If the software is not registered, register by clickingthe Add Custom Software button. Please refer to the TIBCO Administratordocumentation for more details on adding custom software.

2. Go to Application Management. Click New Application. Upload the EARfile created in the previous section and click OK. On the following screen,clear the Quick Configure check box and then click Save.

3. Click Configuration in the newly created application. Click the top levelapplication name in the configuration view.

a. Go to the Advanced tab and provide values for:adremedy.connection.server

adremedy.connection.user

adremedy.connection.password

adremedy.connection.port

b. Click Save. The Configuration screen appears.

c. Select the machine and click OK. In the following screen, click Save.

d. In the Configuration screen, click Deploy,which will take you to the nextscreen. The Start successfully deployed services check box is selected bydefault. Click OK. The .tra files are created in/bin/domain/ .

4. Once the deployment is complete, click Service Instances under theapplication. The adapter is listed. Select the adapter and click Start Selected.

The adapter instance is started.

Task B Run the Example

To run each example:

1. To trigger GetProcess, you must enter the key values in the get_input.xmlfile located in the/tibco/adapter/adremedy//examples/Busin

Deploy and Run the Example |13


25/116


essWorks/Customer folder. For example, key values for the followingparameters can be entered:

RequestID

OperationType

This fetches the customer details from the Remedy Action Request Systembased on the details given in the XML file. After the customer details arefetched from the Remedy Action Request System, the get_output.xml file iswritten to the location/tibco/adapter/adremedy//examples/BusinessWorks/Customer.

2. To trigger Insert_Update_Delete_Customer, you must enter the data in theinsert_update_delete_input.xml file located in the/tibco/adapter/adremedy//examples/BusinessWorks/Customer folder. For example:

CRM01

10000

10000

CRM01

U

WE

U

12.78

12

U

VINIBA

U

QUOT

U

U

U

QUOT

1.1

1.11.1

This creates a customer record in the Remedy Action Request System.

3. To trigger Sync_Customer, you must modify the data in the Remedy Action

Request System. For example, you may modify any customer record.



26/116


This triggers the Sync_Customer process and writes the data to thesync_output.xml file.

Expected Results |15


27/116


Expected Results

The example results can be viewed in the respective XML files written to:/tibco/adapter/adremedy//examples/Busin

essWorks/Customer

Get_Customer data is fetched based on the RequestID and OperationTypeparameters specified in the get_input.xml file and is written to theget_output.xml file. The get_output.xml file should display the followingCustomer record:

#108, St. 23

BW Examples

Palo Alto

65-4564322

John

2003-12-15T12:28:52

[email protected]

Demo

1122212

000000000000019

Tibco Inc Ltd

0

1071471532_CTRLD_Demo_CTRLC_

BW Examples

2003-12-15T12:28:52

Insert_Update_Delete_Customer data is updated based on the RequestIDand OperationType parameters specified in theinsert_update_delete_input.xml file and is updated in Remedy ActionRequest System.

Sync_Customer output is stored in the sync_output.xml file.



28/116


|17


29/116



SalesOrder Business Object

This example shows how to use several adapter services within a TIBCOBusinessWorks process to get, update, and synchronize a SalesOrder recordstored in the Remedy Action Request System.

Topics


Setup the Example, page 19 Test the Example, page 20


18 | Chapter 3 TIBCO BusinessWorks: Working with the SalesOrder Business Object


30/116


Example Description

This example shows how the adapters Publication, Subscription, andRequest-Response services can be used in a TIBCO BusinessWorks process. Theexample has three processes, Get_SalesOrder,Insert_Update_Delete_SalesOrder, and Sync_SalesOrder.

Get_SalesOrder uses the adapters Request-Response service to fetch datafrom the Remedy Action Request System for key values that you specify in aninput XML file.

Get_SalesOrder queries the Remedy Action Request System based on thegiven key values and fetches the data. The data is sent back by the adapter toTIBCO BusinessWorks and is written to an output XML file.

Insert_Update_Delete_SalesOrder uses the adapters Subscription serviceto either insert, update, or delete data in the Remedy Action Request System.


BusinessWorks receives the messages and writes them to an input XML file.The content of this XML file will contain data to be updated in the RemedyAction Request System. TIBCO Adapter for Remedy uses the Subscriptionservice to update this data in Remedy Action Request System.

Alternatively, you may specify key values in the input XML file.Insert_Update_Delete_SalesOrder inserts, updates or deletes theSalesOrder details in the Remedy Action Request System, based on theoperation type specified in the input XML file.

Sync_SalesOrder uses the adapters Publication service to send a messageout of the Remedy Action Request System whenever SalesOrder BusinessObject details are modified or updated in the the Remedy Action RequestSystem. Any change to the data in the Remedy Action Request Systemtriggers the Sync_SalesOrder process.


The adapter will publish data only if the SalesOrder form is configured for

publishing. To configure the SalesOrder form for publishing, see the sectionConfiguring a Remedy Form for Publishing in the TIBCO Adapter for RemedyUsers Guide.



31/116


Setup the Example


Task A Get_SalesOrder, Insert_Update_Delete_SalesOrder and

Sync_SalesOrder Setup:

In TIBCO Designer:

1. In the initial dialog box, click Open New Project and specify a name for the

project.


3. Click the Zip Archive tab and browse to locate the SalesOrder_RV.zip file.The file is located in the/tibco/adapter/adremedy//examples/Bu

sinessWorks/SalesOrder folder.

4. Save as a multi-file project by the name SalesOrder.5. Substitute the values of the following global variables for design-time

connection:

adremedy.connection.server




Or you can specify these values in the examples.tra. In this case, the valuesgiven in the project file will be overridden.




32/116


Test the Example

Perform the following task to test the example.

Task A Test the Example

In TIBCO Designer:

1. From the project panel, select the process you want to test. For example,Get_SalesOrder.

2. Click the Set Breakpoints icon.3. In the window that appears, choose Select All, then click OK.

4. Click the Tester tab to the left of the project panel. The test panel replaces theproject tree.

5. Click the Start testing viewed process button.

6. In the process selection window that appears, the Get_SalesOrder is selected

by default. Click Start Selected. The process is now in Test mode.7. Click the File Poller icon. In the configuration panel, File Name field, click

Browse and select the input XML file. Click Apply. Any change to the inputXML file starts the process.

8. Once the process starter is highlighted (indicating a process has started), clickthe Step to next activity icon to step through the process.

9. Step through the process once more.

10. Click the Stop Testing icon to return to design mode.

The above steps describe the testing for Get_SalesOrder. Follow the same stepsto run the Sync_SalesOrder, and Insert_Update_Delete_Customer. TheSync_Customer does not have an input XML file. Any change to the data in theRemedy Action Request System will invoke the Sync_Customer process.



33/116


Expected Results

The example results can be viewed in the respective XML files written to:/tibco/adapter/adremedy//examples/Busin

essWorks/SalesOrder

Get_SalesOrder data is fetched based on the RequestID andOperationType parameters specified in the get_input.xml file and is writtento the get_output.xml file. The get_output.xml file should display thefollowing SalesOrder record:

TGU657R43

Examples

000000000000001

2.67E3

2003-07-16T14:02:30

Demo

000000000000001

0.0E0

10

0.0E0

0

0.0E0

0

0.0E0

0

0.0E0

0

000000000000005

ABN NBRO

0


Examples

2003-12-15T16:01:40

Insert_Update_Delete_SalesOrder data is updated based on theRequestID and OperationType parameters specified in theinsert_update_delete_input.xml file and is updated in the RemedyAction Request System.

Sync_SalesOrder output is stored in the sync_output.xml file.



34/116


|23

TIBCO B i W k W ki ith th


35/116



PurchaseOrder Business Object

This example shows how to use several adapter services within a TIBCOBusinessWorks process to get, update, and synchronize a PurchaseOrder recordstored in Remedy Action Request System.

Topics



Test the Example, page 26


24 | Chapter 4 TIBCO BusinessWorks: Working with the PurchaseOrder Business Object

E ample Description


36/116


Example Description

This example shows how the adapters Publication, Subscription, andRequest-Response services can be used in a TIBCO BusinessWorks process. Theexample has three processes, Get_PurchaseOrder,Insert_Update_Delete_PurchaseOrder, and Sync_PurchaseOrder.

Get_PurchaseOrder uses the adapters Request-Response service to fetchdata from the Remedy Action Request System for key values that you specifyin an input XML file.

Get_PurchaseOrder

queries the Remedy Action Request System based on thegiven key values and fetches the data. The data is sent back by the adapter toTIBCO BusinessWorks and is written to an output XML file.

Insert_Update_Delete_PurchaseOrder uses the adapters Subscriptionservice to either insert, update, or delete data in the Remedy Action RequestSystem.

In a typical business scenario, an adapter to another application (for example,

SAP or Siebel) publishes a message to the TIBCO environment. TIBCOBusinessWorks receives the messages and writes them to an input XML file.The content of this XML file will contain data to be updated in the RemedyAction Request System. TIBCO Adapter for Remedy uses the Subscriptionservice to update this data in the Remedy Action Request System.

Alternatively, you may specify key values in the input XML file.Insert_Update_Delete_PurchaseOrder inserts, updates, or deletes thePurchaseOrder details in the Remedy Action Request System, based on the

operation type specified in the input XML file.

Sync_PurchaseOrder uses the adapters Publication service to send amessage out of the Remedy Action Request System whenever PurchaseOrderBusiness Object details are modified or updated in the Remedy ActionRequest System. Any change to the data in the Remedy Action RequestSystem triggers the Sync_PurchaseOrder process.


The adapter will publish the data only if the PurchaseOrder form is configuredfor publishing. To configure the PurchaseOrder form for publishing, see thesection Configuring a Remedy Form for Publishing in the TIBCO Adapter forRemedy Users Guide.


Setup the Example


37/116


Setup the Example


Task A Get_PurchaseOrder, Insert_Update_Delete_PurchaseOrder and

Sync_PurchaseOrder Setup:

In TIBCO Designer:


project.


3. Click the Zip Archive tab and browse to locate the PurchaseOrder_JMS.zipfile. The file is located in the/tibco/adapter/adremedy//examples/Bu

sinessWorks/PurchaseOrder folder.

4. Save as a multi-file project by the name PurchaseOrder.5. Substitute the values of the following global variables for design-time

connection:





Or you can specify these values in the examples.tra. In this case, the valuesgiven in project file will be overridden.


Task B Start the JMS Server:

This example uses JMS as the transport type. Ensure that the JMS server is

running and accessible to the machine on which the adapter is installed beforerunning any of the processes.


Test the Example


38/116


Test the Example



In TIBCO Designer:

1. From the project panel, select the process you want to test. For example,Get_PurchaseOrder.

2. Click the Set Breakpoints icon.3. In the window that appears, choose Select All, then click OK.



6. In the process selection window that appears, the Get_PurchaseOrder is

selected by default. Click Start Selected. The process is now in Test mode.7. Click the File Poller icon. In the configuration panel, File Name field, click

Browse and select the input XML file. Click Apply. Any change to the inputXML file starts the process.




The above steps describe the testing for Get_PurchaseOrder. Follow the samesteps to run the Sync_PurchaseOrder andInsert_Update_Delete_PurchaseOrder. The Sync_PurchaseOrder does nothave an input XML file. Any change to the data in the Remedy Action RequestSystem will invoke the Sync_PurchaseOrder process.


Expected Results


39/116


Expected Results

The example results can be viewed in the respective XML files written to:

/tibco/adapter/adremedy//examples/Busin

essWorks/PurchaseOrder

Get_PurchaseOrder data is fetched based on the RequestID andOperationType parameters specified in the get_input.xml file and is writtento the get_output.xml file. The get_output.xml file should display thefollowing PurchaseOrder record:

Examples

QWS3687

2.2116E4

000000000000005

2003-07-16T13:55:15

000000000000001

Demo

2003-11-17T13:17:45

2.2116E3

0.0E0

0.0E0

0.0E0

10

0

0

0

000000000000005

QuarterlyPurchase

0


Examples

Insert_Update_Delete_PurchaseOrder data is updated based on theRequestID and OperationType parameters specified in the

insert_update_delete_input.xml file and is updated in the RemedyAction Request System.

Sync_PurchaseOrder output is stored in the sync_output.xml file.



40/116


|29



41/116



Employee Business Object

This example shows how to use several adapter services within a TIBCOBusinessWorks process to get, update, and synchronize an Employee recordstored in the Remedy Action Request System.

Topics





30 | Chapter 5 TIBCO BusinessWorks: Working with the Employee Business Object

Example Description


42/116


p p

This example shows how the adapters Publication, Subscription, andRequest-Response services can be used in a TIBCO BusinessWorks process. Theexample has three processes, Get_Employee,Insert_Update_Delete_Employee, and Sync_Employee.

Get_Employee uses the adapters Request-Response service to fetch data fromthe Remedy Action Request System for key values that you specify in an inputXML file.

Get_Employee queries the Remedy Action Request System based on the givenkey values and fetches the data. The data is sent back by the adapter to TIBCOBusinessWorks and is written to an output XML file.

Insert_Update_Delete_Employee uses the adapters Subscription service toeither insert, update, or delete data in the Remedy Action Request System.


BusinessWorks receives the messages and writes them to an input XML file.The content of this XML file will contain data to be updated in the RemedyAction Request System. TIBCO Adapter for Remedy uses the Subscriptionservice to update this data in the Remedy Action Request System.

Alternatively, you may specify key values in the input XML file.Insert_Update_Delete_Employee inserts, updates or deletes the Employeedetails in the Remedy Action Request System, based on the operation typespecified in the input XML file.

Sync_Employee uses the adapters Publication service to send a message outof the Remedy Action Request System whenever Employee Business Objectdetails are modified or updated in the Remedy Action Request System. Anychange to the data in the Remedy Action Request System triggers theSync_Employee process.


The adapter will publish the data only if the Employee form is configured for

publishing. To configure the Employee form for publishing, see the sectionConfiguring a Remedy Form for Publishing in the TIBCO Adapter for RemedyUsers Guide.


Setup the Example


43/116



Task A Get_Employee, Insert_Update_Delete_Employee and

Sync_Employee Setup:

In TIBCO Designer:


project.


3. Click the Zip Archive tab and browse to locate the Employee_RV.zip file. Thefile is located in the/tibco/adapter/adremedy//examples/Bu

sinessWorks/Employee folder.

4. Save as a multi-file project by the name Employee.5. Substitute the values of the following global variables for design-time

connection:





Or you can specify these values in the examples.tra. In this case, the valuesgiven in project file will be overridden.



Test the Example


44/116




In TIBCO Designer:

1. From the project panel, select the process you want to test. For example,Get_Employee.

2. Click the Set Breakpoints icon.

3. In the window that appears, choose Select All, then click OK.



6. In the process selection window that appears, the Get_Employee is selected bydefault. Click Start Selected. The process is now in Test mode.

7. Click the File Poller icon. In the configuration panel, File Name field, clickBrowse and select the input XML file. Click Apply. Any change to the inputXML file starts the process.




11. The above steps describe the testing for Get_Employee. Follow the same stepsto run the Sync_Employee and Insert_Update_Delete_Employee . TheSync_Employee does not have an input XML file. Any change to the data inthe Remedy Action Request System will invoke the Sync_Employee process.


Expected Results


45/116



/tibco/adapter/adremedy//examples/Busin

essWorks/Employee

Get_Employee data is fetched based on the RequestID and OperationTypeparameters specified in the get_input.xml file and is written into theget_output.xml file. The get_output.xml file should display the followingEmployee record:

000000000000007

Abhishek Saxe

2003-07-17T16:55:46

Example

Demo

2003-12-15T20:31:32

0

Infosys


SE

B

3

uyyyyyyyy

65-34562

[email protected]

2003-07-17T00:00:00

Insert_Update_Delete_Employee data is updated based on the RequestIDand OperationType parameters specified in theinsert_update_delete_input.xml file and is updated in the RemedyAction Request System.

Sync_Employee output is stored in the sync_output.xml file.



46/116


|35



47/116


ItemMaster Business Object

This example shows how to use several adapter services within a TIBCOBusinessWorks process to get, update, and synchronize an ItemMaster recordstored in the Remedy Action Request System.

Topics





36 | Chapter 6 TIBCO BusinessWorks: Working with the ItemMaster Business Object

Example Description


48/116


This example shows how the adapters Publication, Subscription, and

Request-Response services can be used in a TIBCO BusinessWorks process. Theexample has three processes, Get_ItemMaster,Insert_Update_Delete_ItemMaster, and Sync_ItemMaster.

Get_ItemMaster uses the adapters Request-Response service to fetch datafrom the Remedy Action Request System for key values that you specify in aninput XML file.

Get_ItemMaster queries the Remedy Action Request System based on thegiven key values and fetches the data. The data is sent back by the adapter toTIBCO BusinessWorks and is written into an output XML file.

Insert_Update_Delete_ItemMaster uses the adapters Subscription serviceto either insert, update, or delete data in the Remedy Action Request System.

In a typical business scenario, an adapter to another application (for example,SAP or Siebel) publishes a message to the TIBCO environment. TIBCOBusinessWorks receives the messages and writes them to an input XML file.The content of this XML file will contain the data to be updated in the RemedyAction Request System. TIBCO Adapter for Remedy uses the Subscriptionservice to update this data in the Remedy Action Request System.

Alternatively, you may specify key values in the input XML file.Insert_Update_Delete_ItemMaster inserts, updates, or deletes theItemMaster details in the Remedy Action Request System, based on theoperation type specified in the input XML file.

Sync_ItemMaster uses the adapters Publication service to send a messageout of the Remedy Action Request System whenever ItemMaster BusinessObject details are modified or updated in the Remedy Action Request System.Any change to the data in Remedy Action Request System triggers theSync_ItemMaster process.


The adapter will publish the data only if the ItemMaster form is configured for

publishing. To configure the ItemMaster form for publishing, see the sectionConfiguring a Remedy Form for Publishing in the TIBCO Adapter for RemedyUsers Guide.


Setup the Example


49/116


Before starting the example, you must import the sample project zip file and save

it in a new project.

Task A Get_ItemMaster, Insert_Update_Delete_ItemMaster and

Sync_ItemMaster Setup:

In TIBCO Designer:


project.2. Click Project>Import Full Project.

3. Click the Zip Archive tab and browse to locate the ItemMaster_JMS.zip file.The file is located in the/tibco/adapter/adremedy//examples/Bu

sinessWorks/ItemMaster folder.

4. Save as a multi-file project by the name ItemMaster.

5. Substitute the values of the following global variables for design-timeconnection:





Or you can specify these values in the examples.tra. In this case, valuesgiven in the project file will be overridden.


Task B Start the JMS Server:

This example uses JMS as the transport type. Ensure that the JMS server is

running and accessible to the machine on which the adapter is installed beforerunning any of the processes.


Test the Example


50/116




In TIBCO Designer:

1. From the project panel, select the process you want to test. For example,Get_ItemMaster.

2. Click the Set Breakpoints icon.

3. In the window that appears, choose Select All, then click OK.



6. In the process selection window that appears, the Get_ItemMaster is selectedby default. Click Start Selected. The process is now in Test mode.

7. Click the File Poller icon. In the configuration panel, File Name field, clickBrowse and select the input XML file. Click Apply. Any change to the inputXML file starts the process.




11. The above steps describe the testing for Get_ItemMaster. Follow the samesteps to run the Sync_ItemMaster, andInsert_Update_Delete_ItemMaster. The Sync_ItemMaster does not havean input XML file. Any change to the data in the Remedy Action RequestSystem will invoke the Sync_ItemMaster process.


Expected Results


51/116



/tibco/adapter/adremedy//examples/BusinessWorks/ItemMaster

Get_ItemMaster data is fetched based on the RequestID andOperationType parameters specified in the get_input.xml file and is writtento the get_output.xml file. The get_output.xml file should display thefollowing ItemMaster record:

000000000000002

Examples

2003-07-11T16:40:38

Examples

Demo

2003-12-17T11:23:57

0

Digital Disk

1057921838_CTRLD_Demo_CTRLC_Floppy

3.12E0

2.4E1

2.0E0

6.0E0

2.0E0

CH501223

Insert_Update_Delete_ItemMaster data is updated based on theRequestID and OperationType parameters specified in theinsert_update_delete_input.xml file and is updated in the RemedyAction Request System.

Sync_ItemMaster output is stored in the sync_output.xml file.



52/116


|41

Chapter 7 TIBCO IntegrationManager: Examples for



53/116



This chapter gives examples and scenarios that demonstrate adapter functionalityusing the Employee Business Object.

TIBCO IntegrationManager sheets are provided with the adapter installation forintegrating with the adapter services and testing the services.

Topics

Overview, page 42

Publication Service Configuration, page 43

Subscription and Request-Response Service Configuration, page 46

Employee Business Object Operations, page 50

42 | Chapter 7 TIBCO IntegrationManager: Examples for Employee Business Object

Overview


54/116


Examples and scenarios that demonstrate adapter functionality using the

Employee Business Object are listed here:

Publication Service

Subscription Service

Request-Response

Publication Service Configuration |43

Publication Service Configuration


55/116


When running a Publication Service, the adapter extracts data from modified

rows in database tables, and publishes them on appropriate subject names.

This example explains how to configure the adapter to publish data toapplications in the TIBCO environment.

1. Import Employee.def fromTIBCO_HOME\adapter\adremedy\\examples\employee intoRemedy Administrator.

2. Make a backup copy ofEmployee_RV.dat from the locationTIBCO_HOME\adapter\adremedy\\examples\employee .Open Employee_RV.dat in TIBCO Designer. (Open Employee_JMS.dat if youare using JMS).

3. The Design-time Connection tab allows you to define the connectionparameters used to connect to the database during configuration and atrun-time. Additionally, you can define re-connection parameters, which areused at run-time in case of connection loss. Use the following fields to set up

Design-time connection options:

Action Request Server Name The name or IP address of the ActionRequest Server. This is a mandatory field.

Username The account name used by the adapter to access data stored inAR System. This is a mandatory field.

Password The password for the account.

Remember Password Select this check box if you want to save thepassword to the repository. If this check box is cleared, you have to re-enterthe password when you close and re-open the repository.

Port The port number to which the adapter connects. This is a mandatoryfield

Private Queue The private queue number to which the adapter connects.This is a mandatory field. Specify 0 for the default value.

Use Design-time Connection Settings for Run-time Select this check box ifyou wish to use the design-time connection parameters for run-time. Onchecking this field, design-time parameters are copied to the Run-timeConnection tab and run-time fields are disabled. On clearing the check box,


the run-time fields are enabled, and you can enter different run-timeparameters.


56/116


4. Click Apply. Click Test Connection to verify if your connection parametersare right. When the Connection is successful message appears, click OK.

5. In the Configuration tab, click the Show All Tabs check box and select theAdapter Services tab. Specify the following options:

Publisher Polling Interval Enter a specific polling period in milliseconds.This is how often a Publication Service checks the publishing table for newrows. The default is 15000, or once every fifteen seconds.

Publishing Table This field has been disabled.

You can specify values to global variables instead of typing in the value for each

field again for each adapter instance.


Click Apply.


57/116


6. Save the project.

7. In Remedy Administrator, go to the filter TIB:ADREMEDY5.2.0/AR/FILTER ,check Employee in the form list and save.

8. Specify the required value for the parameter

tibco.clientVar.adremedyPassword in the adremedy_EM_RV.tra file(adremedy_EM_JMS.tra for JMS) placed inTIBCO_HOME\adapter\adremedy\\examples\employee .

9. Run the adapter using the command

adremedy --run --propFile

TIBCO_HOME\adapter\adremedy\\examples\employee\adr

emedy_EM_RV.tra

(adremedy_EM_JMS.tra for JMS)

10. Update data in the Employee form using Remedy User Client or any otherapplication.

The adapter will publish the updated data to the TIBCO environment.


Subscription and Request-Response Service Configuration


58/116


When running a Subscription Service, the adapter listens on a subject, receives

messages and updates the relevant tables in its associated database. The data isthen available to other applications that have access to the database.

When running a Request-Response Service, the adapter receives requests fromother TIBCO applications, parses them, and passes the request to the database.The result obtained from the database is wrapped in a schema and sent back tothe caller.

Common Steps for Subscription Service and Request-Response Service

The following steps are common for Subscription and Request-Response Services.

1. Import Employee.def fromTIBCO_HOME\adapter\adremedy\\examples\employee intoRemedy Administrator.

2. Make a backup copy ofEmployee_RV.dat from the locationTIBCO_HOME\adapter\adremedy\\examples\employee .Open Employee_RV.dat in TIBCO Designer. (Open Employee_JMS.dat if youare using JMS).

3. The Design-time Connection tab allows you to define the connectionparameters used to connect to the database during configuration and atrun-time. Additionally, you can define re-connection parameters, used atrun-time in case of connection loss. Use the following fields to set up

Design-time connection options: Action Request Server Name The name or IP address of the Action Request

Server. This is a mandatory field.






Subscription and Request-Response Service Configuration |47

Use Design-time Connection Settings for Run-time Select this check box ifyou wish to use the design-time connection parameters for run-time. Onchecking this field, design-time parameters are copied to the Run-timeConnection tab and run time fields are disabled On clearing the check box


59/116


Connection tab and run-time fields are disabled. On clearing the check box,

the run-time fields are enabled, and you can enter different run-timeparameters.



6. Open Employee_RV.dat in TIBCO IntegrationManager editor(Employee_JMS.dat for JMS).

You can specify values to global variables instead of typing in the value for eachfield again for each adapter instance.


60/116


Request-Response Service

For the Request-Response Service, follow the steps in Common Steps forSubscription Service and Request-Response Service and do the following:


61/116


Run the TIBCO IntegrationManager process Proc_Get_Employee that willcreate an entry in the Employee form.

The retrieved data is displayed in the TIBCO IntegrationManager Engineoutput console and also written to the fileTIBCO_HOME\IM\\bin\Get_Employee_Reply. (To change theoutput directory, click the Write_To_File component in the design view ofthe process diagram).


Employee Business Object Operations

Follow the steps given in the Common Steps for Subscription Service and


62/116


Follow the steps given in the Common Steps for Subscription Service and

Request-Response Service before running the following Business Objectoperations.

Get Operation

For the Get operation, do any one of the following:

Send a tibrvsend "EMPLOYEE.GET.RV" ("EMPLOYEE.GET.JMS" for JMS)

Run the TIBCO IntegrationManager process Proc_Get_Employee that will getdata from the Employee form.

This will get the Employee Business Object from the AR System anddisplay it in the TIBCO IntegrationManager Engine Console.

The retrieved data is also written to the fileTIBCO_HOME\IM\\bin\Get_Employee_Reply (To changethe output directory, click the Write_To_File component in the design

view of the process diagram).

Update Operation

For the Insert_Update operation, do any one of the following:

Send a tibrvsend "EMPLOYEE.UPDATE.RV" ("EMPLOYEE.UPDATE.JMS" forJMS)

Run the TIBCO IntegrationManager process Proc_Update_Employee that willupdate an entry in the Employee form.

This will update an Employee Business Object record in the AR System.

Delete Operation

For the Delete operation, do any one of the following:

Send a tibrvsend "EMPLOYEE.DELETE.RV" ("EMPLOYEE.DELETE.JMS" forJMS)

Run the TIBCO IntegrationManager process Proc_Delete_Employee that willupdate an entry in the Employee form.

This will delete the Employee Business Object record in the AR System.

Employee Business Object Operations |51

Insert Operation

For the Insert operation, do any one of the following:

Send a tibrvsend "EMPLOYEE.INSERT.RV" ("EMPLOYEE.INSERT.JMS" for


63/116


JMS) Run the TIBCO IntegrationManager process Proc_Insert_Employee that will

update an entry in the Employee form.

This will insert an Employee Business Object record in the AR System.


Stopping the Adapter

Use one of the following methods to stop the adapter:


64/116


g p p

From a command prompt window, either close the window in which theadapter is running or type Ctrl-C in the window. It is not recommended touse this method.

From a command window, stop the adapter by sending a TIBCO Rendezvousor JMS message on the terminate subject. The terminate subject has thefollowing syntax:

%%Domain%%.%%Deployment%%.adremedy..exit

where is the adapter configuration name and is an arbitrary string. See General Tab in Chapter 4 Adapter Instance Optionsin TIBCO Adapter for Remedy Users Guide for information about specifying theterminate subject or topic.

For example, the next command uses tibrvsend to send a message on the

terminate subject to stop the adapter.tibrvsend

MyDomain.MyDeployment.adremedy.RemedyConfiguration

exit now

Using TIBCO Hawk Display, invoke the stopApplicationInstance()method.

|53

Chapter 8 TIBCO IntegrationManager: Examples for

Customer Business Object


65/116


This chapter gives examples and scenarios that demonstrate adapter functionalityusing the Customer Business Object.

TIBCO IntegrationManager sheets are provided with the adapter installation forintegrating with the adapter services and testing the services.

Topics

Overview, page 54

Publication Service Configuration, page 55

Subscription and Request-Response Service Configuration, page 58

Customer Business Object Operations, page 62

54 | Chapter 8 TIBCO IntegrationManager: Examples for Customer Business Object

Overview

Examples and scenarios that demonstrate adapter functionality using the


66/116


Customer Business Object are listed here: Publication Service


Request-Response


Publication Service Configuration

When running a Publication Service, the adapter extracts data from modified


67/116


rows in database tables, and publishes them on appropriate subject names.This example explains how to configure the adapter to publish data toapplications in the TIBCO environment.

1. Import Customer.def fromTIBCO_HOME\adapter\adremedy\\examples\Customer intoRemedy Administrator.

2. Make a backup copy ofCustomer_RV.dat from the locationTIBCO_HOME\adapter\adremedy\\examples\Customer .Open Customer_RV.dat in TIBCO Designer. (Open Customer_JMS.dat ifusing JMS).

3. The Design-time Connection tab allows you to define the connectionparameters used to connect to the database during configuration and atrun-time. Additionally, you can define re-connection parameters, used atrun-time in case of connection loss. Use the following fields to set up

Design-time connection options:

Action Request Server Name The name or IP address of the ActionRequest Server. This is a mandatory field.





Private Queue The private queue number to which the adapter connects.This is a mandatory field. Specify 0 for default value.



the run-time fields are enabled and you can enter different run-timeparameters.

You can specify values to global variables instead of typing in the value for each


68/116



5. In the Configuration tab, click the Show All Tabs check box and select theAdapter Services tab. Specify the following options:

Publisher Polling Interval Enter a specific polling period in milliseconds.This is how often a Publication Service checks the publishing table for newrows. The default is 15000, or once every fifteen seconds.

Publishing Table This field has been disabled.

field again for each adapter instance.


Click Apply.


69/116



7. In the Remedy Administrator, go to the filterTIB:ADREMEDY5.2.0/AR/FILTER , check Customer in the form list and save.

8. Specify the required value for the parameter

tibco.clientVar.adremedyPassword in the adremedy_emp.tra placed inTIBCO_HOME\adapter\adremedy\\examples\Customer .



TIBCO_HOME\adapter\adremedy\\examples\Customer\adr

emedy_CU_RV.tra

(adremedy_CU_JMS.tra for JMS)

10. Update data in the Customer form using the Remedy User Client or any otherapplication.

The adapter will publish the updated data on the TIBCO environment.


Subscription and Request-Response Service Configuration

When running a Subscription Service, the adapter listens on a subject, receives

d d h l bl i i i d d b Th d i


70/116


messages, and updates the relevant tables in its associated database. The data isthen available to other applications that have access to the database.

When running a Request-Response Service, the adapter receives requests fromother TIBCO applications, parses them and passes the request to the database.The result obtained from the database is wrapped in a schema and sent back tothe caller.

Common Steps for Subscription Service and Request-Response Service

The following steps are common for Subscription and Request-Response Services.

1. Import Customer.def fromTIBCO_HOME\adapter\adremedy\\examples\Customer intoRemedy Administrator.

2. Make a backup copy ofCustomer_RV.dat from the location

TIBCO_HOME\adapter\adremedy\\examples\Customer .Open Customer_RV.dat in TIBCO Designer. (Open Customer_JMS.dat ifusing JMS).

3. The Design-time Connection tab allows you to define the connectionparameters used to connect to the database during configuration and atrun-time. Additionally, you can define re-connection parameters, which isused by the run-time in case of connection loss. Use the following fields to set

up Design-time connection options: Action Request Server Name The name or IP address of the Action

Request Server. This is a mandatory field.








th ti fi ld bl d d t diff t ti


71/116


the run-time fields are enabled and you can enter different run-timeparameters.



6. Open Customer_RV.dat in TIBCO IntegrationManager editor(Customer_JMS.dat for JMS).

7. Go to the Debug tab and start the Debug Engine.

You can specify values to global variables instead of typing in the value for eachfield again for each adapter instance.



72/116


8. Specify the required value for the parametertibco.clientVar.adremedyPassword in the adremedy_CU_RV.tra placed inTIBCO_HOME\adapter\adremedy\\examples\[form name].



TIBCO_HOME\adapter\adremedy\\examples\Customer\adr

emedy_CU_RV.tra

(adremedy_CU_JMS.tra for JMS)


For the Subscription Service, follow the steps in Common Steps for SubscriptionService and Request-Response Service and do the following:

Run the TIBCO IntegrationManager process Proc_Insert_Customer that willcreate an entry in the Customer form.

In case of JMS, start the JMS Server. To start from a command prompt, type thefollowing \bin\tibjmsd.


Request-Response Service

For the Request-Response Service, follow the steps in Common Steps forSubscription Service and Request-Response Service and do the following:

Run the TIBCO IntegrationManager processProc_Get_Customer

that willt t i C t f


73/116


Run the TIBCO IntegrationManager process that willcreate an entry in Cu

tib adrmd examples

Documents