An Event is an object that initiates and passes data to a Business Process. It is used with a source interface object, such as a Cloud Monitor.
Other activation methods include the SendEventNotification Business Process task, and external APIs and programs, such as the Notification API.
Events often serve as the middle-man to channel data into CIC Studio and ultimately to a Business Process. For example, let’s say that you receive purchase orders in .csv format (flat file) and use CIC Studio to process them to your back-end database. Your source interface object used in this scenario may be a Cloud Monitor; whenever the Monitor detects an incoming message, it launches an Event – we’ll call this EventPO.
EventPO carries with it the payload – the data contained within the message. EventPO passes the payload to a Business Process for processing.
Additional Event parameters can also be passed to a Business Process. For example, an actual file name (as a parameter) may also “come along for the ride” from the Event to a Business Process.
In another example, a database table may contain a trigger that sends an Event notification to the Studio whenever something occurs on your database, such as an insert or delete. The notification launches an Event, which in turn launches a Business Process.
How the Object Works
Events use Event parameters to capture and hold information about the source data, and then transfer that information to Business Process parameters. Minimally, every Event contains the payload. Internally, the payload parameter represents a pointer to an arbitrary Java object. The Java object is stored in the Storage Manager, and is available to be referenced in a Business Process. All Studio interface objects (Monitors and Adapters) use this payload to transport source data into the Studio.
Additional Event Parameters
Events Launched by Exit Points
Events raised by Exit Points contain parameters for the data that is specific to the purpose of the Exit Point. Exit Point processing is included for inbound EDI transactions.
For more information, see Exit Points.
For a list of Exit Point-specific Event parameters, see Exit Point Business Process Parameters.
To use this object, you must:
- Create the object.
- Select an associated Business Process.
- Configure parameters for both the Event and Business Process.
How to define
Defining an Event:
- associates a Business Process
- determines the data to be passed from the Event
- maps specific parameters to Business Process parameters.
The following steps take place in the Event editor, which has these sections: Business Process, Settings, Parameters, and Parameter Mapping.
- Under the Settings section, either select or create the Business Process to launch from this Event. Click on the field to select an available Business Process, or click the Business Process link to open an editor in which you can create one. You can not create an Event without an associated Business Process. Once you select an existing Business Process, note that Parameters and Parameter Mapping sections are automatically populated with required parameters specific to that selected Business Process.
- Under the Parameters section, add Event parameters by clicking the Add button; assign a name and type for each parameter. This determines which parameters are to be passed to the parameters of the selected Business Process. In addition to the payload, other Event parameters may be available; this depends on the type of interface object launching the Event.
- Under the Parameter Mapping section, match the Business Process Parameter with the Event Parameter. Click in the Event Parameters section to set the Event parameter. Business Process parameters will only match with Event parameters of the same type.
- Click Save to complete this task.