Events

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 File Monitor, Database Monitor, Email Receive Monitor, or Message Filter.

Other activation methods include the SendEventNotification Business Process task, and external APIs and programs, such as the Clarify Notification API.

Business Use

Events often serve as the middle-man to channel data into Clarify and ultimately to a Business Process. For example, let’s say that you receive purchase orders in .csv format (flat file) and use Clarify to process them to your back-end database. Your source interface object used in this scenario may be a File Monitor; whenever the File Monitor detects an incoming .csv file, it launches an Event – we’ll call this EventPO.

EventPO carries with it the payload – the data contained within the .csv file. EventPO passes the payload to a Business Process for processing.

Additional Event parameters can also be passed to a Business Process. For example, the 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 Clarify 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 Clarify interface objects (File, Database, and Email Monitors, Message Filters, and Adapters) use this payload to transport source data into Clarify.

Additional Event Parameters

In addition to the payload, other Event parameters may be available; this depends on the type of interface object launching the Event. For example, an Event launched by a File Monitor contains these parameters:
  • filename
  • directory
An Event launched by a Message Filter or Email Receive Monitor, however, only contains the payload parameter.

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. Clarify includes Exit Point processing 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.

Process Summary

To use this object, you must:

  • Create the object.
  • Select an associated Business Process.
  • Configure parameters for both the Event and Business Process.