ODC Push-Based Integration - Mapping IP and Metric Unit Attributes
search cancel

ODC Push-Based Integration - Mapping IP and Metric Unit Attributes

book

Article ID: 445528

calendar_today

Updated On:

Products

DX SaaS

Issue/Introduction

When integrating ODC (Operational Data Content) push-based integration with DX SaaS, custom parameters such as IP Address and Metric Unit may not appear in the alarm attributes even if the payload is ingested successfully and alarm mapping is configured correctly.

Cause

The standard mapping schema may not automatically map these specific custom parameters to the visible alarm attributes. Custom attributes must be explicitly defined within the additionalAlarmAttributes section of the mapping schema.

Resolution

To ensure ip, units, and other custom parameters are correctly displayed, update your ODC mapping schema to use the additionalAlarmAttributes section.

Updated Mapping Schema Example

Below is a sample schema configuration that maps internal variables (like ip and units) to custom fields (custom_1 through custom_6) which are visible in DX SaaS:

JSON:

{
    "alarms": [result.
        {
            "severity": severity,
            "status": severity = "information" ? "CLOSED" : "NEW",
            "alarmType": "Script",
            "product": "PRODV4",
            "alarmMessage": message,
            "messageDetails": message,
            "host": host,
            "alarmUrl": "<URL>/display/KB/" & alertcode,
            "entityId": host,
            "monitoringType": "HOST", 
            "alarmUniqueId": alertid,
            "created": timestamp,
            "additionalAlarmAttributes": {
                "custom_1": units,
                "custom_2": "IntCounter",
                "custom_3": "INTEGER",
                "custom_4": alertid,
                "custom_5": alertcode,
                "custom_6": ip
            }
        }
    ],
    "entities": [result.
    {
      "entityId":  host,
      "entityType": "HOST",
      "entityName": host,
      "hostName": host,
      "ipAddresses": [
          {
            "ip": ip
          }
       ],
      "additionalAttributes": {
        "units": units
      }
    }
    ]
}

 

Validation:

  1. Apply the updated mapping file in your ODC integration settings.
  2. Send a test alarm payload.
  3. Verify that the IP address and units are now visible in both the Alarm Attributes and Inventory Items sections.