Custom Header Searching and Correlation

This article describes the process and steps required to extract custom SIP X-headers for search and correlation purposes.

1. Add Custom Header in heplify-server

X-Headers are extracted at the capture layer by heplify-server and converted to HEP header fields.

Correlation Only Headers which do not require search should be "normalized" to correlation_id headers using AlegIDs
Search + Correlation Headers which require full indexing should be extracted using CustomHeader

Edit /etc/heplify-server.toml

add custom header information

AlegIDs               = ["XCallID"] # Custom Header(s) will be used as Correlation ID (first match)
ForceALegID           = true
CustomHeader          = ["X-CID","XCallID"] # Custom Headers will be Indexed for Header search

if you are running a docker container, add custom headers by setting an environment variable

"HEPLIFYSERVER_CUSTOMHEADER=X-CID,XCallID"

restart heplify-server

systemctl restart heplify-server.service

2. Add Mappings in homer-app

Go to settings in homer UI and click on mappings, Edit profile 'call' with HEP ID '1'.

Add the following at end of Field Mapping

.
.
.
    },
    {
        "id": "data_header.X-CID",
        "name": "X-CID",
        "type": "string",
        "index": "none",
        "form_type": "input",
        "position": 25,
        "skip": false,
        "hide": true
    },
    {
        "id": "data_header.XCallID",
        "name": "XCallID",
        "type": "string",
        "index": "none",
        "form_type": "input",
        "position": 26,
        "skip": false,
        "hide": true
    }
]

Like this