Adaptation Details field descriptions

Last Updated : Aug 02, 2023 |

General section

Name

Description

Adaptation name

Name of the adaptation. The adaptation name must be unique and from 3 through 64 characters in length.

Module Name

Name of the adaptation module. The options are:

  • AMSAdapter

  • AttAdapter

  • CiscoAdapter

  • CiscoEndpointAdapter

  • CS1000Adapter

  • DigitConversionAdapter

  • DiversionTypeAdapter

  • DomainAdapter

  • ModularMessagingAdapter

  • NortelAdapter

  • OrangeAdapter

  • PolycomEndpointAdapter

  • RegExpAdapter

  • RoutingHeadersAdapter

  • SeltaEndpointAdapter

  • StirShakenAdapter

  • VerizonAdapter

Type

Type of adaptation. The value is displayed based on the selected adaptation module name. The options are:

  • digit

  • device

State

The state of the adaptation. The options are:

  • Enabled

  • Disabled

  • test-only

Module Parameter Type

The module parameter can be one of the following types:

  • No parameter.

  • Single Parameter. The Module Parameter must not contain any white spaces.

  • Name-Value Parameter. Selecting this option displays a table for you to add or remove multiple lines of Name-Value pairs.

Note:
  1. A module parameter name must not contain any white space.

  2. Enclose the value in double quotation marks if the value contains the space character. Within the value field, you can include a double quotation mark by using \” .

Supported adaptation module parameters are:

  • fromto If set to true, the adaptation modifies From and To headers of the message. If omitted or set to any other value, From and To headers are not modified.

  • multipartMIMEsupported (MIME) (Optional) This adaptation applies to the egress processing only. If the parameter is present and set to no, then multipart MIME message bodies will be stripped on egress from Session Manager. If the multipart MIME message contained an SDP message body, it will be inserted as the only message body in the outgoing message. If omitted or set to any other value, message bodies will not be modified.

EGRESS Domain Modification Parameters

  • overrideDestinationDomain ( can be abbreviated to odstd): {parameter #1 if not named}, replaces the domain in Request-URI, To header (if administered), Refer-To header, and Notify/message-summary body with the given value for egress only.

  • overrideSourceDomain ( can be abbreviated to osrcd): replaces the domain in the From header (if administered), P-Asserted-Identity header and calling part of the History-Info header with the given value for egress only.

INGRESS Domain Modification Parameters:

  • ingressOverrideDestinationDomain ( can be abbreviated to iodstd): replaces the domain in Request-URI, To header (if administered), and Notify/message-summary body with the given value for ingress only.

  • ingressOverrideSourceDomain ( can be abbreviated to iosrcd): replaces the domain in the From header (if administered), P-Asserted-Identity header and calling part of the History-Info header with the given value for ingress only.

Egress URI Parameters

The terminating trunk group parameters.

URI parameters can be added to the Request-URI. For example, the parameter “user=phone” can be appended for all INVITEs routing to a particular SIP entity. The egress Request-URI parameters are administered from the Adaptation Details using the Egress URI Parameters field.

The field's format is the string that should be appended to the Request URI. The string must conform to the augmented BNF defined for the SIP Request URI in RFC3261. A leading ';' is optional. Entry “;user=phone;custApp=1” is equivalent to “user=phone;custApp=1”.

Notes

Optional information that you wish to add.

Digit Conversion for Incoming Calls to SM

Button

Description

Add

Adds digit conversion for incoming calls for the adaptations.

Remove

Removes digit conversion from incoming calls for the adaptations.

Name

Description

Select check box

Use this check box to select and use the digit conversion for the incoming calls

Matching Pattern

Pattern to match for the incoming calls. The pattern can have between 1 and 36 characters. Roll over the field for the valid pattern.

Min

Minimum number of digits to be matched. The minimum value can be 1 or more.

Max

Maximum number of digits to be matched. The maximum value can be any number up to 36.

Phone Context

Optional parameter for the ingress adaptation rules.

If the phone-context field of an ingress adaptation module rule contains a valid value (not empty), ingress adaptation is applied only if all four trigger fields (Matching Pattern, Min, Max, and Phone-context) match the header. If the phone-context field is empty, ingress adaptation is applied based on the remaining fields (Matching Pattern, Min, and Max). The allowed format for the Phone Context string can either be an E.164 number (which can contain optional hyphens, periods, or parenthesis) or a domain name (which can contain only alphanumeric characters, a hyphen, and periods).

Delete Digits

Number of digits to be deleted from the dialed number.

Insert Digits

Number of digits to be added before the dialed number.

Address to Modify

A setting of both will look for adaptations on both origination and destination type headers. The digit conversion applied to a header will be taken from the entry with the longest matching pattern.

Adaptation Data

Any additional or special adaptation data up to 20 characters. Valid values: numeric characters 0-9, +, *, #, and -.

This is a non-mandatory field.

Notes

Any other details that you want to add.

Digit Conversion for Outgoing Calls from SM

Button

Description

Add

Adds digit conversion for outgoing calls for the adaptations.

Remove

Removes digit conversion from outgoing calls for the adaptations.

Name

Description

Select check box

Use this check box to select and use the digit conversion for the outgoing calls.

Matching Pattern

Pattern to match for the outgoing calls. The pattern can have between 1 and 36 characters. Roll over the field for the valid pattern.

Min

Minimum number of digits to be matched. The minimum value can be 1 or more.

Max

Maximum number of digits to be matched. The maximum value can be any number up to 36.

Phone Context

Optional parameter in the action fields for the egress adaptation rules.

If the phone-context field of an egress adaptation module rule contains a valid value (not empty), the adaptation module modifies the digits and insert phone-context when the three trigger fields match the criteria, that is, Matching Pattern, Min, and Max. On the other hand, if the phone-context field is empty, the egress adaptation module does not insert phone-context.

Delete Digits

Number of digits to be deleted from the dialed number.

Insert Digits

Number of digits to be added before the dialed number.

Address to Modify

A setting of both will look for adaptations on both origination and destination type headers. The digit conversion applied to a header will be taken from the entry with the longest matching pattern.

Adaptation Data

Any additional or special adaptation data up can be up to 20 characters. Valid values: numeric characters 0-9, +, *, #, and -.

This is a non-mandatory field.

Note:

In case of the Verizon Unscreened ANI feature, the data entered in the outgoing Adaptation Data field is verified to ensure that it complies with the required format of a Screened Telephone Number (STN).

Notes

Any other details that you want to add.

Button

Description

Commit

Saves the adaptation details and distributes them to Session Manager instances in the enterprise.

Cancel

Cancels changes to the adaptation details and returns to the Adaptations page.