Application Developer s Guide

Transcription

1 TIBCO BusinessEvents Extreme Application Developer s Guide Software Release May 2012 The Power to Predict

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE 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 Software Inc. TIBCO, The Power of Now, TIBCO ActiveMatrix, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO ActiveSpaces, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Runtime Agent, TIBCO Rendezvous, are either registered trademarks or trademarks of TIBCO 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 Sun Microsystems, 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 respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, 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 BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. This product is covered by U.S. Patent No. 7,472,101. Copyright 2012 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Figures xv Tables xvii TIBCO BusinessEvents Resource Reference Tables xix Preface xxi Related Documentation xxii TIBCO BusinessEvents Extreme xxii Other TIBCO Product Documentation xxiv Typographical Conventions xxv Connecting with TIBCO Resources xxviii This section provides links to helpful TIBCO resources xxviii How to Join TIBCOmmunity xxviii How to Access TIBCO Documentation xxviii How to Contact TIBCO Support xxviii Chapter 1 Project Tasks Project Development Overview Creating a Project Finding a Project Element Exporting (Generating) Concept and Event Schema (XSD) Files Validating a Project or Project Resource Working with External Libraries Working with Project Libraries Creating (Exporting) a Project Library Adding (and Removing) Project Libraries in a Project Working with Global Variables Setting and Overriding Global Variables from a Project Library Adding and Managing Global Variables Using Global Variables Overriding Global Variables at Deploy Time Order of Precedence of Global Variable Overrides Storing Trusted Certificates Outside of Your Project

4 iv Building an Enterprise Archive (EAR File) Building an EAR File in TIBCO BusinessEvents Extreme Studio Chapter 2 TIBCO BusinessEvents Extreme Studio Tools Utility Building an Enterprise Archive (EAR File) at the Command Line Working With Project Libraries at the Command Line Generating All Project Class Files at the Command Line Chapter 3 Element Refactoring Operations Renaming, Moving, Deleting, and Copy-Pasting Elements Project Level Actions Renaming, Moving, and Deleting Elements Copy-Pasting an Element Automatic Refactoring Actions and Limitations Refactoring Limitations Refactoring for Move and Rename Operations Refactoring for Delete Operations Chapter 4 Channels and Destinations Overview of Channels and Destinations Types of Channels Selecting a Serializer Deploy-time Configuration Mapping Incoming Messages to Non-default Events Working with Rendezvous Channels Rendezvous Message Header Basic Serializer Serializer For Use with Payloads Avoiding REGISTRATION COLLISION RVCM Advisory Messages Working with Local Channels Event Use Count Using Local Channel Destinations Adding Channels and Destinations Adding a Destination to a Channel Communicating with Other Sources using TCP Example TCP Rule Function to Start a Local TCP Server Example TCP Rule Function to Connect to a Remote TCP Server APIs for TCP Communication Channel Resource Reference Wizard and Configuration Section

5 v Destination Resource Reference Chapter 5 JMS Channels Overview of JMS Channels Selecting a JMS Serializer BytesMessageSerializer TextMessageSerializer Creating Unique JMS DurableSubscriber Name Properties Setting the JMS Message Acknowledgement Mode Using CLIENT_ACKNOWLEDGE Mode with Websphere MQ and Cache-Aside When JMS Messages are Acknowledged Using JMS Header Properties in Incoming and Outgoing Messages Setting Certain Header Properties in Destinations Setting Header Properties Using Header Properties from Incoming JMS Messages Setting JMS Header Properties in Outgoing JMS Messages Using Event Properties How TIBCO BusinessEvents Extreme Sets the JMSReplyTo Header in Outgoing Messages JMS Header Field Names Chapter 6 HTTP and SOAP Channels Overview of HTTP and SOAP Channels SOAP Support Working with HTTP Requests Mapping of HTTP Requests to Events, with the REST serializer Sending Non-ASCII Content to Event Properties Mapping of HTTP Request URI to Destination Configuring TIBCO BusinessEvents Extreme to Receive and Send HTTP Requests HTTP Channel Advanced Configuration Settings Defining Event Properties for Standard HTTP Header Properties Using HTTP Functions to Configure HTTP Request Messages Generating a Self-Signed SSL Certificate (Keystore) Getting POST Data Loading Trusted Certificates Sending an Event Sending an Asynchronous Request (Not Secure) Sending a Secure Asynchronous Request Sending a Secure Synchronous Request Configuring TIBCO BusinessEvents Extreme as a SOAP Server and Client Overview of SOAP Related Resources Mapping of SOAP Request URI to Destination Manually Creating Resources to Work with SOAP Services Creating Resources Using the WSDL Import Utility

6 vi Exporting Resources as a WSDL File Parsing and Building SOAP Messages Working with Incoming SOAP Messages (Event Payloads) Working with Outgoing SOAP Messages (Event Payloads) Understanding the WSDL to Project Resource Mapping Example WSDL Example Project Folder Structure How Project Artifacts are Named Chapter 7 Simple Events Overview of Simple Events Using Inheritance Working with Events in Rules Explicitly Assert Events Created in Rules Specifying Default and Non-Default Destinations Scheduling Simple Events Adding a Simple Event Defining Payloads Using XML Schema Files Java Bindings for Events Property Type to Java Type Mappings Simple Event Reference Wizard and Configuration (Standard Tab) Properties (Standard Tab) Declaration and Expiry Action (Advanced Tab) Payload (Advanced Tab) Simple Event Attributes Reference Chapter 8 Time Events and Scheduler Functions Overview of Time Events Scheduled Time Events Rule Based Time Events Working With Time Events Adding a Time Event Configuring a Rule Based Time Event in a Rule or Rule Function TimeEvent Resource Reference Wizard and Configuration Tab TimeEvent Attributes Reference Rule Based TimeEvent Function Reference

7 vii Chapter 9 Advisory Events Working With Advisory Events Uses of Advisory Events Adding an Advisory Event to a Rule Advisory Event Attributes Reference Chapter 10 Concepts Overview of Concepts Adding Concepts and Concept Relationships Adding a Concept Adding Concept Relationships Defining Keys Using the Key Editor Adding a Key Query Catalog Functions Function Signature Parameters Return Values Java Bindings for Concepts Concept Resource Reference Wizard and Configuration Tab Properties Keys Concept Attributes Reference Chapter 11 Scorecards Understanding and Working With Scorecards Adding a Scorecard Using a Scorecard in Rules Scorecard Resource Reference Chapter 12 Domain Models Overview of Domain Models Domain Model Value Descriptions for User Friendly Presentation Adding a Domain Model Importing and Exporting Domain Models Export To and Import From Excel Associating Domain Models with Properties Validating Data in Domain Models

8 viii Chapter 13 Shared Resources Adding a Shared Resource Enabling the Test Connection Feature HTTP Connection Wizard and Configuration Tab Configure SSL Identity Resource Wizard and Configuration Tab JMS Application Properties Wizard and Configuration Tab JMS Connection Wizard and Configuration Tab Test Connection Button Advanced Tab Configure SSL JNDI Configuration Wizard and Configuration Tab Advanced Section Rendezvous Transport Wizard and Configuration Tab Configure SSL Button Advanced Section Chapter 14 Rules and Rule Functions Overview of Rules and Rule Functions Form-based and Source Rule Editors Rule Components Loading Objects into the Rete Network Adding a Rule Rule Editor Reference Adding a Rule Function Rule Function Resource Reference Using Variables and Functions in the Rule Editor Using Catalog Functions in the Rule Editor Using Global Variables in the Rule Editor Using the Function Argument Mapper Using Priority and Rank to Control Order of Rule Execution Using the Quick Fix Feature in the Rule Editor Tips for Working in the Rule Editor Event Preprocessors

9 ix Configuring an Event Preprocessor Chapter 15 Functions Overview of Catalog Functions Built-in Functions Virtual Rule Functions and VRF Catalog Functions Custom Catalog Function Generation Task Summary Restrictions on Use of Custom Functions Static and Non-Static Functions Return Types Function Catalog Annotations Example Custom Function with Tooltips Chapter 16 Rule Language Grammar Rule Language Basics Whitespace Comments Separators Identifier Naming Requirements Local Variables Literals Escape Sequences Operators Keywords and Other Reserved Words Attributes Working with Concept and Event Properties Accessing a Concept Property Atom Working with Concept Property Arrays Event Property Exception Handling Syntax Examples Flow Control if/else for while Chapter 17 Rule Language Datatypes Concept Properties to XML Datatype Conversions Compatibility of Operators with Types

10 x Correcting Inconsistencies of Type String Operands Arithmetic Expressions Assignment Conversion Function Argument Conversion Chapter 18 Mapping and Transforming Data Overview of Mapping and Transformation Function Section Input Section Mapping and Transforming Data to Function Input Statements, Hints, and Errors Buttons, Menus, and Icons Toolbar and Right-Click Menu on the Input Section Icons for Schema Element Datatypes Qualifier Icons Specifying Constants Date and Datetime Strings in Constants Data Validation Repairing Incorrect Mappings Shortcuts Statement Menu Options Dragging to the Left Cutting and Pasting Automatic Testing (at Runtime) Examples of Mappings Setting an Element Explicitly to Nil Merging Input from Multiple Sources Converting a List Into a Grouped List Merging Two Corresponding Lists Coercions XSLT Statements Attribute Choose Comment Copy Copy-Contents-Of Copy-Of Element For-Each For-Each-Group Generate Comment

11 xi Generate PI If Value-Of Variable Chapter 19 XPath Formula Builder XPath Basics Addressing Schema Elements Evaluation Context Namespaces Search Predicates Testing for Nil Comments The XPath Formula Builder String Representations of Datatypes Date and Time Functions Chapter 20 Cluster Deployment Descriptor (CDD) Cluster Deployment Descriptor Overview Maintaining the CDD File How CDD Settings Apply at Runtime Using Properties at Different Levels Order of Precedence at Runtime Setting Global Variables in the CDD File (for Command Line Startup) Adding a Cluster Deployment Descriptor (CDD) CDD Cluster Tab General Settings Reference Chapter 21 Load Balancer Configuration Understanding Load Balancing Options Basic Load Balancing Content-aware Load Balancing Content-Aware Load Balancer Configuration CDD-Based Configuration Ad-hoc (Peer-to-Peer) Content-aware LB Configuration Router Configuration Receiver Configuration Receiver Member Functions in Catalog Router and Receiver Configuration Using CDD Load Balancer Properties Reference

12 xii Chapter 22 Agent and Processing Unit Configuration Collections, Agent Classes, and Processing Units Collections How Collections and Individual Resources are Used to Configure Agents Log Configurations Configuring Collections of Rules, Rule Functions, and Destinations CDD Collections Tab Input Destination Settings Reference CDD Agent Classes Tab Settings Reference CDD Agent Classes Tab Properties Reference Understanding and Configuring Log Configurations Log File Settings Understanding Log Configuration Levels and Syntax Configuring Log Configurations CDD Collections Tab Log Configurations Settings Reference Configuring Processing Units CDD Processing Units Tab Settings Reference CDD Processing Units Tab JMS Server Connection Properties Chapter 23 TIBCO BusinessEvents Performance Profiler Overview of Profiler Changing the Delimiter Character Turning Profiler On and Off To Turn Profiler On and Off Using Properties To Turn Profiler On and Off Using Functions Profiler Reference Chapter 24 Testing and Debugging Projects Overview of Testing and Debugging Projects Debugging Projects Testing Projects Launch Configurations Test Data The Rule Agenda and Variable Views Viewing and Understanding Results Preparing to Run (Test) or Debug a Project Build an EAR File Create Test Data (as Desired) Configure Java Debug Interface (JDI) Adding and Working with Launch (Debug or Run) Configurations

13 xiii Launch Configurations Reference For Testing and Debugging Creating and Working With Test Data Working with Concept and Event Test Data Working with Rule Data Setting Breakpoints in Rules and Rule Functions Running Debugger Running Tester Asserting Rule Input Data Viewing the Results Understanding Result Data Viewing and Understanding Working Memory Contents Chapter 25 Diagrams Overview of Diagrams Working with Diagrams Configuring Diagram Preferences and Properties Performing Common Tasks Using Diagram Tools Exporting a Diagram to an Image Printing a Diagram Setting Diagram Preferences Project Analyzer and Selected Entity Project Diagrams Advantages of Project Analyzer and Selected Entity Project Diagrams Working with Project Analyzer and Selected Entity Project Diagrams Dependency Diagrams Sequence Diagrams Concept Model Diagrams Event Model Diagrams Diagram Options and Tools Reference Layout Options Chapter 26 TIBCO BusinessEvents Studio Preferences Setting Preferences Preference Sections Decision Table Related Preferences Decision Table Analyzer Preferences Decision Table Appearance Preferences Compare/Merge Preferences Diagram Preferences

14 xiv Tester Preferences Appendix A Handling Null Properties Handling Null Concept Property Values Enabling Use of the Nillable Attribute Enabling Null Property Values to Appear When Serializing Concepts to XML Examples of Nillable Attribute and Null Properties Settings Enabling and Setting Special Treatment of Numeric and Boolean Null Values Setting Runtime Properties for Special Treatment of Null Values Property Reference for Null Property Handling

15 xv Figures Figure 1 Serializer and Deserializer Behavior Figure 2 Rule Form Editor Figure 3 Rule Source Editor Figure 4 Dragging to the left to change a hint to a statement Figure 5 Creating an XPath formula

16 xvi

17 xvii Tables Table 1 General Typographical Conventions xxv Table 2 Syntax Typographical Conventions xxvi Table 3 Global Variable Reference Table 4 Build Enterprise Archive Reference Table 5 TIBCO BusinessEvents Extreme Studio Tools Options for Building an EAR File Table 6 TIBCO BusinessEvents Extreme Studio Tools Options for Working with Project Libraries Table 7 TIBCO BusinessEvents Extreme Studio Tools for Generating Class Files Table 8 Refactoring for Move and Rename Operations Table 9 Which Serializers to Use for JMS Message Types Table 10 Variables for Use with DurableSubscriberName Table 11 JMS Message Acknowledgement Modes Table 12 When JMS Messages are Acknowledged Table 13 JMS Header Field Names Table 14 HTTP Channel Advanced Configuration Settings Table 15 Exporting Project Artifacts as WSDL Table 16 Imported WSDL Project Artifacts Table 17 Mappings Between Property Types and Java Types Table 18 Simple Event Payload Element Parameters Table 19 Attributes Used for Each Type of Advisory Event Table 20 Quick Fix Feature Options Table 21 Tips for Working in the Rule Editor Table 22 Common Arguments for VRF Functions Table 23 Escape Sequences Table 24 Operators in the TIBCO BusinessEvents Extreme Rule Language Table 25 Attributes Table 26 Concept Properties to XML Datatype Conversions Table 27 Operator Matrix Table 28 Input tab toolbar buttons

18 xviii Table 29 Icons for schema items Table 30 Additional icons for hints Table 31 Datatype validation Table 32 XPath Formula Builder Reference Table 33 Formatting characters in date or time strings Table 34 Example date and time format patterns Table 35 CDD Cluster Tab General Settings Table 36 CDD Agent Tab Load Balancer Properties Table 37 CDD Collections Tab Input Destination Settings Table 38 CDD Agent Classes Tab Inference Agent Settings Table 39 CDD Agent Classes Tab Inference Agent and Query Agent Properties Table 40 CDD Collections Tab Log Configurations Settings Table 41 CDD Processing Units Tab Settings Table 42 CDD Processing Units Tab Properties for Reconnecting to a JMS Server Table 43 Profiler Configuration Properties Table 44 Profiler Column Heading Reference Table 45 Types of Diagrams Available for Different Resource Types Table 46 Context Menu Options for Canvas and Objects Table 47 TIBCO BusinessEvents Extreme Diagram Tools Reference Table 48 Global Diagram Preferences Table 49 Specific Diagram Preferences (Alphabetical) Table 50 Reference to Tester Preferences Table 51 Reference to Tester Appearance Preferences Table 52 Properties for Null Property Handling

19 xix TIBCO BusinessEvents Resource Reference Tables Channel Resource Reference Destination Resource Reference Simple Event Reference TimeEvent Resource Reference Concept Resource Reference Scorecard Resource Reference Rule Editor Reference Rule Function Resource Reference

20 xx

21 xxi Preface TIBCO BusinessEvents Extreme is a high-performance event processing platform for applications that monitor, analyze, and respond to parallel event streams in and across the enterprise, making decisions, taking action, and running services in real-time. TIBCO BusinessEvents Extreme delivers dramatic new levels of performance, scalability, and robustness for demanding Complex Event Processing (CEP) and real-time event-driven applications. The platform automatically manages consistency for efficient parallel processing and high vertical scalability, while freeing applications from the complexity of concurrent and distributed programming. A hybrid Rules and Java programming model enables applications to maximize the capabilities of both languages, seamlessly share data and events, and integrate to existing Java assets. Topics Related Documentation, page xxii Related Documentation, page xxii Typographical Conventions, page xxv Connecting with TIBCO Resources, page xxviii

22 xxii Related Documentation This section lists documentation resources you may find useful. TIBCO BusinessEvents Extreme The following diagram shows the main documents in the TIBCO BusinessEvents Extreme documentation set. TIBCO BusinessEvents Extreme Getting Started TIBCO BusinessEvents Extreme Application Architect s Guide TIBCO BusinessEvents Extreme Application Developer s Guide TIBCO BusinessEvents Extreme Installation Java API Reference TIBCO BusinessEvents Extreme Java API Reference TIBCO BusinessEvents Extreme Java Developer s Guide TIBCO BusinessEvents Extreme Administration TIBCO BusinessEvents Extreme Sizing Guide TIBCO BusinessEvents Extreme Tuning Guide Legend PDF HTML TIBCO BusinessEvents Extreme Documentation TIBCO BusinessEvents Studio, the design-time UI, is supported on Windows and Linux. The documentation set for TIBCO BusinessEvents Extreme is as follows.