Simple Events : Simple Event Reference

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.
If you are working with a project imported from a release earlier than 5.0.0, you may 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. See TIBCO BusinessEvents Administration for details.
Wizard and Configuration (Standard Tab)
The Wizard and the Configuration section have the following fields.
Not shown as a field because it can’t 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 Identifiers (Names).
This event inherits from the event you select here. Leave blank if you don’t want to use inheritance. As a convenience, you can open the selected event resource by clicking the underlined label.
Specify a numerical value and a time unit. Time units available are milliseconds, seconds, minutes, hours, and days. (Default unit is seconds.)
Specify the time units in the drop-down list field to the right of the Time to Live field. Choose one of: Seconds, Minutes, Hours, Days, WeekDays, Weeks, Months, Years
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.
Default Destination
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. As a convenience, you can open the selected destination resource by clicking the underlined label.
Retry On Exception
When a destination’s event preprocessor fails due to an exception, the behavior an event instance of this type is determined by this check box setting:
When this checkbox is checked TIBCO BusinessEvents attempts to reprocess the event instance that failed.
When the checkbox is unchecked TIBCO BusinessEvents does not attempt to reprocess the event instance that failed.
See Event Preprocessors for more information.
Properties (Standard Tab)
The Properties section has the following fields. Event properties generally map to incoming or outgoing message properties.
The name to appear as the label for the property. Names follow Java variable naming restrictions. Do not use any reserved words. See Identifiers (Names).
Note: In addition to standard naming restrictions, do not begin an event property name with _ns_ or _nm_. These have a special use. See Mapping Incoming Messages to Non-default Events.
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.
See Using JMS Header Properties in Incoming and Outgoing Messages for more details. Table 19, JMS Header Field Names shows the list of JMS header properties. Consult the JMS specification for more details.
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.
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 Simple Events — Time to Live and Expiry Actions in 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:
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.
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.
The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
A reference to an element in a stored XML schema. See TIBCO Designer documentation for more information about XML schemas.
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.
The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
A reference to an XML group in a stored XML schema. See TIBCO Designer documentation for more information about XML schema.
Model Group
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.