Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# 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 standard functions catalog contains the most used functions. The standard function catalog includes the following categories:

Channel
These functions return information about destinations, and can resume and suspend a destination.
Cluster
Cluster functions help with multi-engine functionality.
DataGrid
These functions are for use with Cache object management. See Cache Related Functions.
Collections
Collections functions allow you to deal with various collections structures. The functions names are:

- Comparator
- Iterator
- List
- Map
- Set
- SortedMap
- SortedSet

Date
Date functions allow you to compare two DateTime values using only the date portion of the value.
DateTime
DateTime functions allow you to perform the date/time-related tasks and more: add units of time to DateTime, compare, retrieve, and format dates and times.
Engine
Engine functions allow you to retrieve information about the engine, for example, available memory or the number of rules fired. The functions names are:

- Locale
- Profiler
- Rtc
- Variable

Event
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.
Exception
Exception functions enable you to create exceptions.
File
File functions provide various useful functions used when working with files.
HTTP
HTTP functions are used with the HTTP channel. The Functions that belong to this group are named

- Servlet functions

Instance
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. The functions belonging to this group are named:

- PropertyArray
- PropertyAtom
- Reflection
- StateMachine

JSON
JSON functions are used to parse JSON content and perform various operations on JSON node.
Log
Log functions allow you to write statements in logs.
Math
Math functions allow you to perform advanced mathematical operations.
Metric Function
Creates a new Metric instance based on the data provided in the XSLT Mapper and adds it to the working memory. Adding the instance to the working memory causes any rule conditions that depend on the concept to be evaluated.
Number
Number functions allow you to perform type conversions from and to numbers and return the maximum and minimum values for a numeric type.
SOAP
SOAP functions enable you to work with SOAP messages sent through an HTTP channel.
String
String functions allow you to perform comparisons, searches, conversions, and other operations with strings.
System
System functions allow you to send messages to a debug log, retrieve global variables, retrieve system properties, and write data to a file. The functions that belong to this group are named:

- ID functions
- IO functions, which allow the writing and closing of specific files.

Temporal
Temporal functions allow you to examine and perform calculations on values stored in a property’s history. For information about using temporal functions. The functions that belong to this group are named:

- Calculus
- History
- Numeric
- Statistic

Util
Util functions category has one sub-category for working with HashMaps.
VRF
VRF functions (that is, Virtual Rule Function functions) allow you to work with decision tables. See TIBCO BusinessEvents® Decision Manager User Guide for details.
XPath
XPath functions allow you to evaluate XPath expressions.

## Legacy ActiveSpaces Functions

These functions allow you to interact with Legacy ActiveSpaces metaspaces. They are used with the Legacy ActiveSpaces channels to perform operations on the Legacy ActiveSpaces metaspace and spaces connected by the channel.

## 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:

- Receiver functions, which allow you to create or discard a receiver, and retrieve the receiver’s membership details.
- Router functions, which allow you to create or discard a router, and send an event to a remote receiver.

## CEP Pattern Functions

Pattern functions are used with the pattern matcher language for identifying patterns in events. See TIBCO BusinessEvents® Event Stream Processing Pattern Matcher Developer Guide 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 Query Developer Guide for details.

## CEP Store Functions

You can use the CEP Store catalog functions to interact with TIBCO ActiveSpaces data store and external Apache Ignite cache.

The basic CEP store functions are as follows:

- `connect` or `disconnect` to data store
- `open` or `close` a container
- `update`, `put`, `get`, `delete`, or `query` items from the container
- `putAll`, `getAll`, and `deleteAll` to work on items from all containers
- `closeQuery` to exit a query explicitly

Apart from the basic functions, other functions are grouped into the following categories:

- Metadata - Functions to get details of store, container, and fields.
- ConnectionInfo - Functions to set up connection details for data store and cache with a provision to write customized configuration functions.
- Container - Functions to set up connection details for data store and create, configure and interact with external cache such as Apache Ignite.
  The container functions `lock` and `unlock` are supported only for Apache Ignite cache.
- Item - Functions to set or get data from store items.
- QueryOptions - Functions to cover prefetch size, snapshot consistencies, reuse for ActiveSpaces store type and functions to cover execution of query on local node, colocated query, query timeout for external Apache Ignite.
- Transactions - Functions to enable or disable the transactional behavior. Additionally, if the transactional behavior is enabled, commit or rollback transaction.
- Util - Functions to check client version, edit log configurations, and set up a custom logger.

For more information on these catalog functions, see TIBCO BusinessEvents > CEP Store > Store in TIBCO BusinessEvents Functions Reference.

Note: Depending on the table creation in Apache Ignite you must use the specific catalog functions to load and update the rows in the external Ignite table:

- If external table is created by using an SQL statement (JDBC tool) then use the catalog function `Store.executeUpdate()` to insert or update rows with an SQL statement.

- If the table is created by using the catalog function `Store.Container.Ignite.createContainer()` then create or update the table data with catalog function `Store.put()`.

## Hawk Functions

Functions to interact with Hawk micro-agents methods.

## DBMS 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 WebStudio, for authentication.

## Studio Functions

These functions allow you to use the Studio Util functions to build classes and EAR files.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.