Event Handling Binds

Business rules can use the event handling binds to access the selected event object. No parameter selection is required for the current object binds since they each use the current batch, queue, or type, respectively. For the Derived Event Type and the Event Queue binds, a parameter is required. Each is described below.

For examples of checking the current event and queuing a derived event via event binds and JavaScript, refer to the Event Bind Examples topic here.

Important: The example scripts should not be used as-is without thorough testing, including updating the script to match object and link types that exist on your system.

Configuration

To use any bind:

1. Create a business rule as defined in the Creating a Business Rule, Function, or Library topic.

2. Edit the business rule as defined in the Editing a Business Rule or Function topic.

3. In the Edit Operation dialog, add the bind to a business rule, as defined in the Adding a Bind topic in the Resource Materials online help documentation.

4. In the Edit Operation dialog, optionally add Messages, as defined in the Localized Messages for JavaScript Business Rules topic.

5. In the Edit Operation dialog, add JavaScript to call the bind.

Current Event Batch

This bind is only available for actions used as an OIEP pre-processor and gives access to the batch of events currently being handled. This makes it possible to examine the events in the batch and to add new objects to the batch.

For example, this JavaScript adds new product / node '(newNode)' to the current event batch.

1
 eventBatch.addAdditionalNode (newNode);   

In this example, Current Event Batch is bound to the variable 'currentEventBatch'. For each event in the batch, the code accesses the object (node) for which the event was generated, checks if it is a product, and if so, adds the parent object to the batch.

1
2
3
4
5
6
7
eventsList = currentEventBatch.getEvents();
for (var i = 0; i < eventsList.size(); i++) {
  var node = eventsList.get(i).getNode();
  if (node instanceof com.stibo.core.domain.Product) {
   currentEventBatch.addAdditionalNode(node.getParent());
  }
}    

Current Event Processor Event Batch

This bind is for use with the Execute Business Action for Event Batch plugin. With this plugin, the configured business action will be executed once per event batch. The event batch can be accessed via the Current Event Processor Event Batch bind that resolves to 'com.stibo.core.domain.eventprocessor.batch.EventBatch.'

The business action referenced from the Execute Business Action for Event Batch plugin has no concept of 'current object.' Therefore, the JavaScript Current Object bind and most non-JavaScript business action plugins cannot be used. Also, business actions referenced from the plugin must be made applicable for all object types.

The following JavaScript example iterates the events in a batch and logs the ID of each associated node:

1
2
3
4
5
6
7
8
9
10
11
// logger bound to Logger
// batch bound to Current Event Processor Event Batch
var it = batch.getEvents().iterator();

while (it.hasNext()) {
var event = it.next();
var node = event.getNode();
    if (node) {
    	logger.info("Handling " + event.getNode().getID());
              }
}

It is not recommended to have long running business actions. The plugin should only be used for cases where it is critical that the business action can work on a batch of events.

Current Event Queue

This bind is available for conditions and actions used as OIEP event filters / event generators. It gives access to the event queue tied to the OIEP and from an action makes it possible to, for example, add derived events to the queue.

For example, this JavaScript queues new product / node '(newNode)' using ‘eventType’, which is bound through Event Type bind (discussed later in this topic).

1
 eventQueue.queuedDerivedEvent (eventType, newNode);   

In this example, Current Event Queue is bound to 'currentEventQueue', Current Object is bound to the variable 'currentObject', and a derived event is bound to the variable 'myEvent' via the Event Type bind. The code queues an event for the parent of current object if current object is a product.

1
2
3
if (currentObject instanceof com.stibo.core.domain.Product) {
    currentEventQueue.queueDerivedEvent(myEvent, currentObject.getParent());
}    

Current Event Triggering Workspace

The Current Event Triggering Workspace bind supplies the TriggeringWorkspace (Main, Approved, or Main and Approved) for current events about to be generated when publishing data, for example, to the Elasticsearch search engine for display on the Web UI faceted Search Screen. For more information, refer to the Search Screen topic in the Web User Interfaces documentation here.

To make it possible to identify which workspace(s) the event in question is generating changes from, the TriggeringWorkspace enum can be found in the Scripting API and Extension API documentation.

1
2
3
4
5
6
7
8
9
@Public
public enum TriggeringWorkspace {
/** Triggering on changes from Main workspace */
	Main,
/** Triggering on changes from Approved workspace */
	Approved,
/** Triggering on changes from both Main and Approved workspace */
	MainAndApproved;
}    

Also, in the API, com.stibo.core.domain.eventqueue.event.Event#getTriggeringWorkspace() identifies which workspace(s) the event in question is generating change.

Important: Selecting the 'Main' option or the 'Main and Approved' option results in processing every event from the maintenance workspace, which can negatively impact performance for the entire system. It is not recommended to use business rules running complex processing for events caused by frequent activities in the maintenance workspace.

For information on modifying the triggering workspace in workbench, refer to the event processor plugin link for the applicable processor on the Processing Plugins topic in the System Setup documentation here.

Current Event Type

This binds the current event type and can be hooked into an endpoint as filters / generators to examine the current event. It is available for conditions and actions used as OIEP event filters / event generators. Use this to examine the type of the current event.

In this example, Current Event Type is bound to 'currentEventType' and the code checks whether the current event is a core 'modify' event.

1
2
3
if (currentEventType.equals(com.stibo.core.domain.eventqueue.BasicEventType.Modify)) {
    // Do something if core modify event
}

Derived Event Type

This bind is available for actions and conditions, (though more typically used in actions), and binds a specified derived event to a JavaScript variable.

The same binds and variables are used in this example as in the one above for Event Queue.

Event Queue

This bind is available for conditions and actions, (though more typically used in actions). Use the bind from an action to queue an event on the selected event queue in STEP.

In this example, a derived event is bound to the variable 'myEvent' via the Event Type bind, an event queue is bound to the variable 'myEventQueue' via the Event Queue bind, and Current Object is bound to 'currentObject'. The example places a 'myEvent' event on the queue for current object.

1
myEventQueue.queueDerivedEvent(myEvent, currentObject);