Universal Call Identifier SPL
The Universal Call Identifier SPL generates or preserves a UCID based on configuration. Once a UCID is generated or preserved, the system adds the value to subsequent egress SIP INVITE and ACK messages within the session. The ESBC only inserts a UCID into methods it does not generate itself. Any methods that the ESBC generates to send to the egress side do not have the UCID. You can also set the SPL to remove unwanted UCID headers to avoid duplicity in egress SIP requests.
Using the Universal Call Identifier SPL, you can identify requests within a particular session by manipulating the following vendor specific UCID headers:
- User-to-User
- Cisco-GUID
- Cisco-GUCID
- Genesys-UUID
The UCID is added as extension data to the session element of the recording’s metadata when using SIPREC.
You must configure one of the following SPL options for it to be enabled:
- UCID-App-ID
- GUID-Node-ID
- GUCID-Node-ID
- GenUUID-App-ID
Each SPL option allows you to set an identifying value, as defined by the vendors. The SPL does not validate any input for the SPL options. It is the responsibility of the Administrator to set the correct value.
You may further modify the action of the SPL by adding replace-ucid or convert-to or both to your SPL options.
Note:
The replace-ucid and convert-to options have no effect unless you also configure UCID-App-ID, GUID-Node-ID, GUCID-Node-ID, or GenUUID-App-ID.UCID-App-ID
The UCID-App-ID SPL option allows the Oracle® Enterprise Session Border Controller (ESBC) to examine ingress SIP requests for the “User-to-User” header. When present, the header is transparently passed through the egress SIP message. If set to replace-ucid or the header is not present, the system generates a new value for “User-to-User”.
You must set the value to a 2-byte hex-ascii value that represents the app ID. All input is truncated to 4 characters. Any characters outside the range of 0-9 and A-F will result in an invalid User-to-User header.
GUCID-Node-ID
The GUCID-Node-ID SPL option allows the Oracle® Enterprise Session Border Controller (ESBC) to examine ingress SIP requests for the Cisco-GUCID header. When present, the header is transparently passed through the egress SIP message. If set to replace-ucid or the header is not present, the system generates a new value for Cisco-GUCID.
You must set the value to a 48-bit node ID in the version 1 UUID defined by RFC 4122. You can enter the value in decimal or hexadecimal notation. The value must be prefixed with 0x when hexadecimal.
GUID-Node-ID
The GUID-Node-ID SPL option allows the Oracle® Enterprise Session Border Controller (ESBC) to examine ingress SIP requests for the Cisco-GUID header. If present, the header is transparently passed through the egress SIP message. The system generates a new value for Cisco-GUID if not present or the SPL option is set to replace-ucid.
You must set the value to a 48-bit node ID in the version 1 GUID defined by RFC 4122. You can enter the value in decimal or hexadecimal notation. The value must be prefixed with 0x when hexadecimal.
GenUUID-App-ID
The GenUUID-App-ID SPL option allows the ESBC to examine ingress SIP requests for the “X-Genesys-CallUUID” header. When present, the header is transparently passed through the egress SIP message.
If you configure the option with the replace-ucid parameter or the header is not present, the system generates a new value for “X-Genesys-CallUUID”. The ESBC replaces the Genesys UUID value only if the incoming message has a X-Genesys- CallUUID header. If the header is not present, the ESBC adds the SIP header with the value equal to the generated/preserved UUID.
The uuid specified is a 33 byte unique string, including the \0 terminating symbol.
convert-to
The convert-to SPL option allows the Oracle® Enterprise Session Border Controller (ESBC) to examine ingress SIP requests for multiple UCID headers. This option has no effect unless appended to another SPL option.
You must set the convert-to SPL option to one of the following values:
- Avaya—Removes all Cisco-GUCID and Cisco-GUID headers from egress SIP requests.
- GUID—Removes all User-to-User and Cisco-GUCID headers from egress SIP requests.
- GUCID—Removes all User-to-User and Cisco-GUID headers from egress SIP requests.
- Genuuid—Remove any Avaya or Cisco UUID header and will add the XGenesys-CallUUID header.
Example SPL Options
The following are examples of the Universal Call Identifier SPL.
Example 1
UCID-App-ID=0023,replace-ucid,convert-to=AvayaThis creates a User-to-User header based on a node ID of 23. Any value on the ingress side is replaced with the newly generated value. Removes all Cisco-GUID and Cisco-GUCID headers from egress messages.
Example 2
GUID-Node-ID=0x124578,convert-to=GuidThis creates a Cisco-GUID header if one does not exist in the ingress request. Removes all User-to-User and Cisco-GUCID headers from egress messages.
Sample Metadata
The following sample shows metadata with new extension data added by the Universal Call Identifier SPL:
<extensiondata xmlns:apkt=http:/acmepacket.com/siprec/extensiondata>
<apkt:ucid>00FA08001900014E3E7D5C;encoding=hex</apkt:ucid>
</extensiondata>
<extensiondata xmlns:apkt=http:/acmepacket.com/siprec/extensiondata>
<apkt:ucid>C0934BE72BF711D6800285D16359919A</apkt:ucid>
</extensiondata>Configuring Universal Call Identifier Options
The SPL options must be configured on the ingress session-agent, realm-config, or sip-interface. If you update the values of the SPL options for the Universal Call Identifier SPL, you must perform a save and activate in order for the new option to take effect.
To configure the SPL options: