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


Chapter 18 Functions : Overview of Catalog Functions

Overview of Catalog Functions
The functions registry includes various catalogs of functions provided with the product, and each catalog organizes its functions into categories. You can use functions in rule conditions and actions and in rule function bodies.
Some functions work together. For example, the Standard catalog function String.append requires that you first use the function String.createBuffer, to create a buffer to which strings can be appended.
To View the Catalog functions
All catalogs appear in the Catalog Functions view. To open the view navigate to Window > Show View > Other > TIBCO BusinessEvents and select Catalog Functions. The catalog view appears on the right, by default.
To View Documentation for Functions
Documentation for functions is provided in tooltips you can access while using the Catalog Functions view. Hover the mouse over the function name to see the tooltips.
You can also access this documentation using the online functions reference, available in the HTML and Eclipse versions of the documentation, but not in PDF. To access the HTML version of documentation, open this page:
BE_HOME/doc/standard/html/index.htm
Expand the contents panel to Online References > Online References, and on the right select the TIBCO BusinessEvents Functions Reference link.
Built-in Functions
For all the built-in functions, this section lists the main categories in each function catalog (but not sub-categories). See TIBCO BusinessEvents Functions Reference for full details.
Standard Functions
The most generally useful catalog, the standard function catalog include the following categories:
Channel functions return information about destinations, and can resume and suspend a destination.
Cluster functions help with multi-engine functionality
DataGrid functions are for use with Cache object management. See Cache Related Functions.
Collection functions allow you to
Date functions allow you to compare two DateTime values using only the date portion of the value.
DateTime functions allow you to perform these date/time related tasks and more: add units of time to a DateTime, compare, retrieve, and format dates and times.
Engine functions allow you to retrieve information about the engine, for example, available memory or the number of rules fired.
Event functions allow you to assert, create, and send simple events and perform other event-related tasks, for example, return the default destination URI of a simple event.
The Exception function enables you to create an exception.
File functions provide various useful functions used when working with files.
HTTP functions are used with the HTTP channel
Instance functions allow you to create and delete concept instances and perform other instance-related tasks, for example, return an instance given an internal ID.
Log functions allow you to
Math functions allow you to perform advanced mathematical operations.
Number functions allow you to perform type conversions from and to numbers and return the maximum and minimum values for a numeric type.
SOAP functions enable you to work with SOAP messages sent through an HTTP channel.
String functions allow you to perform comparisons, searches, conversions, and other operations with strings.
System functions allow you to send messages to a debug log, retrieve global variables, retrieve system properties, and write data to a file.
IO functions allow the writing and closing of specific files.
Temporal functions allow you to examine and perform calculations on values stored in a property’s history. For information about using temporal functions, see Temporal Functions and Their Parameters.
Util functions category has one sub-category for working with HashMaps.
VRF functions (that is, Virtual Rule Function functions) allow you to work with decision tables. See Virtual Rule Functions and VRF Catalog Functions and see TIBCO BusinessEvents Decision Manager User’s Guide for details.
XPath functions allow you to evaluate XPath expressions.
ActiveSpaces
ActiveSpaces functions are used with the ActiveSpaces channels to perform operations on the ActiveSpaces metaspace and spaces connected by the channel.
BPMN
Process Orchestration functions are used with the . See TIBCO BusinessEvents Process Orchestration documentation for details.
BusinessWorks
BusinessWorks functions are used in ActiveMatrix BusinessWorks integration projects. See Chapter 38, ActiveMatrix BusinessWorks Integration.
CEP Load Balancer Functions
Load balancer functions are used to configure and work with the load balancer. There are two types of load balancer functions:
CEP Pattern Functions
Pattern functions are used with the pattern matcher language for identifying patterns in events. See TIBCO BusinessEvents Event Stream Processing add-on documentation for details.
CEP Query Functions
Query functions are used with the query language for querying data in the cache. See TIBCO BusinessEvents Event Stream Processing add-on documentation for details.
Communication Functions
Communication functions provide a set of catalog functions that enables TCP communication. You can create a local TCP server and a TCP client so that TIBCO BusinessEvents can communicate with data sources not otherwise available through channels, using TCP. See Communicating with Other Sources using TCP for details.
Hawk Functions
Metric Functions
RDBMS Functions
Database functions are provided for working with database concepts. See TIBCO BusinessEvents Data Modeling for more on database concepts.
Security Functions
These functions are used internally by the TIBCO BusinessEvents Decision Manager add on, for authentication.
Studio Functions
These functions allow you to use the Studio Util functions to build classes and EAR files.
Custom Functions
You can also create custom functions. Custom functions appear in the Custom Function catalog. For information about custom functions, see Adding Custom Functions.
Ontology Functions
Ontology functions are generated by TIBCO BusinessEvents based on the concepts, events, and rules in your project. There are three types of ontology functions:
The Ontology Functions area uses the same folder structure as the project (or rather, a subset of that structure).
Various ontology functions appear depending on the project and the add-on products installed:
Enabling Extended Functions
Extended functions (sometimes called hidden functions) may be made available by TIBCO Support to address customer-specific use cases. They are also sometimes used to make legacy features available to customer who wish to continue using them. To make them visible in the Catalog Functions view, do the following:
1.
   BE_HOME/studio/eclipse/configuration/studio.tra
2.
   TIBCO.BE.function.catalog.function-catalog-name=true
   TIBCO.CEP.modules.function.catalog.function-catalog-name=true
3.

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