Oracle Enterprise Communications Broker (Communications Broker) Header Manipulation Rule (HMR) support allows you to specify a manipulation type depending on an agent's location (hop) in a route. Applicable hops include the next and last hop of a route. Applying an HMR when an agent is the last hop in a route is referred to as "multi-hop" HMR. You do not need to make any changes to the HMR configuration for it operate as a multi-hop HMR.

The default setting makes the system apply the outbound HMR only when the agent is the next hop in the route's path.

If there are multiple HMRs that the Communications Broker must apply for the route, it applies the HMR for the last hop first. If the same agent is both next and last hop for any given traffic, the Communications Broker applies the HMR only once regardless of the Apply Outbound Manipulation On setting.

Set the Apply Outbound Manipulation On parameter on the agent to specify when the system applies the agent's outbound HMR. Default: Next Hop Only. Valid values: Next Hop Only | Last Hop Only | Next and Last Hop.

Refer to the following table for information about the attributes that you can configure for SIP header manipulation rules.

Configuring SIP manipulations from the Web GUI is a multi-faceted process performed through a series of nested dialogs that differ depending on the particular header and header element that you want to manipulate. It is not practical to document the entire SIP manipulations configuration process in one procedure. The documentation begins with the "Configure SIP Manipulation", topic where you can set the global parameters, if that is all you need. The documentation continues with procedures for each particular header and header element that you can manipulate. Each of those topics includes the global settings, so you can set or modify them there, as well.

When you finish configuring SIP manipulations, apply the rules to a session agent or SIP interface as "inbound" or "outbound."

1. Access the SIP Manipulation configuration object.
   Configuration tab, System Administration section, SIP Manipulation.
2. On the SIP Manipulation page, do the following:

   Table 15-1 SIP Manipulation

   Fields	Description
   Name	Enter the unique identifier for this SIP Manipulation. Use this name when applying this SIP manipulation. Default: Blank.
   Description	Enter a text description for this SIP Manipulation.
   Split Header	Enter a comma separated list of headers that the system separates prior to executing the manipulation. Example values: Allow,P-Asserted-Identity | Diversion,Allow.
   Join Header	Enter a comma separated list of headers that the system joins together after the manipulation execution is complete. Example values: Allow,P-Asserted-Identity | Diversion,Allow.

3. (Optional) Configure header rules and element rules. See "Configure a Header Rule" and "Configure an Element Rule."

You can configure SIP header rules and element rules on the Oracle Enterprise Communications Broker (Communications Broker) from the "CfgRules" section of the "SIP Manipulations" page.

1. Access the SIP Manipulation configuration object.
   Configuration tab, System Administration section, SIP Manipulation.
2. On the SIP Manipulation configuration page, do one of the following:
   1. Select and existing SIP manipulation configuration from the table, right-click, and click Edit. (Subsequent SIP manipulation pages use "Modify" in the title.)
   2. Click the Add icon. (Subsequent SIP manipulation pages use "Add" in the title.)
3. On the Add or Modify SIP Manipulation page, do one of the following.
   1. If you chose Add, you must enter a name for this SIP Manipulation. (You can optionally complete the Description, Split Headers, and Join Headers parameters, at this time. See "Configure SIP Manipulation.") Proceed to the next step.
   2. If you chose to edit an existing configuration, proceed to the next step.
4. On the Add or Modify SIP Manipulation page under Cgf Rules, click the Add button and select header-rule.
5. On the Add SIP Manipulation / Header Rule page, do the following.

   Name	Enter a unique name for this rule set. Valid values: Alpha-numeric.
   Header Name	Enter the name of the header on which you want the Communications Broker to use this HMR. Set this parameter to @status-line, where the at-sign (@)—not allowed in SIP header names—to prevent undesired matches with header having the name status-code. Default: Blank.
   Action	Select an action from the drop-down list for the header rule. Default: None. Valid values: Add | Delete | Find Replace All | Log | Manipulate | Monitor | None | Reject | SIP Manip | Store.
   Comparison Type	Specify how the Communications Broker processes the match rules against the SIP header. Default: Refer Case Sensitive. Valid values: Boolean | Case Insensitive | Case Sensitive | Pattern Rule | Refer Case Insensitive | Refer Case Sensitive.
   Msg Type	Specify the message type this rule applies to. Default: Any. Valid Values: Any | Out of Dialog | Reply | Request | Out of Dialog.
   Methods	Enter the method type to use when this SIP HMR is used. Default: Blank. Valid values" ACK | CANCEL | INVITE. When you do not set the method, the Communications Broker applies the rule to all SIP methods.
   Match Value	Enter the value to match against the header value in SIP packets; the Communications Broker matches these against the entire SIP header value. This is where you can enter values to match using regular expression values. Your entries can contain Boolean operators. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   New Value	When you set the action parameter Add or to Manipulate, enter the new value that you want to substitute for the entire header value. This is where you can set stored regular expression values for the Communications Broker to use when it adds or manipulates SIP headers. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   Cfg Rules	(Optional) Click Add, element-rule, and do the following. Name—Enter a unique name for this header element rule. You can enter up to 128 alphanumeric characters with no spaces. The name can include the _, ., or - characters, cannot begin with either the . or the - characters. Parameter name—Enter the parameter name to apply to the rule. Type—Select the element type to which to apply this rule. Action—Select an action from the drop-down list to apply to the element rule. Default: None. Match Val Type—Select a match value type that this rule applies to from the drop-down list. Default: Any. Comparison Type—Select an element type from the drop-down list to which to apply the rule. Default: Case Sensitive. Match Value—Enter the match value to compare against the current object. (To clear the value, enter and empty string.) New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\". (To clear the value, enter and empty string.) Click OK. The system displays the SIP Manipulation / Header Rule page. Do one of the following: Add another Element Rule. Finish the Header Rule configuration by completing the following steps.

6. Click OK.
7. Click OK.
8. Save the configuration.

You can configure Multi-Purpose Internet Mail Extensions (MIME) header rules and element rules on the Oracle Enterprise Communications Broker (Communications Broker) from the "CfgRules" section of the "SIP Manipulations" page.

1. Access the SIP Manipulation configuration object.
   Configuration tab, System Administration section, SIP Manipulation.
2. On the SIP Manipulation configuration page, do one of the following:
   1. Select and existing SIP manipulation configuration from the table, right-click, and click Edit. (Subsequent SIP manipulation pages use "Modify" in the title.)
   2. Click the Add icon. (Subsequent SIP manipulation pages use "Add" in the title.)
3. On the Add or Modify SIP Manipulation page, do one of the following.
   1. If you chose Add, you must enter a name for this SIP Manipulation. (You can optionally complete the Description, Split Headers, and Join Headers parameters, at this time. See "Configure SIP Manipulation.") Proceed to the next step.
   2. If you chose to edit an existing configuration, proceed to the next step.
4. On the Add or Modify SIP Manipulation page under Cfg Rules, click the Add button and select mime-rule.
5. On the Add or Modify SIP Manipulation / Mime Rule page, do the following.

   Name	Enter a unique name for this rule set. Valid values: Alpha-numeric.
   Content Type	Enter the name of the header on which you want the Communications Broker to use this HMR. Set this parameter to @status-line, where the at-sign (@)—not allowed in SIP header names—to prevent undesired matches with header having the name status-code. Default: Blank.
   Msg Type	Specify the message type this rule applies to. Default: Any. Valid Values: Any | Out of Dialog | Reply | Request | Out of Dialog.
   Methods	Enter the method type to use when this SIP HMR is used. Default: Blank. Valid values" ACK | CANCEL | INVITE. When you do not set the method, the Communications Broker applies the rule to all SIP methods.
   Format	Select the encode - decode format from the drop-down list for the MIME content.
   Action	Select an action from the drop-down list for the header rule. Default: None. Valid values: Add | Delete | Find Replace All | Log | Manipulate | Monitor | None | Reject | SIP Manip | Store.
   Comparison Type	Specify how the Communications Broker processes the match rules against the SIP header. Default: Refer Case Sensitive. Valid values: Boolean | Case Insensitive | Case Sensitive | Pattern Rule | Refer Case Insensitive | Refer Case Sensitive.
   Match Value	Enter the value to match against the header value in SIP packets; the Communications Broker matches these against the entire SIP header value. This is where you can enter values to match using regular expression values. Your entries can contain Boolean operators. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   New Value	When you set the action parameter Add or to Manipulate, enter the new value that you want to substitute for the entire header value. This is where you can set stored regular expression values for the Communications Broker to use when it adds or manipulates SIP headers. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   Cfg Rules	Click Add, mime-header-rule, and do the following. Name—Enter a unique name for this header element rule. You can enter up to 128 alphanumeric characters with no spaces. The name can include the _, ., or - characters, but cannot begin with either the . or the - characters. Mime Header Name—Enter header name within the MIME part to which to apply the rule. Use headername@peramble to change the preamble of a SIP body. Use headername@epilogue to change the epilog of a SIP body. Action—Select an action from the drop-down list to apply to the element rule. Default: None. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. Default: Match Value. (To clear the value, enter and empty string.) Match Value—Enter the match value to compare against the current object. (To clear the value, enter and empty string.) New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\". (To clear the value, enter and empty string.) Click OK. The system displays the SIP Manipulation / Mime Rule dialog. Do one of the following: Add another mime-header-rule. Finish the MIME Rule configuration by completing the following steps.

6. Click OK.
7. Click OK.
8. Save the configuration.

You can configure Multi-Purpose Internet Mail Extensions (MIME) header rules and element rules on the Oracle Enterprise Communications Broker (Communications Broker) from the "CfgRules" section of the "SIP Manipulations" page.

1. Access the SIP Manipulation configuration object.
   Configuration tab, System Administration section, SIP Manipulation.
2. On the SIP Manipulation configuration page, do one of the following:
   1. Select and existing SIP manipulation configuration from the table, right-click, and click Edit. (Subsequent SIP manipulation pages use "Modify" in the title.)
   2. Click the Add icon. (Subsequent SIP manipulation pages use "Add" in the title.)
3. On the Add or Modify SIP Manipulation page, do one of the following.
   1. If you chose Add, you must enter a name for this SIP Manipulation. (You can optionally complete the Description, Split Headers, and Join Headers parameters, at this time. See "Configure SIP Manipulation.") Proceed to the next step.
   2. If you chose to edit an existing configuration, proceed to the next step.
4. On the Add or Modify SIP Manipulation page under Cfg Rules, click the Add button and select mime-header-rule.
5. On the Add or Modify SIP Manipulation / Mime ISUP Rule page, do the following.

   Name	Enter a unique name for this rule set. Valid values: Alpha-numeric.
   Content Type	Enter the name of the header on which you want the Communications Broker to use this HMR. Set this parameter to @status-line, where the at-sign (@)—not allowed in SIP header names—to prevent undesired matches with header having the name status-code. Default: Blank.
   Msg Type	Specify the message type this rule applies to. Default: Any. Valid Values: Any | Out of Dialog | Reply | Request | Out of Dialog.
   Methods	Enter the method type to use when this SIP HMR is used. Default: Blank. Valid values" ACK | CANCEL | INVITE. When you do not set the method, the Communications Broker applies the rule to all SIP methods.
   Format	Select the encode - decode format from the drop-down list for the MIME content.
   Action	Select an action from the drop-down list for the header rule. Default: None. Valid values: Add | Delete | Find Replace All | Log | Manipulate | Monitor | None | Reject | SIP Manip | Store.
   Comparison Type	Specify how the Communications Broker processes the match rules against the SIP header. Default: Refer Case Sensitive. Valid values: Boolean | Case Insensitive | Case Sensitive | Pattern Rule | Refer Case Insensitive | Refer Case Sensitive.
   Match Value	Enter the value to match against the header value in SIP packets; the Communications Broker matches these against the entire SIP header value. This is where you can enter values to match using regular expression values. Your entries can contain Boolean operators. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   New Value	When you set the action parameter Add or to Manipulate, enter the new value that you want to substitute for the entire header value. This is where you can set stored regular expression values for the Communications Broker to use when it adds or manipulates SIP headers. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   Cfg Rules (instructions for configuring MIME HeaderRule)	Click Add, MIME Header Rule, and do the following. Name—Enter a unique name for this header element rule. Header Name—Enter header name within the MIME part to which to apply the rule. Action—Select an action from the drop-down list to apply to the element rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. (To clear the value, enter and empty string.) Match Value—Enter the match value to compare against the current object. (To clear the value, enter and empty string.) New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\" . Click OK. The system displays the SIP manipulation / Mime isup rule dialog. Do one of the following: Add another MIME Header Rule. Add an ISUP Param Rule, using the steps in the following table cell. Finish the MIME ISUP rule configuration by completing steps 3-6.
   Cfg Rules (instructions for configuring ISUP Param Rule)	Click Add, isup-param-rule, and do the following. Name—Enter a unique name for this header element rule. Type—Enter the parameter type that specifies the part of the isup body to manipulate. Format—Select a format from the drop down list for the encode - decode mode of the binary body form string form-ascii. Action—Select an action from the drop-down list to apply to the element rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. (To clear the value, enter and empty string.) Match Value—Enter the match value to compare against the current object. (To clear the value, enter and empty string.) New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, "\"MyName\" " . Click OK. The system displays the SIP manipulation / Mime isup rule dialog. Do one of the following: Add another ISUP Param Rule. Finish the MIME ISUP Rule configuration by completing the following steps.

6. Click OK.
7. Click OK.
8. Save the configuration.

You can configure Multi-Purpose Internet Mail Extensions (MIME) header rules and element rules on the Oracle Enterprise Communications Broker (Communications Broker) from the "CfgRules" section of the "SIP Manipulations" page.

1. Access the SIP Manipulation configuration object.
   Configuration tab, System Administration section, SIP Manipulation.
2. On the SIP Manipulation configuration page, do one of the following:
   1. Select and existing SIP manipulation configuration from the table, right-click, and click Edit. (Subsequent SIP manipulation pages use "Modify" in the title.)
   2. Click the Add icon. (Subsequent SIP manipulation pages use "Add" in the title.)
3. On the Add or Modify SIP Manipulation page, do one of the following.
   1. If you chose Add, you must enter a name for this SIP Manipulation. (You can optionally complete the Description, Split Headers, and Join Headers parameters, at this time. See "Configure SIP Manipulation.") Proceed to the next step.
   2. If you chose to edit an existing configuration, proceed to the next step.
4. On the Add or Modify SIP Manipulation page under Cfg Rules, click the Add button and select mime-sdp-rule.
5. In the Add or Modify SIP Manipulation / MIME SDP Rule page, do the following.

   Name	Enter a unique name for this rule set. Valid values: Alpha-numeric.
   Content Type	Enter the name of the header on which you want the Communications Broker to use this HMR. Set this parameter to @status-line, where the at-sign (@)—not allowed in SIP header names—to prevent undesired matches with header having the name status-code. Default: Blank.
   Msg Type	Specify the message type this rule applies to. Default: Any. Valid Values: Any | Out of Dialog | Reply | Request | Out of Dialog.
   Methods	Enter the method type to use when this SIP HMR is used. Default: Blank. Valid values" ACK | CANCEL | INVITE. When you do not set the method, the Communications Broker applies the rule to all SIP methods.
   Format	Select the encode - decode format from the drop-down list for the MIME content.
   Action	Select an action from the drop-down list for the header rule. Default: None. Valid values: Add | Delete | Find Replace All | Log | Manipulate | Monitor | None | Reject | SIP Manip | Store.
   Comparison Type	Specify how the Communications Broker processes the match rules against the SIP header. Default: Refer Case Sensitive. Valid values: Boolean | Case Insensitive | Case Sensitive | Pattern Rule | Refer Case Insensitive | Refer Case Sensitive.
   Match Value	Enter the value to match against the header value in SIP packets; the Communications Broker matches these against the entire SIP header value. This is where you can enter values to match using regular expression values. Your entries can contain Boolean operators. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   New Value	When you set the action parameter Add or to Manipulate, enter the new value that you want to substitute for the entire header value. This is where you can set stored regular expression values for the Communications Broker to use when it adds or manipulates SIP headers. When you configure HMR (using SIP manipulation rules and elements rules, you can use escape characters in the match-value parameter to support escaping Boolean and string manipulation operators. You can also escape the escape character itself, so that it is used as a literal string. For example, the Communications Broker treats the string \+1234 as +1234. The following are escape characters: +, -, +^, -^, &, |, \, (, ), ., $, ^, and “. You can also use the variables, $REMOTE_PORT and $LOCAL_PORT, which resolve respectively to the far-end and remote UDP or TCP port value.
   Cfg Rules (instructions for configuring mime-header-rule)	(Optional) Click Add, mime-header-rule, and do the following. Name—Enter a unique name for this header element rule. Mime Header Name—Enter header name within the MIME part to which to apply the rule. Action—Select an action from the drop-down list to apply to the element rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. Match Value—Enter the match value to compare against the current object. New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\" . Click OK. The system displays the SIP manipulation / Mime sdp rule dialog. Do one of the following: Add another mime-header-rule. Configure the sdp-session-rule and sdp-media-rule options, using the steps in the following table cells. Finish the MIME SDP rule configuration by completing steps 3-6.
   Cfg Rules (instructions for configuring sdp-session-rule)	(Optional) Click Add, sdp-session-rule , and do the following. Name—Enter a unique name for this header element rule. Action—Select an action from the drop-down list to apply to the this rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. Match Value—Enter the match value to compare against the current object. New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\". CfgRules—(Optional) Click Add, sdp-line-rule. Name—Enter a unique name for this rule. Type—Enter a descriptor type to specify the SDP line to manipulate. Action—Select an action from the drop-down list to apply to this rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. Match Value—Enter the match value to compare against the current object. New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\". Click OK. The system displays the SIP manipulation / Mime sdp rule / Sdp session rule dialog. (Optional) Add another sdp-line-rule. Click OK. The system displays the SIP manipulation / Mime sdp rule dialog. Do one of the following: Add another sdp-session-rule. Configure the mime-header-rule and sdp-media-rule options, using the steps in the corresponding table cells in this procedure. Finish the MIME SDP rule configuration by completing steps 3-6.
   Cfg Rules (instructions for configuring sdp-media-rule)	(Optional) Click Add, sdp-media-rule. Name—Enter a unique name for this header element rule. Media Type—Enter the media type to manipulate. For example, audio or video. Action—Select an action from the drop-down list to apply to the element rule. Comparison Type—Select the type of comparison from the drop-down list to use for the match value. Match Value—Enter the match value to compare against the current object. New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, "\"MyName\" " . Click OK. CfgRules—(Optional) Click Add, sdp-line-rule. Name—Enter a unique name for this rule. Type—Enter a descriptor type to specify the SDP line to manipulate. Action—Select an action from the drop-down list to apply to this rule. Comparison type—Select the type of comparison from the drop-down list to use for the match value. (To clear the value, enter and empty string.) Match Value—Enter the match value to compare against the current object. (To clear the value, enter and empty string.) New Value—Enter a new value for the object. Quoted display named must be escaped within quotes. For example, \"MyName\". Click OK. The system displays the SIP manipulation / Mime sdp rule / Sdp media rule dialog. (Optional) Add another sdp-line-rule. Click OK. The system displays the SIP manipulation / Mime sdp rule dialog. Do one of the following: Add another sdp-media-rule. Finish the MIME SDP rule configuration by completing the following steps.

6. Click OK.
7. Click OK.
8. Save the configuration.