+ All Categories
Home > Documents > TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists...

TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists...

Date post: 27-Jul-2018
Category:
Upload: dinhdiep
View: 225 times
Download: 0 times
Share this document with a friend
32
TIBCO ActiveMatrix ® Adapter for OSIsoft PI Concepts Software Release 1.0 November 2012
Transcript
Page 1: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO ActiveMatrix® Adapter forOSIsoft PIConceptsSoftware Release 1.0November 2012

Page 2: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix
Page 3: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Notice

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 LICENSE AGREEMENT,OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENTWHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH ISDUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT ORCLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OFTHE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOURUSE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

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

TIBCO, The Power of Now, ActiveMatrix, and TIBCO Enterprise Message Service are either registered trademarksor trademarks of Software Inc. in the United States and/or other countries.

EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of SunMicrosystems, Inc. in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of their respectiveowners 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. CHANGESARE PERIODICALLYADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATEDIN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/ORCHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANYTIME.

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

Copyright (c) 2005-2012 Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

Page 4: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix
Page 5: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Contents

Preface: Preface...................................................................................7TIBCO Product Documentation................................................................................................8

Connecting withTIBCO Resources...........................................................................................9

Chapter 1: Adapter Introduction.......................................................11Adapter Overview...................................................................................................................12

Adapter Components.............................................................................................................13

Adapter Key Terms.................................................................................................................14

AdapterServices.....................................................................................................................15

Adapter Life Cycle..................................................................................................................16

Chapter 2: TIBCO ActiveMatrix Adapter for OSIsoft PI..................19Overview................................................................................................................................20

Adapter Architecture...............................................................................................................21

Runtime Adapter..........................................................................................................21

Polling..........................................................................................................................21

Durable Registration....................................................................................................22

Multi-file Format Projects.............................................................................................22

DAT File Format...........................................................................................................22

Fault Tolerance............................................................................................................22

Adapter Services....................................................................................................................23

Publication Service......................................................................................................23

Request-Response Services.......................................................................................23

Chapter 3: Adapter Infrastructure Tools..........................................25TIBCO Runtime Agent............................................................................................................26

TIBCO Domain Utility..................................................................................................26

TIBCO Designer.....................................................................................................................27

TIBCO Administrator..............................................................................................................28

TIBCO Administration Domain....................................................................................28

TIBCO Administration Server......................................................................................28

TIBCO Administrator GUI............................................................................................29

TIBCO ActiveMatrix BusinessWorks......................................................................................30

TIBCO Hawk..........................................................................................................................31

| TOC | 5

Page 6: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

6 | | TOC

Page 7: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Preface

Preface

TIBCO ActiveMatrix Adapter for OSIsoft PI software allows data exchange between PI Server and otherTIBCO applications. It extends request-response and publication technology to PI Server.

The adapter connects remotely to a PI Server.

Page 8: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Product Documentation

This section lists documentation resources you may find useful.

The following documents form the TIBCO ActiveMatrix Adapter for OSIsoft PI documentation set:• Concepts: Read this manual before reading any other book in the documentation set. This book describes

the adapter, adapter features, and the applications that the adapter interacts with.• Installation: Read this manual to learn how to install TIBCO ActiveMatrix Adapter for OSIsoft PI.• Configuration and Deployment: This manual explains how to create and configure adapter projects.

Information on deploying adapter projects is also included.• Examples: This manual provides instructions to run the examples that demonstrate use of the adapter.• Release Notes: Read this manual for a list of new and changed features, steps for migrating from a previous

release, and lists of known issues and closed issues for the release.

8 | | Introduction

Page 9: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Connecting withTIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination forTIBCO customers, partners, and resident experts. It is a place toshare and access the collective experience of the TIBCOcommunity. TIBCOmmunity offers forums, blogs,and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access TIBCO Documentation

After you joinTIBCOmmunity, you can access the documentation here: http://docs.tibco.com.

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows:• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this

site:

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

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

https://support.tibco.com

Entry to this site requires a username and password. If you do not have a username, you can request one.

Introduction | | Preface | 9

Page 10: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix
Page 11: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Chapter

1Adapter Introduction

This chapter introduces basic concepts of adapters.

Topics

• Adapter Overview• Adapter Components• Adapter Key Terms• AdapterServices• Adapter Life Cycle

TIBCO ActiveMatrix® Adapter for OSIsoft PI

Page 12: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Overview

To deploy the best solution for each aspect of your business, you usually have to purchase applications fromseveral different application vendors. Unfortunately, vendors typically have their own way to format andexpose data. Therefore integrating the various applications across your enterprise poses significant challenges.

An adapter provides a bridge between an application and your TIBCO integration environment. Using ano-coding approach to integration, TIBCO Adapters enable packaged applications, databases, and othertechnologies to become active participants in the enterprise information flow, regardless of their data formatsor communication protocols. Integration of new applications does not require programming skills and doesnot interfere with existing infrastructure.

Adapters isolate the application from more complex actions. Message transformation and business processautomation can be handled once the data is published to the TIBCO infrastructure.

Adapters allow data to be exchanged among different technologies.• Adapters are available for off-the-shelf applications from leading vendors. Each adapter integrates with

at least one, and usually several, of the interfaces exposed by the vendor application.• Database adapters enable an enterprise’s database to initiate important business processes based on

exception data they identify. Database adapters also make data available to the enterprise.• Mainframe adapters enable real-time two way communication between them and the rest of a companies’

business applications and databases.• Adapters can also enable integration with component or object development models and other messaging

technologies.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

12 | Adapter Introduction

Page 13: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Components

The adapter runs as a standalone process. This adapter component is referred to as the standalone adapter.

Standalone adapter projects are created and configured using TIBCO Designer and deployed using TIBCOAdministrator.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

Adapter Introduction | 13

Page 14: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Key Terms

The following key terms are used when describing adapter interactions in this manual.• A palette is a standalone adapter component that contains the screens used to gather input at design-time

when configuring an adapter with a service. The palette is accessed via TIBCO Designer.• A project is a collection of all configured adapter resources. A project contains configuration information

for one or more adapter instances. A local project is typically used at design-time for testing adapterinstances. For production, a project is typically managed by an administration server provided by theTIBCO Administrator for the standalone adapter and TIBCO ActiveMatrix Administrator for the adapterservice engine.

• An .ear of an application contains global variables with values set at design-time by the standalone adapter.The global variables can be changed at deployment at the application level, service level, or service instancelevel.

• Service Oriented Architecture (SOA) is a software architecture in which applications and data aredecomposed into discrete, operationally independent services, which can be executed in a highly distributedmanner.

• A business object is the representation of the data model of the entities that the adapter service engineconnects to. The business objects are downloaded during also the design phase and are used by the adapterservices.

• A container is an ActiveMatrix runtime entity that hosts component implementations and service bindings.• A service assembly is an ActiveMatrix deployment package. It contains service units and a descriptor that

indicates the container into which each service unit is to be deployed. The suffix of a service assembly fileis .saf.

• The ActiveMatrix services are described in documents expressed in Web Services Description Language(WSDL). The WSDL documents specify the messages that are required to access a service.

• During any service interaction, each service will adopt one of two roles: provider or consumer. A serviceprovider publishes a WSDL document that describes the services it offers. A service consumer uses theWSDL document to determine the available services and the messages required to access the services. Amessage exchange pattern (MEP) defines the sequence and cardinality of messages sent between theprovider and the consumer.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

14 | Adapter Introduction

Page 15: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

AdapterServices

Adapters are responsible for making information from different applications available to other applicationsacross an enterprise. To do so, an adapter is configured to provide one or more of the following services:

Publication Service

An adapter publication service recognizes when business events happen in a vendor application, andasynchronously sends out the event data in realtime to interested systems in the TIBCO environment.

For example, an adapter can publish an event each time a new customer account is added to an application.Other applications that receive the event can then update their records just as the original application did.

Subscription Service

An adapter subscription service asynchronously performs an action—such as

updating business objects or invoking native APIs—on a vendor application. The adapter service listens toexternal business events, which trigger the appropriate action.

Referring to the previous example, an adapter subscription service can listen for customer record creationevents (happening in an application and published to the TIBCO infrastructure) and update another application.

Request-Response Service

In addition to asynchronously publishing and subscribing to events, an adapter can be used for synchronouslyretrieving data from or executing transactions within a vendor application. After the action is performed inthe vendor application, the adapter service sends a response back to the requester with either the results ofthe action or a confirmation that the action occurred. This entire process is called request-response, and it isuseful for actions such as adding or deleting business objects.

In the next example, an adapter receives a request message from the TIBCO infrastructure and sends it to anapplication. The adapter gets a response from the application and returns it.

Request-Response Invocation Service

An adapter request-response invocation service is similar to the request-response service, except that theroles are reversed. The vendor application is now the requester or initiator of the service, instead of theprovider of the service. The adapter service acts as a proxy, giving the vendor application the ability to invokesynchronously functionality on an external system.

For example, the adapter sending a request message from application Y to application X. After it processesthe message, it is returned to the adapter, which sends the response back to application Y.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

Adapter Introduction | 15

Page 16: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Life Cycle

This section describes the high-level steps required to configure and deploy an adapter. Each of these stepsare described in details in subsequent chapters. Adapter projects are configured using TIBCO Designer.

Configuration

1. Configure the Vendor Application to work with the Adapter

This task is completed as part of installing the adapter and before configuring an adapter instance for thefirst time.

2. Define an Adapter Project

When starting TIBCO Designer, you create or select a project. A project contains adapter configurationinformation, such as the service and messaging transport to use, logging options, and other specific settings.A project is opened and saved in multi-file format, which allows a version control system to manage thefiles associated with the project.

3. Set Global Variables

By default each project you create in TIBCO Designer includes several global variables. Global variablesprovide an easy way to set defaults for use throughout your project. Default values are predefined forsome of the variables. You can define additional variables and, optionally, set their values when configuringyour adapter.

When the project is deployed and the configured adapters are run, all occurrences of the global variablename are replaced with the global variable value.

A global variable value set in TIBCO Designer can be overridden at run-time by redefining the value inTIBCO Administrator.

4. Create and Configure Adapter Services5. Test the Adapter Configuration

The adapter tester can be used to verify an adapter service after it has been configured. When invoked,all adapter services configured in the project are displayed. You select the adapter service to test, and startand stop the adapter from the tester. The tester window displays adapter output within the tool so youcan easily view results.

Deployment

During development, you save your design to a project. When you are ready to deploy your project to amachine, you generate an Enterprise archive file (EAR file) from TIBCO Designer. The EAR file containsinformation on what you wish to deploy.1. Generate and Import an Enterprise Archive File

An Enterprise Archive file contains adapter instance configuration information, which is used by a runtimeadapter. An Enterprise Archive file is generated using TIBCO Designer and imported into TIBCOAdministrator.

2. Specify Deployment Information

After importing an Enterprise Archive file, the adapter can be deployed. This involves:• Assigning adapter services to the machines in the administration domain.• Specifying startup options for each process engine and adapter service.

3. Specify Monitoring Options

Before starting the adapter you can optionally specify monitoring options, including:

TIBCO ActiveMatrix® Adapter for OSIsoft PI

16 | Adapter Introduction

Page 17: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Specifying alerts or TIBCO Hawk rulebases for each machine.•• Specifying alerts and TIBCO Hawk rulebases for an adapter service.• Setting log file properties for an adapter service instance.

4. Start the Adapter

The adapter is started and stopped using the TIBCO Administrator GUI.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

Adapter Introduction | 17

Page 18: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix
Page 19: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Chapter

2TIBCO ActiveMatrix Adapter for OSIsoft PI

This chapter explains the features and services of TIBCO ActiveMatrix Adapter for OSIsoft PI.

Topics

• Overview• Adapter Architecture• Adapter Services

TIBCO ActiveMatrix® Adapter for OSIsoft PI

Page 20: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Overview

TIBCO ActiveMatrix Adapter for OSIsoft PI software allows data exchanges between PI Server and otherTIBCO applications. It extends request-response and publish technology to PI Server. The adapter remotelyconnects to a PI Server.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

20 | TIBCO ActiveMatrix Adapter for OSIsoft PI

Page 21: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Architecture

TIBCO ActiveMatrix Adapter for OSIsoft PI software allows data exchange between PI Server and applicationsconfigured for the TIBCO environment.

The following diagram shows the architecture of the standalone adapter. Configuration data is stored inprojects that can be used by one or more adapters. The components are explained in this section and thefollowing section.

Figure 1:TIBCO ActiveMatrix Adapter for OSIsoft PI Environment

Runtime Adapter

A runtime adapter service acts as bi-directional bridge between your PI Server and the TIBCO environment.A publication service monitors registered PI Points for new values and sends them on an appropriate subjects.

An adapter can also be configured to use request-response services, which allows the adapter to act on behalfof a TIBCO application, processing its requests and returning responses.

Polling

An adapter publication service uses periodic polling provided by PI SDK Software to monitor PI Points inPI Server. Each group can have configured different polling interval. It can be very useful in case when clientneeds to be notified either as soon as it is possible when the change occurs or it is not neccesary to knowabout the change immediately.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

TIBCO ActiveMatrix Adapter for OSIsoft PI | 21

Page 22: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Durable Registration

TIBCO ActiveMatrix Adapter for OSIsoft PI provides durable registration for PI Points value changes. Whensubscribtion request contains durable flag set to true, then this registration will be automaticaly subscribedwhen the adapter is restarted. Non-durable registrations are lost when the adapter is restarted.

The adapter saves persistent registrations to the persistent storage. On the other hand, when request forunregistration comes, the adapter removes PI Points from the persistent storage. When the adapter is restarted,the persistent storage is reduced to contain only relevant data.

Multi-file Format Projects

The multi-file format creates one ActiveEnterprise XML file for each logical object (such as an adapter instance,a set of related ActiveEnterprise classes, or a TIBCO ActiveMatrix BusinessWorks process flow) that occursin the repository instance. This kind of project is referred to as a multi-file project.

Multi-file projects can be checked into a version control system, and a project can contain more than oneadapter configuration. This allows a number of people to work on the same project at the same time, withdifferent people working on each adapter configuration: a developer can check out the specific filecorresponding to an object that needs to be changed, updated the file, and check it back in. TIBCO Designeraccesses the local synchronized copies of the files on the developer's hard drive.

For more information see TIBCO ActiveMatrix Adapter for OSIsoft PI Configuration and Deployment.

DAT File Format

For production and for testing with runtime adapters, developers export multi-file projects to DAT formatusing the TIBCO Designer menu commands. A project can be exported as a local project for local testing orexported to be managed by a repository server.

Fault Tolerance

Within the context of the adapter, a primary instance is the adapter instance that processes messages betweenthe TIBCO environment and the PI Server. The secondary instance uses the same TIBCO Designer projectbut runs in a stand-by mode and takes over when the primary instance goes down. The secondary instance(s)need not run on the machine or platform as the primary instance.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

22 | TIBCO ActiveMatrix Adapter for OSIsoft PI

Page 23: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Adapter Services

The adapter offers publication and request-response services. Communication parameters, PI Serverconnectivity parameters, and many other parameters can be configured for these adapter services usingTIBCO Designer. The following sections describe how these adapter services interact with the PI Serverenvironment to provide message connectivity with it.

Publication Service

The following diagram illustrates publication service. Some system updates values of PI Points monitoredby TIBCO ActiveMatrix Adapter for OSIsoft PI. The adapter receives data (new values and timestamps) fromPI Server and publishes it on the specified transport (TIBCO Rendezvous or TIBCO Enterprise MessageService). This data is then available to other applications listening on these transports.

For receiving PI Points new values from PI Server it is necessary to call registration service. With registrationPI Points can be divided to groups. Each group has defined its polling interval. If not, default polling intervalis used. Adapter also provides unregistration service. When PI Points are unregistered from group, clientwill not receive their new values anymore.

The TIBCO ActiveMatrix Adapter for OSIsoft PI supports durable registration. Using durable registrationyou will not lose your registration after adapter restart. For more details please refer to chapter Durableregistration.

Figure 2:Typical Publication Service Flow

Request-Response Services

TIBCO ActiveMatrix Adapter for OSIsoft PI provides several request-response services. All of them are listedbelow.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

TIBCO ActiveMatrix Adapter for OSIsoft PI | 23

Page 24: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

• Read the most recent values of PI Points - The adapter is able to return the most recent values of PI Points.• Insert new values to PI Points - The adapter is able to insert new values to PI Points.• Read PI Points definitions - The adapter is able to return definitions including all important attributes for

PI Points.• Read historical values of PI Point - The adapter is able to return historical values from archive.• Register for PI Points value changes - The adapter is going to register PI Points into group for tracking their

value changes.• Unregister for PI Points value changes - The adapter is going to remove PI Points from group for tracking

value changes.

Figure 3:Typical Request-Response Service Flow

The adapter can also be configured to manage requests using load balancing among a set of adapters thatparticipate in the same named queue. Additionally, the adapter has been designed to allow multiple threadsto process application requests.

TIBCO ActiveMatrix® Adapter for OSIsoft PI

24 | TIBCO ActiveMatrix Adapter for OSIsoft PI

Page 25: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Chapter

3Adapter Infrastructure Tools

This chapter introduces the required and optional TIBCO infrastructure tools that work with an adapter.

Topics:

• TIBCO Runtime Agent• TIBCO Designer• TIBCO Administrator• TIBCO ActiveMatrix BusinessWorks• TIBCO Hawk

Page 26: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Runtime Agent

The TIBCO Runtime Agent provides basic connectivity between the adapter and other TIBCO infrastructuretools. TIBCO Runtime Agent is required on any machine on which an adapter is installed. TIBCO RuntimeAgent runs on each machine on which an adapter runs and executes scripts, sends alerts, and performsrecovery as specified.

TIBCO Runtime Agent has two main functions:• Supplies an agent that runs in the background on each machine.

The agent is responsible for starting and stopping processes that run on a machine according to thedeployment information.The agent monitors the machine. That information is then visible through the TIBCO AdministratorGUI.

• Supplies the runtime environment, that is, all shared libraries including third-party libraries required bythe adapter.

TIBCO Domain Utility

The TRA contains the TIBCO Domain Utility, which is used to manage the components available on a TIBCOadministration domain. The utility allows you to:• Add or remove a machine to a TIBCO administration domain.• Add or remove the TIBCO Enterprise Message Service server plug-in to a TIBCO administration domain.• Change TIBCO Rendezvous parameters. This is an advanced option performed only by users familiar

with TIBCO Rendezvous. If you want to perform this task, you must perform it on each machine in theTIBCO administration domain, then restart the TIBCO Administration Server.

• Change TIBCO administration domain credentials. This is an advanced option. You must perform it onthe machine that hosts the TIBCO Administration Server.

• Remove a secondary TIBCO Administration Server.• Enable TIBCO administration domain and security management on a machine that hosts TIBCO

Administrator.• Migrate previous TIBCO Administrator installations.

26 | | Adapter Infrastructure Tools

Page 27: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Designer

TIBCO Designer provides the design-time environment for configuring a standalone adapter project. UsingDesigner, you create a project, add adapter services to it with a simple drag-and-drop interface, and specifythe configuration information for each adapter service.

Before using TIBCO Designer, ensure that you have read the TIBCO Designer documentation. Thedocumentation can be accessed via theTIBCO Designer Help > Designer Help from the menu bar. Thefollowing figure shows the TIBCO Designer interface.

The standalone adapter adds a palette to the TIBCO Designer environment which provides the adapterspecific resources.

| Adapter Infrastructure Tools | 27

Page 28: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Administrator

TIBCO Administrator provides user, resource, and application management modules for adapters.

User Management This module allows you to set permissions for adapter users. You can define authentication,users and groups, and assign access control lists to users. This includes security for server-based projects atdesign-time and for deployed applications at runtime.

Resource Management This module allows you to monitor machines and running applications in a TIBCOadministration domain. Alerts can be created, for example, to notify an administrator if the number ofprocesses or disk usage exceed a certain level.

Application Management This module allows you to upload Enterprise Archive (EAR) files, and create,configure, and deploy adapters. This module is also used to start and stop adapters.

Load balancing An adapter can be served by a primary and secondary TIBCO Administration Server. Theprimary server allows read and write operations, while the secondary server supports read operations. Loadbalancing is implemented through the use of the TIBCO Rendezvous distributed queue protocol (RVDQ)and therefore is not available for HTTP.

To get the load balancing benefit with HTTP, you must either use an IP redirector or explicitly point to abackup server. Refer to the IP Redirector or HTTP Server documentation for instructions on how to do this.

Failure recovery You can use a load-balanced TIBCO Administration Server for failure recovery. In acompletely trusted environment, you can also use a database back-end for your server and use checkpointsin the database for failure recovery.

TIBCO Administration Domain

A TIBCO administration domain is installed only if you have installed the User Management module.

A TIBCO administration domain is a collection of users, machines, and components that an administrationserver manages. There is only one Administration Server for each administration domain. Components withinan administration domain can communicate with systems outside of the domain, but the domain is theadministrative boundary of your enterprise integration project.

Each TIBCO administration domain contains one or more machines. Each machine can belong to only oneTIBCO administration domain.

By default, all machines within an administration domain are expected to be in the same subnet. You can setup your system to use TIBCO Rendezvous rvrdand then use the components across subnets. See the TIBCOAdministrator Server Configuration Guide for details.

TIBCO Administration Server

The TIBCO Administration Server provides a central storage and distribution point for configuration dataand schema data needed by an adapter. The server is included in both Administrator editions.

Each administration domain has single TIBCO Administration Server. The TIBCO Administration Server isthe machine process that handles the stored projects and requests to manage the TIBCO administrationdomain.

The TIBCO Administrator Server contains its own web server (Apache Tomcat) that can be accessed throughthe TIBCO Administrator GUI for configuration and monitoring information.

The TIBCO Administration Server supports centralized authentication and authorization. Using the TIBCOAdministrator GUI, users with full administrative privileges can define who has access to projects that aremanaged by the repository server.

28 | | Adapter Infrastructure Tools

Page 29: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Administrator GUI

You can access the TIBCO Administration Server using the web-based TIBCO Administrator GUI. The GUIallows you to create user profiles and assign access to projects managed by the Administration Server. Youcan invoke the GUI from any machine in a TIBCO administration domain.

Figure 4:TIBCO Administrator GUI

| Adapter Infrastructure Tools | 29

Page 30: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO ActiveMatrix BusinessWorks

TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allowsyou to develop integration projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user interfacefor defining business processes and an engine that executes the process.

In TIBCO ActiveMatrix BusinessWorks, adapter services publish or subscribe to business data in a decoupledyet reliable manner. The business process receives data from, and routes data to, an adapter service.

TIBCO ActiveMatrix BusinessWorks provides the following activities for use with adapters:• Publish to Adapter—Publishes data from the process to an adapter, which subscribes to data coming from

the process and passes the data to the target application.• Adapter Subscriber—Subscribes to incoming data published by the adapter.• Invoke an Adapter Request-Response Service—Communicates (as a client) with an adapter

Request-Response Service.• Adapter Request-Response Server—Starts a process based on the receipt of a request from an adapter.• Respond to Adapter Request—Sends a response to an adapter for a previously received request.• Wait for Adapter Message—Waits for the receipt of a message from the Publication Service of the specified

adapter.• Wait for Adapter Request—Waits for the receipt of a request from a Request-Response Invocation Service.

See the TIBCO ActiveMatrix BusinessWorks documentation for more information.

30 | | Adapter Infrastructure Tools

Page 31: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

TIBCO Hawk

TIBCO Hawk monitors and manages distributed applications and systems throughout the enterprise. Systemadministrators can monitor application parameters, behavior, and loading activities for all nodes in a localor wide-area network and take action when pre-defined conditions occur. In many cases, runtime failuresor slowdowns can be repaired automatically within seconds of their discovery, reducing unscheduled outages,and slowdowns of critical business systems.

TIBCO Hawk features include:• Extensive monitoring capabilities at the operating system and application levels including process data,

disk, and CPU utilization, network statistics, log, and system files.• Built-in routines within other TIBCO ActiveEnterprise components allow for proactive management.

Problems can be found and fixed before failure occurs.• Hawk Application Management Interface (AMI) routines can be embedded within custom adapters,

allowing active management of those adapters by the Hawk microagents.• Distributed microagents support autonomous network behavior so local management and problem

resolution can continue during an outage.• Fault tolerance is achieved through the independent operation of Hawk agents, which continue to perform

local tasks even in the event of network failure.

TIBCO Hawk consists of several components: a console display, a central repository for storage of configurationobjects, agents, and microagents whose monitoring duties are defined by the rule bases.• Agents monitor local conditions and take action or publish alert information that appears in the TIBCO

Hawk display.• Microagents act as an interface to the managed objects and are invoked through their supported methods.

| Adapter Infrastructure Tools | 31

Page 32: TIBCO ActiveMatrix Adapter for OSIsoft PI · TIBCO Product Documentation This section lists documentation resources you may find useful. The following documents form the TIBCO ActiveMatrix

Recommended