Various functions in the Coherence category enable you to work with objects in the cache. Query functions work with content in the cache. Cache load functions load items into the Rete network so they are available.
Tool tips in the user interface (and reproduced in the TIBCO BusinessEvents Functions Reference) explain the details of how to use the functions. This section explains the context of use and highlights certain patterns of use.
C_CacheLoad*() functions are required for working with cache only cache mode. They load entities from the cache (or backing store if not found in the cache) into the Rete network. See
Loading Cache-Only Objects into the Rete Network in
TIBCO BusinessEvents Architect’s Guide for details.
Use the C_CacheLoad*() functions in an event preprocessor. Only use them in rules for cases where the
ID or
ExtId is not known in advance (in the preprocessor).
Never use Instance.getByExtId() unless you have first loaded the concept.
Instance.getByExtId() does not assert the concept but just returns it for use in rules, for example, as read-only reference data.
In the event preprocessor, use the C_Lock() function to prevent other threads or engines from operating on the same entity. The lock is automatically released at the end of the RTC.
Use C_Unlock() only in a preprocessor and only to handle cases where you need to release the lock, for example because some information is missing that would be required to go forward.
See Using Locks to Ensure Data Integrity Within and Across Agents in
TIBCO BusinessEvents Architect’s Guide for details on use of locks.
C_Index() creates an index on the specified property, which is useful when you run queries.
Constants functions wrap constants so they can be used in filter functions. For example if a filter checks for
X = 10, you would first wrap
10 using
C_IntConstant().
The C_RuleFunction() function allows you to specify a rule function containing a custom filter condition.
Query functions take various actions for a specified entity or set of entities. For example,
C_CacheInvoke() allows you to invoke a rule function for all matching entities in the cache.
Tool tips in the user interface (and reproduced in the TIBCO BusinessEvents Functions Reference) explain how to use the functions singly or in combination to achieve the desired results.
The C_CacheOnlyMode*() functions are for use with entities that use cache-only cache mode.