RAISEEVENT Function

Raises the specified event; pass an arbitrary number of key value pairs for event data. The event is raised to the process flow level where it can be selected by an event node at that level.

Category: Node
Returned data type: Boolean

Syntax

RAISEEVENT(event_name <, key1, value1, key2, value2, ...> )

Required Argument

event_name

specifies a string that indicates the name of the event to be raised

Optional Argument

key1, value1 , key2, value2, ...

specifies one or more key-value pairs that indicates event data

Details

The RAISEEVENT function raises an event. The first parameter is the name of the event to raise. There is another process job node to catch the event. In that node, you can specify the name of the event to catch. Subsequent parameters are event data in the form of key-value. The keys and values are arbitrary, but they must come in pairs. For example, you might have the function with three parameters (name, key, value) or five parameters (name, key, value, key, value) and so on.

If the function completes successfully, it returns TRUE. Otherwise, it returns FALSE.

Example

//!event INFO_MISSING

raiseevent("INFO_MISSING", "FILE", "OK", "FIELDS", "NO DATE")