Overview

The Nectar DXP Event Handling feature allows users to have more control over which events get forwarded on to their AWS EventBridge instance. This document's purpose is to provide information on how to implement and use the event handling features.

Prerequisites

You will need to ensure you have the following items before proceeding:

• 1x AWS EventBridge instance
• 1x Nectar DXP instance
• A user that has MSP Admin role permissions.
• Some JSON knowledge is also helpful.

Event Management

The Event Handling screen can be accessed by a user that has the role of MSP Admin, otherwise the screens required will not be accessible. To access the Event Management screen you will need to do the following:

1. 1. Click on your username in the top right of the screen
   2. Select the service provider option
      
   3. Select the Event Management tab
       

General vs Tenant

There are 2 ways in which event handling rules can be configured. General, which will apply the defined rules across all service provider tenants, and Tenant, which will allow specific control for individual tenants. It is possible to have configuration for both at the same time, in which case both will compound and apply at the same time. If there is a conflict of rule sets then Tenant rule set will take priority.

In the tenant section you will need to select the tenant and the AWS Eventbridge that you wish to configure the settings for.

Event Exclusion

Event exclusion will allow the user to use JSON to configure which events will NOT be sent over to EventBridge.

Example:

{
  "eventExclusionFilterConfig": [
    {
      "description": "Common filter to ignore based on alert level for all tenants",
      "AND": [
        {
          "field": "alert_conv",
          "values": [
            "0",
            "2",
            "3"
          ],
          "operator": "EQUALS"
        },
 ]
}

Event Delay

The event delay JSON configuration defines conditions based on specific fields in the event payload. These conditions determine when certain events should be delayed before being sent to an external API destination.

Example:

{
  "eventDelayConfig": [
    {
      "description": "Config 1",
      "delayInMinutes": 5,
      "AND": [
        {
          "field": "alert_conv",
          "values": [
            "1"
          ],
          "operator": "EQUALS"
        }
 ]
}

Event Manipulation 

The event manipulation JSON configuration defines settings to modify the value of the fields in the incoming event payload.

Example:

{
  "eventManipulationConfig": [
    {
      "description": "Update it to alert 2",
      "update_field": "alert_conv",
      "value_to_update": "2",
      "AND": [
        {
          "field": "eventid_conv",
          "values": [
            "Sip_Trunk_Rejected"
          ],
          "operator": "EQUALS"
        }
      ]
    }
]
}

Service Windows

Service windows can be configure so that there is a time window in which events will not be sent on to the Eventbridge which is useful when there is planned maintenance and you wish to prevent false alarms. The windows can be configured using JSON to determine when this window occurs as well as which events and/or agents you wish to be included.