Creating adaptations

Last Updated : Jul 10, 2023 |

About this task

You can add URI parameters to the Request-URI. For example, you can append the parameter user=phone for all INVITEs routing to a particular SIP entity. You administer the egress Request-URI parameters on the Adaptation Details page in the Egress URI Parameters field.

The format is the string that you need to append to the Request URI. The string must conform to the augmented BNF defined for the SIP Request URI in RFC3261. A leading ';' is optional. The entry ;user=phone;custApp=1 is equivalent to user=phone;custApp=1.

Procedure

  1. On the home page of System Manager web console, click Elements > Routing > Adaptations > Adaptations.
  2. Click New.
  3. In the Adaptation Name field, type a descriptive name for the adaptation.
  4. In the Module Name field, select an adaptation module.

    To create an adaptation of type device, select one of the following:

    • SeltaEndpointAdapter

    • CiscoEndpointAdapter

    • PolycomEndpointAdapter

    Session Manager Release 10.2 and later support the StirShakenAdapter adaptation module.

    If you select StirShakenAdapter and older Session Manager version (earlier than Release 10.2) is deployed, Session Manager displays the following warning message:

    Session Manager prior to Release 10.2 does not support the StirShakenAdapter

  5. In the Module Parameter Type field, click the parameter type from the drop-down menu.

    • If the Module Parameter Type is Single Parameter, enter the appropriate value in the Module Parameter field.

    • If the Module Parameter Type is Name-Value Parameter:

    1. Click Add.
    2. In the Name field, enter a module parameter name that does not contain white space.
    3. In the Value field, enter the module parameter value.
  6. In the Egress URI Parameters field, enter a name for URI parameters to append to the Request-URI on outgoing calls.
  7. In the Notes field, enter a description about the adaptation module.
  8. Ingress adaptation provides digit manipulation for calls coming into the Session Manager instance. To configure ingress digit conversion:
    1. Click Add in the Digit Conversion for Incoming Calls to SM section.
    2. Enter the Matching Pattern.

      Hover the mouse pointer over the input field to view a tool tip describing the valid input. From release 8.1.1, you can enter Matching Pattern ranges in the following format:

      [start of range]:[end of range]. For example, 600000:600009.

    3. In the Min and Max fields enter the number of minimum and maximum digits to be matched.
    4. Optional In the Phone Context field add an optional parameter for the ingress adaptation rules.
    5. In the Delete Digits field, enter the number of digits that you want to delete from the left side of the dialed number.
    6. In the Insert Digits field, enter the digits that you want to insert before the dialed number.
    7. In the Address to modify field, click a value from the drop-down menu.
    8. In the Adaptation Data field add any additional or special adaptation information.

      You can add up to 20 characters, including alpha characters a-z, numeric characters 0-9, and special characters +, *, #, and -.

    9. Click Add repeatedly until you have configured all the required ingress matching patterns.
  9. To remove a matching pattern for ingress adaptations, select the check box next to the pattern and click Remove.
  10. Egress adaptation provides digit manipulation for calls going out of the Session Manager instance. To configure egress digit conversion:
    1. Click Add in the Digit Conversion for Incoming Calls to SM section.
    2. Enter the Matching Pattern.

      Hover the mouse pointer over the input field to view a tool tip describing the valid input. From release 8.1.1, you can enter Matching Pattern ranges in the following format:

      [start of range]:[end of range]. For example, 600000:600009.

    3. In the Min and Max fields enter the number of minimum and maximum digits to be matched.
    4. Optional In the Phone Context field add an optional parameter for the egress adaptation rules.
    5. In the Delete Digits field, enter the number of digits that you want to delete from the left side of the dialed number.
    6. In the Insert Digits field, enter the digits that you want to insert before the dialed number.
    7. In the Address to modify field, click a value from the drop-down menu.
    8. In the Adaptation Data field add any additional or special adaptation information.
      Note:

      In the case of the Verizon Unscreened ANI feature, Session Manager verifies the data you enter in the outgoing Adaptation Data field to ensure that the data complies with the required format of a Screened Telephone Number (STN).

    9. Click the Add button repeatedly until you have configured all the required egress matching patterns.
  11. To remove a matching pattern for egress adaptations, select the check box next to that pattern and click Remove.
  12. Click Commit.