Manage B2BUA Actions

Use the following procedures to define and edit the B2BUA Actions window.

• To Define the Actions
• To Define a Header Mode

• To Edit or Delete an Existing HMR Rule

To Define the Actions

For the INVITE or REGISTER message,

1. Choose VoIP > SIP > B2BUA.

2. Scroll to the Actions window. If necessary, click New Entry to create a new Actions entry.
   

3. Configure settings using the information in the following table as a guide. When you have finished configuring settings, click Update to make your changes take effect.
   B2BUA Actions Configuration Parameters

   B2BUA Actions Parameters

   Item	Description
   Actions and Pattern Matching First, define the Actions you would like the system to take when an INVITE is selected, and then define a Matching criterion for the INVITE. Refer to the following: Regular Expressions and Expression Examples SIP Trunking Patterns Manage Header Manipulation Language
   Actions Displays a list of configured actions on the system: Name—Enter the name that identifies the action. Message Type—Indicates the message type selected for configuring HMR rules: INVITE or REGISTER. Send To—Indicates whether the call is redirected to the specified Trunking device. Prio—Indicates that this is a priority call being sent to the FXO port (PSTN line). Hunt—Lists configured INVITE serial hunting contact headers.  Request Header—Indicates whether an action has a request HMR rule. Response Header—Indicates whether an action has a response HMR rule. Refer-to-ReINV—Specifies that REFER requests received for this call shall be converted into a series of Re-INVITE requests.
   New Entry Defines the actions you would like the system to take when an INVITE is selected. Once you have set the Actions, you can define a matching criterion for the INVITE in Match.
   Name	Enter a unique name to identify the action. This name is used in the drop-down list in the Match section.
   Message Type	Select one of the checkboxes to apply HMR rules to the message headers: INVITE—Rules apply to request and response headers. REGISTER—Rules apply to host clients or pilot message headers.  Note You can either select INVITE or REGISTER or both checkboxes. However, if you only select REGISTER, the Send To field will be grayed out and unavailable for configuration. When you select the INVITE message checkbox, you can configure HMR rules for both request and response headers. Note that this is an existing functionality. You must select at least one message type to configure HMR rules. Otherwise, a window appears on the GUI, warning you that the Actions configuration is incomplete. EdgeMarc identifies REGISTER messages by matching the existing criteria for the INVITE message and applies the corresponding HMR request rules to the REGISTER message headers.   Note HMR rules apply to both INVITE and REGISTER message headers. However, you cannot configure HMR rules for REGISTER response headers. You can configure the same HMR rule for INVITE and REGISTER message request headers. You can select both message types (INVITE and REGISTER) simultaneously on the GUI, but ensure that the valid headers are configured for the corresponding message type. When you select the REGISTER message checkbox, you can also configure HMR rules for standard headers, such as From, To, Contact, and User-Agent. If you configure the Action rule "Send To" with a Trunking Device, Client, or a URI, then EdgeMarc uses the corresponding address to send the REGISTER request. Note To configure HMR rules for Pilot REGISTER messages, users must first enable the Use B2BUA Rule button in the Credentials and Registration window. For details, see Manage B2BUA Credentials and Registration.
   Send To	Select one of the following radio buttons: Send To—Redirects the call to the specified location: Trunking Device—Choose a device from the drop-down list: None—The call is sent to the default target softswitch for outbound calls, and the client is found by called number lookup for inbound calls. Trunking device configured on the system Client—Manually specified client. URI—If you choose a SIP response, it must include a response code between 300 and 699. Any Header Manipulation Rules (HMR) rules added to the action are applied to the response. Response—Returns a manually specified SIP response. Note To configure the Send To field, make sure that the Message Type INVITE or both INVITE and REGISTER checkboxes are selected. Otherwise, this field will be grayed out.
   Prioritize	Select the Prioritize checkbox to identify this call as a priority call that will be sent to an FXO port (PSTN line).
   Refer to Re-INVITE	Select the Refer to Re-INVITE checkbox to specify that REFER requests received for this call shall be converted into a series of Re-INVITE requests.
   Analog Hunting	Select one of the following options from the drop-down list: Disabled—Serial Hunting is applied to calls. Sequential hunting—The call goes to the first available member in the hunt group. If the first member is unavailable, the call goes to the next member as the prescribed sequence of members in the group. Simultaneous hunting—All free members in the hunt group ring at the same time. Circular hunting—The first call goes to the first member in the hunt group, and the second call to the second member, regardless of whether the first call got connected. If the first call does not connect, it goes to the next member in the group. When hunting reaches the last member, the hunt starts from the first member in the group. Note To configure Analog Hunting, users must select the EW_UA option for the Trunking Device radio button in the Send To field.
   Serial Hunting	In the Serial Hunting field, add a list of contact headers. Click Add to add your entries to the Serial Hunting list. A special SIP URI “sip:ss@localdomain” can be used in this field to refer to the current softswitch. To delete an entry, click once on the entry in the Serial Hunting field to highlight the entry and click Delete.
   E.164 Conversion Rule	Select the required rule for E.164 conversion from the drop-down list. The drop-down list will only show rules previously created in the E.164 Country Code Mapping window. See Manage E.164 Country Code Mapping.
   Conversion Mode	Select the type of E.164 conversion from the drop-down list. Two types of conversion modes are available: Add: To prepend country code to the username of the header. Strip: To remove the country code from the username. Note: The system assumes the phone number has 10 digits, excluding the country code.
   Header Manipulations EdgeMarc allows users to configure HMR rules for both Requests and Responses separately. Select either one of the following options to set the HMR rule type: Request Response Note: If you configure HMR for Response, it is only applied to 180 and 200 OK response messages.
   Header	Add custom headers to the SIP message in the Header Manipulations fields: Select a header name from the Header drop-down list. If the name is not listed, select Other from the drop-down list and enter the name of the header in the field provided.
   Value	Enter the header value using EdgeMarc Header Manipulation language using the information in Manage B2BUA Pattern and Digit Matching as a guide. The text should follow the format required of the SIP header. For example, if the selected header from the drop-down list is “P-Asserted-Identity,” the value should be “sip:123456@example.com. When you are finished, click Add. See the following support information: Regular Expressions and Expression Examples SIP Trunking Patterns
   Header Passthrough The Header Passthrough feature allows or blocks a set of non-standard headers in a SIP INVITE message or permits all headers to pass through to their destination based on the mode a user selects in the Header Passthrough Mode field. Note that this feature exclusively supports the INVITE message and works in the B2BUA mode.
   Header Passthrough Mode	Select an option from the drop-down box to set the mode of the headers: B2BUA Mode is the default setting. Selecting this option strips all non-standard headers except those added to the HMR.  Allow All option lets all non-standard headers to pass through. Use this option only for testing or when all SIP endpoints on a network are fully trusted. Allow Listed option permits only those non-standard headers you add to the Headers field. All other headers are stripped.   Block Listed option stops the headers listed in the Headers field and lets all other headers pass through. Note If you select the B2BUA Mode or Allow all option, the Headers field will be grayed out. As an example, see the Actions figure under Step 2 in To Define the Actions.
   Headers	You can add headers in this field after you select the Allowed Listed or Block Listed option in the Header Passthrough Mode field. Add a header name in the input box and click Add.  The header name appears in the Headers field.  To delete a header, select the header name and click Delete. For more information, see procedure To Define a Header Mode.
   Message Translation Message translation rule is configured to provide support for translating 180/183 with or without SDP. For more information, refer to Configuring Message Translation of 180/183 with or without SDP.

To Define a Header Mode

1. Select a Header Passthrough Mode option from the drop-down box.
   
   For a description of these options, see the Header Passthrough fields in table B2BUA Actions Configuration Parameters.
2. Select the Allow Listed or Block Listed option to add a list of headers to pass or block from passing through.
3. Click Add. The following example shows a list of allowed headers that can pass through.
   
   Select a header in the Headers field and click Delete to delete a header.
4. Click Update to apply your changes.
5. To save your configuration changes to the EdgeMarc, click Submit.

To Edit or Delete an Existing HMR Rule

1. Click once on the entry in the Actions table. The row is highlighted, and the information from the selected line is displayed in the details box below the table.
2. Click the entry in the Header Manipulations frame and click Add/Edit. 
3. Edit the HMR rule for the Request or Response message:
   1. Select an option for the Header field.
   2. Update the Value of the header.

4. Click Update. Your changes are applied to the local cache.

5. To save your configuration changes to the EdgeMarc, click Submit.

   Note

   From the Match window, EdgeMarc enables you to use the UP and DOWN arrow keys to arrange the Match rules without deleting the existing match rules and the configured header values for the Request and Response messages. For more information, see Arrange the Match rules.

6. To delete an entry, click the red X next to the selected entry. The entry is immediately removed from the Actions table. Note that you do not have to click Submit when deleting an entry.

7. Click Update to apply the changes to the local cache.

8. To send configuration changes to the EdgeMarc, click Submit at the bottom of the B2BUA Trunking Configuration page.

9. Proceed to Manage Response Code Mapping.