OpenAjax Event Subscription Overview |
DEVELOPER |
 |
OpenAjax Event Subscription Overview
PROIV can subscribe to OpenAjax events whereby PROIV Functions can receive events published by the OpenAjax Hub, accept data from the event and run logic to process the data. This functionality is supported via Screen functions and only when connected using the Open Client.
Basic Run-Time Behaviour
When an OpenAjax Event Subscription (OAES) is stored against a Function Header, the function is in effect subscribing to that event. This means that when the OpenAjax Hub publishes an event and the function is running, the Open Client sends it to the function and the following steps occur:
-
Assignment of the data from the OAES.
-
The associated action (Local Logic, Global Logic or Function Key) is called. The data assigned from the OAES is made available and if the data sent is too long for the defined lengths, it is truncated silently.
Click here for more information about the run-time behaviour, including unsubscribe and re-subscribe, changing cycles, event queuing and error handling.
Data Mappings
You can configure data mapping which assigns values from the OAES to PROIV Scratch or File Variables. The mapping is one way and always OAES -> PROIV. Arrays are supported but all of the elements must be alphanumeric. Maps cannot be referenced in logic etc., therefore they are not named. In addition, all parts of the mapping must be manually entered as there is not a parameter list to validate and control the map.
Section links:
Run-Time Behaviour provides an overview of the OpenAjax Event Subscription run-time behaviour.
Adding an OAES to a Function Header explains how to add Even Subscriptions to a function header.
Adding OAES Actions explains how to configure the PROIV Action associated with an OAES.
Assign OAES Properties explains how to assign Event Subscription properties.
Creating OAES Data Mappings explains how to set up the Event Subscription data mappings.
Topic ID: 500610