Configuring IP-to-IP Outbound Manipulations

The Outbound Manipulations table lets you configure up to 3,000 IP-to-IP Outbound Manipulation rules. An Outbound Manipulation rule defines a manipulation action for the SIP Request-URI user part (source or destination) or calling name of outbound SIP dialog requests. You can apply these manipulations to different SIP request types (e.g., INVITE) and SIP headers as follows:

■

Manipulated destination URI user part are done on the following SIP headers: Request URI and To

■

Manipulated source URI user part are done on the following SIP headers: From, P-Asserted (if exists), P-Preferred (if exists), and Remote-Party-ID (if exists)

Manipulated URI user part of the SIP From and Request-URI headers overwrite the user part of other headers.

Configuration of Outbound Manipulation rules includes two areas:

■

Match: Defines the matching characteristics of an incoming SIP dialog (e.g., source host name). As the device performs outbound manipulations only after the routing process, destination IP Groups can also be used as matching characteristics.

■

Action: Defines the action that is done if the incoming call matches the characteristics of the rule. In other words, the device manipulates the source or destination SIP URI user part or calling name of the SIP dialog (e.g., removes a user-defined number of characters from the left of the SIP URI user part).

●

Configure stricter classification rules higher up in the table than less strict rules to ensure the desired rule is used to manipulate the outbound dialog. Strict refers to the number of matching characteristics configured for the rule. For example, a rule configured with source host name and source IP Group as matching characteristics is stricter than a rule configured with only source host name. If the rule configured with only source host name appears higher up in the table, the device ("erroneously") uses the rule to manipulate outbound dialogs matching this source host name (even if they also match the rule appearing lower down in the table configured with the source IP Group as well).

●

SIP URI host name (source and destination) manipulations can also be configured in the IP Groups table (see Configuring IP Groups). These manipulations are simply host name substitutions with the names configured for the source and destination IP Groups, respectively.

The following procedure describes how to configure Outbound Manipulations rules through the Web interface. You can also configure it through ini file [IPOutboundManipulation] or CLI (configure voip > sbc manipulation ip-outbound-manipulation).

➢

To configure Outbound Manipulation rules:

Open the Outbound Manipulations table (Setup menu > Signaling & Media tab > SBC folder > Manipulation > Outbound Manipulations).

Click New; the following dialog box appears:

Configure an Outbound Manipulation rule according to the parameters described in the table below.

Click Apply.

Outbound Manipulations Table Parameter Description

Parameter

Description

'Routing Policy'

routing-policy-name

[RoutingPolicyName]

Assigns a Routing Policy to the rule. The Routing Policy associates the rule with an SRD(s). The Routing Policy also defines default LCR settings as well as the LDAP servers if the routing rule is based on LDAP routing (and Call Setup Rules).

If only one Routing Policy is configured in the Routing Policies table, the Routing Policy is automatically assigned. If multiple Routing Policies are configured, no value is assigned.

To configure Routing Policies, see Configuring SBC Routing Policy Rules.

Note: The parameter is mandatory.

General

'Index'

[Index]

Defines an index number for the new table row.

Note: Each row must be configured with a unique index.

'Name'

manipulation-name

[ManipulationName]

Defines a descriptive name, which is used when associating the row in other tables.

The valid value is a string of up to 40 characters. By default, no value is defined.

Note: The parameter value can't be configured with the character string "any" (upper or lower case).

'Additional Manipulation'

is-additional-manipulation

[IsAdditionalManipulation]

Determines whether additional manipulation is done for the table entry rule listed directly above it.

■

[0] No = (Default) Regular manipulation rule - not done in addition to the rule above it.

■

[1] Yes = If the previous table row entry rule matched the call, consider this row entry as a match as well and perform the manipulation specified by this rule.

Note: Additional manipulation can only be done on a different item (source URI, destination URI, or calling name) to the rule configured in the row above (configured by the 'Manipulated URI' parameter).

'Call Trigger'

trigger

[Trigger]

Defines the reason (i.e., trigger) for re-routing the SIP request.

■

[0] Any = (Default) Re-routed for all scenarios (re-routes and non-re-routes).

■

[1] 3xx = Re-routed if triggered as a result of a SIP 3xx response.

■

[2] REFER = Re-routed if triggered as a result of a REFER request.

■

[3] 3xx or REFER = Applies to optional values 3xx and REFER.

■

[4] Initial only = Regular requests that the device forwards to a destination. In other words, re-routing of requests triggered by the receipt of REFER or 3xx doesn't apply.

Match

'Request Type'

request-type

[RequestType]

Defines the SIP request type to which the manipulation rule is applied.

■

[0] All = (Default) all SIP messages.

■

[1] INVITE = All SIP messages except REGISTER and SUBSCRIBE.

■

[2] REGISTER = Only SIP REGISTER messages.

■

[3] SUBSCRIBE = Only SIP SUBSCRIBE messages.

■

[4] INVITE and REGISTER = All SIP messages except SUBSCRIBE.

■

[5] INVITE and SUBSCRIBE = All SIP messages except REGISTER.

'Source IP Group'

src-ip-group-name

[SrcIPGroupName]

Defines the IP Group from where the INVITE is received.

The default value is Any (i.e., any IP Group).

'Destination IP Group'

dst-ip-group-name

[DestIPGroupName]

Defines the IP Group to where the INVITE is to be sent.

The default value is Any (i.e., any IP Group).

'Source Username Pattern'

src-user-name-pattern

[SrcUsernamePrefix]

Defines the source SIP URI user name (typically used in the SIP From header).

You can use special patterns (notations) to denote the user part. For example, if you want to match this rule to user parts whose last four digits (i.e., suffix) are 4 followed by any three digits (e.g., 4008), then configure this parameter to "(4xxx)". For available patterns, see Dialing Plan Notation for Routing and Manipulation.

The valid value is a string of up to 60 characters. The default value is the asterisk (*) symbol, meaning any source user part.

Note: If you need to manipulate calls of many different source URI user parts, you can use tags (see 'Source Tags' parameter below) instead of this parameter.

'Source Host'

src-host

[SrcHost]

Defines the source SIP URI host name - full name, typically in the From header.

The default value is the asterisk (*) symbol (i.e., any source host name).

'Source Tags'

src-tags

[SrcTags]

Assigns a prefix tag to denote source URI user names corresponding to the tag configured in the associated Dial Plan.

The valid value is a string of up to 255 characters. The tag is case insensitive. By default, no value is defined. You can configure the parameter with up to five tags, where each tag is separated by a semicolon (;). However, you can configure only up to seven tags containing a name and value (e.g., Country=Ireland), and one tag containing a value only (e.g., Ireland). If you are configuring multiple tags in the name=value format, the names of each tag must be unique (e.g., Country=Ireland;Land=Scotland). The following example configures the maximum number of tags (i.e., seven name=value tags and one value-only tag): Country=Ireland;Country2=Scotland;Country3=RSA;Country4=Canada;Country5=UK;Country6=France;Country7=Germany;USA.

To configure prefix tags, see Configuring Dial Plans.

Note:

■

Make sure that you assign the Dial Plan in which you have configured the prefix tag, to the related IP Group or SRD.

■

Instead of using tags and configuring the parameter, you can use the 'Source Username Pattern' parameter to specify a specific URI source user or all source users.

'Destination Username Pattern'

dst-user-name-pattern

[DestUsernamePrefix]

Defines the destination SIP URI user part (typically located in the Request-URI and To headers).

The valid value is a string of up to 60 characters. The default value is the asterisk (*) symbol, meaning any destination user part.

Note: If you need to manipulate calls of many different destination URI user names, you can use tags (see 'Destination Tags' parameter below) instead of this parameter.

'Destination Host'

dst-host

[DestHost]

Defines the destination SIP URI host name - full name, typically located in the Request-URI and To headers.

The default value is the asterisk (*) symbol (i.e., any destination host name).

'Destination Tags'

dest-tags

[DestTags]

Assigns a prefix tag to denote destination URI user names corresponding to the tag configured in the associated Dial Plan.

To configure prefix tags, see Configuring Dial Plans.

Note:

■

Make sure that you assign the Dial Plan in which you have configured the prefix tag, to the related IP Group or SRD.

■

Instead of using tags and configuring the parameter, you can use the 'Destination Username Pattern' parameter to specify a specific URI destination user or all destinations users.

'Calling Name Pattern'

calling-name-pattern

[CallingNamePrefix]

Defines the calling name (caller ID). The calling name appears in the SIP From header.

The valid value is a string of up to 37 characters. By default, no calling name is defined. You can use special patterns (notations) to denote the calling name. For available patterns, see Dialing Plan Notation for Routing and Manipulation.

'Message Condition'

message-condition-name

[MessageConditionName]

Assigns a Message Condition rule as a matching characteristic. Message Condition rules define required SIP message formats.

To configure Message Condition rules, see Configuring Message Condition Rules.

'ReRoute IP Group'

re-route-ip-group-name

[ReRouteIPGroupName]

Defines the IP Group that initiated (sent) the SIP redirect response (e.g., 3xx) or REFER message. The parameter is typically used for re-routing requests (e.g., INVITEs) when interworking is required for SIP 3xx redirect responses or REFER messages.

The default is Any (i.e., any IP Group).

Note:

■

The parameter functions together with the 'Call Trigger' parameter (see below).

■

For more information on interworking of SIP 3xx redirect responses or REFER messages, see Interworking SIP 3xx Redirect Responses and Interworking SIP REFER Messages, respectively.

Action

'Manipulated Item'

manipulated-uri

[IsAdditionalManipulation]

Defines the element in the SIP message that you want manipulated.

■

[0] Source URI = (Default) Manipulates the source SIP Request-URI user part.

■

[1] Destination URI = Manipulates the destination SIP Request-URI user part.

■

[2] Calling Name = Manipulates the calling name in the SIP message.

'Remove From Left'

remove-from-left

[RemoveFromLeft]

Defines the number of digits to remove from the left of the manipulated item prefix. For example, if you enter 3 and the user name is "john", the new user name is "n".

'Remove From Right'

remove-from-right

[RemoveFromRight]

Defines the number of digits to remove from the right of the manipulated item prefix. For example, if you enter 3 and the user name is "john", the new user name is "j".

'Leave From Right'

leave-from-right

[LeaveFromRight]

Defines the number of digits to keep from the right of the manipulated item.

'Prefix to Add'

prefix-to-add

[Prefix2Add]

Defines the number or string to add in the front of the manipulated item. For example, if you enter 'user' and the user name is "john", the new user name is "userjohn".

If you set the 'Manipulated Item' parameter to Source URI or Destination URI, you can configure the parameter to a string of up 49 characters. If you set the 'Manipulated Item' parameter to Calling Name, you can configure the parameter to a string of up to 36 characters.

'Suffix to Add'

suffix-to-add

[Suffix2Add]

Defines the number or string to add at the end of the manipulated item. For example, if you enter '01' and the user name is "john", the new user name is "john01".

'Privacy Restriction Mode'

privacy-restriction-mode

[PrivacyRestrictionMode]

Defines user privacy handling (i.e., restricting source user identity in outgoing SIP dialogs).

■

[0] Transparent = (Default) No intervention in SIP privacy.

■

[1] Don't change privacy = The user identity remains the same as in the incoming SIP dialog. If a restricted number exists, the restricted presentation is normalized as follows:

✔

From URL header: "anonymous@anonymous.invalid"

✔

If a P-Asserted-Identity header exists (either in the incoming SIP dialog or added by the device), a Privacy header is added with the value "id".

■

[2] Restrict = The user identity is restricted. The restriction is as follows:

✔

From URL header: "anonymous@anonymous.invalid"

✔

If a P-Asserted-Identity header exists (either in the incoming SIP dialog or added by the device), a Privacy header is added with the value "id".

■

[3] Remove Restriction = The device attempts to reveal the user identity by setting user values in the From header and removing the privacy "id" value if the Privacy header exists. If the From header user is "anonymous", the value is taken from the P-Preferred-Identity, P-Asserted-Identity, or Remote-Party-ID header (if exists).

Note:

■

Restriction is done only after user number manipulation, if any.

■

The device identifies an incoming user as restricted if one of the following exists:

✔

From header user is "anonymous".

✔

P-Asserted-Identity and Privacy headers contain the value "id".