Simple Event Reference

Simple Event resources are used to define an object that represents an occurrence, such as sending an invoice, debiting an account, and so on.

You can modify and enrich events before they are asserted into the Rete network. Rule evaluation depends on event values at time of assertion, so they can be changed only before assertion.

Note: If you are working with a project imported from a release earlier than 5.0.0, you might be able to see metadata properties. However, do not use them. Instead, use the settings and properties in the Domain Objects section of the CDD file as needed.

Configuration (Standard Tab)

Field	Global Var?	Description
Name	No	Not shown as a field because it cannot be changed. The name appears in the wizard, and in the title of the event. The name to appear as the label for the resource. Names follow Java variable naming restrictions. Do not use any reserved words. Names must be unique within a folder. See Identifier Naming Requirements.
Description	No	Short description of the resource.
Inherits From	No	This event inherits from the event you select here. Leave blank if you do not want to use inheritance. For convenience, you can open the selected event resource by clicking the underlined label.
Time to Live	Yes	Specify a numerical value and a time unit for time to live for events. Events cannot be modified after they are initially asserted, but they can continue to trigger rules during their time to live. Time units can be specified from the drop-down list available to the right of the Time to Live field. Choose one of: milliseconds, seconds, minutes, hours, and days. The default time unit is seconds. The numerical value is interpreted as follows: One or higher (>0): the event expires after the specified number of units elapse. Zero (0): the event expires after the completion of the first RTC cycle. A negative integer (<0): the event does not expire, and must be explicitly consumed. The value `-1` is generally used to indicate an event that does not expire. See Declaration and Expiry Action (Advanced Tab) .
Default Destination	No	When the destination is not otherwise specified (for example in rules or rule functions), events of this type are sent to the destination you select here. You can send an event to the default destination of its event type using the `Event.sendEvent()` function. For convenience, you can open the selected destination resource by clicking the underlined label.
Retry On Exception	No	When a destination’s event preprocessor fails due to an exception, the behavior of an event instance of this type is determined by this check box setting: When this check box is selected, TIBCO BusinessEvents attempts to reprocess the event instance that failed and retries indefinitely with a delay of five seconds between retries. When the check box is not selected TIBCO BusinessEvents does not attempt to reprocess the event instance that failed.

Properties (Standard Tab)

The Properties section has the following fields. Event properties generally map to incoming or outgoing message properties.

Field Global Var? Description

Name

Field	Global Var?	Description
Name	No	The name to appear as the label for the property. Names follow Java variable naming restrictions. Do not use any reserved words. See Identifier Naming Requirements. Note: In addition to standard naming restrictions, do not begin an event property name with `_ns_` or `_nm_`. These have a special use. Also note that the property name cannot begin with the character `_`. For events used in JMS channels Names beginning with `_jms` or `jms` (case insensitive) are used only for JMS header properties. You can, however, use properties beginning `jms_` (case insensitive) for event properties. JMS Header Field Names shows the list of JMS header properties. Consult the JMS specification for more details.
Type	No	One of: `String`, `Integer`, `Long`, `Double`, `Boolean`, `DateTime` Note: For properties of type Double, all NaN (Not a Number) values are converted to `0.00`.
Domain	No	Click the search button and select the domain model you want to use for this property. See Domain Models for details about adding domain models.

The name to appear as the label for the property. Names follow Java variable naming restrictions. Do not use any reserved words.

See Identifier Naming Requirements.

Note: In addition to standard naming restrictions, do not begin an event property name with _ns_ or _nm_. These have a special use. Also note that the property name cannot begin with the character _.

For events used in JMS channels

Names beginning with _jms or jms (case insensitive) are used only for JMS header properties. You can, however, use properties beginning jms_ (case insensitive) for event properties.

JMS Header Field Names shows the list of JMS header properties. Consult the JMS specification for more details.

Type

One of: String, Integer, Long, Double, Boolean, DateTime

Note:

For properties of type Double, all NaN (Not a Number) values are converted to 0.00.

Domain

Click the search button and select the domain model you want to use for this property.

See Domain Models for details about adding domain models.

Declaration and Expiry Action (Advanced Tab)

If the Time to Live field is zero or higher, define the action or actions to take when an event expires in the Expiry Action section.

If an event is explicitly consumed in a rule, TIBCO BusinessEvents does not execute the expiry action.

The editor in the Expiry Action section is the same as the Rule function editor. See Rule Function Resource Reference for details.

See TIBCO BusinessEvents Architect’s Guide for background details.

Payload (Advanced Tab)

An event can have a payload. The payload often corresponds to a message body. Payloads can be defined using an XML schema. In the left panel you add groups (elements) and parameters (attributes). You can add groups as children of a selected group, or at the same level, to define a hierarchy as desired. In the right panel, you define the type of each element or parameter. The table below describes the payload parameters available for each content type. The content types appear in the drop-down list for the Content field in the Payload section:

Simple Event Payload Element Parameters
Content/Parameter		Description
Complex Element		An element that contains other elements. This is like a structure in a programming language. The complex element can contain zero or more elements of other types, including other complex elements.
	Name	The name of the element.
	Cardinality	Values for Cardinality: Required: The payload must include an instance of this element. Optional (?): The element is not required. Repeating (*): The element is a list that has zero or more instances. At least one (+): The element is a list that has one or more instances.
Element of Type		An element with a specified data type. You can specify a scalar data type (string, integer, and so on), you can reference an XML type, or you can specify the `TIBCO ActiveEnterprise Any` data type.
	Name	The name of the element.
	Cardinality	See Cardinality under Complex Element.
	Type	The generic data type. For example, decimal or date/time.
	Type	The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
XML Element Reference		A reference to an element in a stored XML schema. See TIBCO Designer documentation for more information about XML schemas.
	Cardinality	See Cardinality under Complex Element.
	Schema	Stored XML schema that contains the element or type you want to reference.
	Element	The element within the stored XML schema that you want to reference.
Attribute of Type		An attribute with a specified data type. You can specify a scalar data type (string, integer, and so on), you can reference an XML type, or specify the `TIBCO ActiveEnterprise Any` data type.
	Name	The name of the element.
	Cardinality	See Cardinality under Complex Element.
	Type	The generic data type. For example, decimal or date/time.
	Type	The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
Sequence		A sequence of elements. Each item in the sequence is a structure of the sub-elements of this element.
	Cardinality	See Cardinality under Complex Element.
Choice		A choice of elements. The data type of this element can be one of the sub-elements defined.
	Cardinality	See Cardinality under Complex Element.
All		The data type of this element can be all of the data types of the sub-elements defined.
	Cardinality	See Cardinality under Complex Element.
XML Group Reference		A reference to an XML group in a stored XML schema. See TIBCO Designer documentation for more information about XML schema.
	Cardinality	See Cardinality under Complex Element.
	Schema	Stored XML schema that contains the element or type you want to reference.
	Model Group	Select the appropriate model group from the pull-down list.
Any Element		A reference to any XML Element. You can use the Coercions button to supply a reference to the XML Element for this item when it appears in the input or process data.
	Cardinality	See Cardinality under Complex Element.
	Validation	Select the level of validation to be performed on the XML Element: Strict: Must validate by locating a declaration for the element. Skip: Do not validate. Lax: Validate if a declaration for the element is available.

Subtopics