diff options
Diffstat (limited to 'docs/apex')
| -rw-r--r-- | docs/apex/APEX-User-Manual.rst | 49 |
1 files changed, 46 insertions, 3 deletions
diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst index f6a5d23a..d32b1de9 100644 --- a/docs/apex/APEX-User-Manual.rst +++ b/docs/apex/APEX-User-Manual.rst @@ -1781,6 +1781,52 @@ Input and Output Interfaces | **18** | any other output configuration (e.g. event name filter, see below) | +--------+--------------------------------------------------------------------+ +Event Name +########## + + .. container:: paragraph + + Any event defined in APEX has to be unique. The "name" of + of an event is used as an identifier for an ApexEvent. Every + event has to be tagged to an eventName. This can be done in different + ways. Either the actual event can have a field called "name". Or, the + event has some other field that can act as the identifier, which can be + specified using "nameAlias". But in other cases, where a "name" or "nameAlias" + cannot be specified, the incoming event coming over an endpoint can be + manually tagged to an "eventName" before consuming it. + + .. container:: paragraph + + The "eventName" can have a single event's name if the event coming + over the endpoint has to be always mapped to the specified eventName's + definition. Otherwise, if different events can come over the endpoint, + then "eventName" field can consist of multiple event names separated by + "|" symbol. In this case, based on the received event's structure, it is + mapped to any one of the event name specified in the "eventName" field. + + .. container:: paragraph + + The following code shows some examples on how to specify the eventName field: + + .. container:: listingblock + + .. container:: content + + .. code:: + + "eventInputParameters": { + "Input1": { + "carrierTechnologyParameters" : {...}, + "eventProtocolParameters":{...}, + "eventName" : "VesEvent" (1) + }, + "Input2": { + "carrierTechnologyParameters" : {...}, + "eventProtocolParameters":{...}, + "eventName" : "AAISuccessResponseEvent|AAIFailureResponseEvent" (2) + } + } + Event Filters ############# @@ -5777,6 +5823,3 @@ Send Events .. container:: :name: footer-text - - - |