In this section:
The SIP Adaptor Profile object is the main construct for SIP Message Manipulation (SMM) functionality. A SIP Adaptor Profile is associated with a SIP Trunk Group or Zone in order to act upon SIP messages passing into or out of that group. A SIP Trunk Group can have two SIP Adaptor Profiles, an input adaptor profile for manipulation of inbound messages, and an output adaptor profile for manipulation of outbound messages. Similarly, a Zone can have two SIP Adaptor Profiles.
Refer to SIP Message Manipulation for additional SMM Details.
Flexible Policy is not supported on ERE and is intended for use with an external PSX only.
The SIP Adapter Profile can also be configured to support a flexible policy mechanism to facilitate dynamic routing and policy decisions based on any SIP message information element whereby routing and policy selection criteria are provisioned by the operator. An information element can be anything in the message, such as the following examples:
The following objects are used in supporting flexible policy and routing.
The Profile Type
parameter is used to specify whether a SIP Adapter Profile is used for flexible policy or message manipulation (default).
The System Provisioning - Zone object is used to assign a flexible policy-specific SIP Adaptor Profile to a specific zone.
The Trunk Group - SIP Trunk Group object is used to assign a flexible policy-specific SIP Adaptor Profile to a specific trunk group.
For Flexible Policy and Routing feature implementation, refer to Flexible Policy and Routing Support.
For Flexible Policy and Routing best practices, refer to Configuring Dynamic Policies and Routing Using Flexible Policy and Routing Feature.
The following general SIP Message Manipulation (SMM) rules apply when creating or editing SIP Adaptor Profiles.
To access the SIP Messages screen (Figure 1) to configure a SIP Adaptor Profile, login to the EMA GUI and use menu bars to navigate to Configuration > System Provisioning > Category: Trunk Provisioning > SIP Adaptor (SMM) Profile.
The SIP Messages screen consists of the following forms.
Tools workspace displays the following tools:
Each tool opens in its own form in the Tools workspace when you click the associated tab. More than one tool may be open at the same time.
To minimize a tool, click the "-" symbol in the top right corner of the form. To maximize it, click the "+" symbol. Click the "x" symbol to close the tool.
The Entries Table displays existing SIP Adaptor Profiles on the SBC. In the table header, you can select to view 5, 10 or 20 profiles at a time in the table.
Use this table to perform one or more of the following activities:
When you define criteria and action statements, it is quite common that when you make a selection, a new selection appears for you to define. For example, when defining a Message criteria and you choose "all response messages" in the for field, the field "with a response code" will appear with the choices "of" and "in the range". Selecting "of" then causes a blank field to appear for you to define the response code.
Click the New SIP Adaptor Profile tab to launch this tool.
The tool displays in the workspace similar to the below example defaulted to Rule 1 and Message criteria.
The New SIP Adaptor Profile tool consists of four basic sections which are defined in the table below.
While creating or editing a SIP Adaptor Profile, periodically click Save to save your progress.
The following table defines the Criteria and Action fields. For each rule, you define one or more criteria, and one or more actions.
Field/Control | Description |
---|---|
Name | Enter the SIP Adaptor Profile name. The length of the SIP Adaptor Profile name can be up to 23 characters. Also, a maximum of 512 SIP Adaptor Profiles may be defined. |
Profile Type | When creating a SIP Adaptor Profile, use this parameter to specify whether a SIP Adapter Profile is to be used for flexible policy or message manipulation.
|
Criteria: | |
Type | Each criteria you define will include one or more criteria types. By default, the first criteria type is Message, so the minimum activity to define is to take an action against one or more messages. Criteria Types include:
|
Sub-fields | Type: Message
Type: Header
Type: Parameter
Type: Token
Type: Variable
Type: Global Variable
Type: Message Body
|
(additional fields) | Additional fields will display to define request or response message types for the above two choices designated by "*". |
Undo Button | Click to undo your current edits and start over defining criteria. |
Add Criterion Button | Click to add the criterion to the rule. The criterion displays in its final definition. To re-edit the criterion, click the Edit button, make the change, and click Apply Edit button. |
Action: | |
Default action | The default action is to "Apply actions to a specific header instance equal to header instance 1.
|
Type | Action Types include:
|
action sub-field | The type selected will determine available actions
Regular expressions are based on the following W3C regular expressions pattern which is defined as a pattern, or sub-pattern, containing any white space or none white space string for up to 128 characters. The pattern can occur zero or one time. "(((([\s\S])){0,128})){0,1}" |
additional sub-fields | Additional fields display to further define the action to take depending upon the action chosen in the above field. For example, selecting Type "Parameter" and action "add a parameter" will produce three additional fields to be completed:
|
Footer | |
Enabled | Click to enable this profile. |
Advanced SMM Enabled | Enable flag to apply advanced SMM logic, such as dialog stateful variables, to the following messaging:
Dialog Stateful variables are not applied for the NOTIFY messages received prior to receiving 200 OK response to the Egress SUBSCRIBE. For an example SMM rule, see How to Treat Hostpart Based on the Received Format. |
Save Button | Click to save your current progress. |
Undo Edits Button | Click to undo current edits |
Select a SIP Adaptor Profile from the Entries Table. The Edit Selected SIP Adaptor Profile window is displayed.
This tool is includes the same functionality as the Create SIP Adaptor Profile tool above. The only difference is that you cannot change the profile name in this view.
Select a SIP Adaptor Profile from the Entries Table.
Click the Copy SIP Adaptor Profile to copy from the Entries Table:
The existing functionalities of the selected SIP Adaptor Profile is displayed. Make the desired changes and provide a different name for this SIP Adaptor Profile. This newly created SIP Adaptor Profile will be displayed below the original SIP Adaptor Profile in the Profile Table section of the screen.
Select a SIP Adaptor Profile from the Entries Table.
Click Edit Rule Sequence tab to launch this tool.
You can rearrange the Rule Sequence of the selected SIP Adaptor Profile by dragging and dropping the list items.
To Assign messageManipulation SIP Adaptor Profile
Select a messageManipulation SIP Adaptor Profile from the Entries Table.
To assign the selected messageManipulation SIP Adaptor Profile to Trunk Groups and Zones and click Assign SIP Adaptor Profile tab to launch this tool.
You can assign the selected SIP Adaptor Profile to required Trunk Groups and Zones.
To Assign Flexible Policy SIP Adaptor Profile
Select a Flexible Policy SIP Adaptor Profile from the Entries Table.
To assign the selected Flexible Policy SIP Adaptor Profile to Trunk Groups and Zones and click Assign SIP Adaptor Profile tab to launch this tool.
You can assign the selected SIP Adaptor Profile to required Trunk Groups and Zones.
Select a SIP Adaptor Profile from the Entries Table.
Click Test SIP Adaptor Profile tab to launch this tool.
The Test SIP Adaptor Profile tool displays in the workspace. The test tool label changes to reflect the profile under test.
Copy the SIP message from a browser or other source, and the paste it into the Input SIP Message window.
Enter any optional environment variables in the Global Variable Values fields using the following conventions:
Field | Convention |
---|---|
Source IP Address | IPv4 or IPv6 formatted IP address |
Source Port | Integer in the range of 0..4294967295 |
Signaling Port ID | Integer in the range of 0..4294967295 |
Local IP Address | IPv4 or IPv6 formatted IP address |
Local Port | Integer in the range of 0..4294967295 |
Egress Trunk Group Name | 1-23 characters (characters allowed: +-.:@0-9A-Z_a-z) |
Ingress Trunk Group Name | 1-23 characters (characters allowed: +-.:@0-9A-Z_a-z) |
Click the button. The Selected SIP Adaptor Profile is applied to the SIP message, and the results display in the Output SIP Message window. See example results below.
Select a SIP Adaptor Profile from the Entries Table.
Click View CLI tab to launch this tool.
The View CLI Script form opens in the Tools workspace.
If a SIP Adaptor Profile is already selected in the Entries table, the profile will automatically display in the View CLI Script form in CLI format similar to the example below.
The SBC Core is enhanced with Preconditions Interworking support to allow the SBC to provide the interworking functionality when only one leg of a call supports preconditions while the other leg does not, but the SBC is expected to provide interworking functionality on both legs. The preconditions interworking is triggered based on the presence/absence or value of a SIP information element (for example, a proprietary Header or Parameter). The message content is based on IP Trunk Group (IPTG)-related configurables on the ingress leg.
During an ingress precondition interworking sceanario, if the remote precondition is met in PRACK, the SBC will be able to process it and send the INVITE towards egress.
Prior to configuring a SIP Trunk Group name to a variable, refer to Reserving Network Resources to understand the preconditions and the requirements.
Follow these simple steps to assign a SIP Trunk Group Name to a variable:
Enable the State. The other parameters/flags gets unlocked.
Support If Egress IPTG
- DisableStrength Mandatory Policy
- EnableStrength Optional Policy
- EnableUPDATEPrecondition Policy
- DisableStrength Mandatory Priority
- 10Strength Optional Priority
- 45UPDATEPreconditions Priority
- 56Navigate to Configuration > System Provisioning > Category: Trunk Provisioning > SIP Adaptor (SMM) Profile. The SIP Adaptor (SMM) Profile window is displayed.