Acronyms

Product Issue Description

The OpenText RightFax product has several routing options that are tied to the port that a call rings in on.  Using the RightFax product, inbound calls can be routed to specific ports of an analog board based on the called number information associated with the call. 

In the current implementation of the Dialogic Brooktrout SR140 SIP product, inbound SIP calls are always routed to the first available SR140 channel and there’s no ability to route the call to a specific SR140 channel based on the called number or any other information associated with the call.

OpenText has requested the Dialogic Brooktrout SR140 SIP Product to provide support for Inbound SIP Call routing so that their RightFax product can route inbound SIP calls in a manner similar to the way it routes analog calls.

Overall Feature Description

Feature Request FR19312 will implement support for inbound SIP call routing on the SR140 product that will allow inbound SIP calls to be routed to specific SR140 channels based on information associated with each call.  In order to achieve this functionality, a new, optional, parameter will be introduced to the callctrl.cfg configuration file.  This new parameter will allow the user to specify a separate routing table configuration file that contains one or more routing rules.  Using this new functionality, inbound SIP calls will be able to be routed to specific SR140 channels based on information associated with each call such as the called address and/or calling address.

Assumptions

• None

Feature Limitations, Caveats, or Restrictions

• The Dialogic Brooktrout Configuration utility (ConfigTool.exe) may not be updated to provide support for the new parameter in the callctrl.cfg configuration file or the routing rules specified in the new routing table configuration file introduced for FR19312.

 Customer Use-Case

The callctrl.cfg configuration file is populated with the following information:

...

[module.41]

  model=SR140

  virtual=1

  exists=1

  vb_firm=C:\Brooktrout\Boston\fw\bostvb.dll

  channels=8

[module.41/host_cc.1]

  host_module=1

  number_of_channels=8

[host_module.1]

  module_library=brktsip.dll

  enabled=true

  routing_table=C:\Brooktrout\Boston\Config\routing.cfg

The Routing Table configuration file, routing.cfg, referenced by the routing_table parameter above is populated with the following information:

[routing.1]

  channel=0

  called_address="1001"

  calling_address=""

[routing.2]

  channel=1

  called_address="2xxx"

  calling_address=""

[routing.3]

  channel=2

  called_address="300[0-4]"

  calling_address=""

[routing.4]

  channel=3

  called_address="4xxx"

  calling_address="9732851832"

[routing.5]

  channel=4-5

  called_address=""

  calling_address="9732851832"

NOTE: The specific keywords and syntax that will be used to define the SR140 inbound call routing rules are not defined at this time and will be defined in the High Level Design document for this feature.  The example above is used for illustrative purposes and the final keywords and syntax are subject to change from what is presented here.

Once the Boston Host Service is initialized, a BFV application can wait for inbound calls on the 8 SR140 channels.  The following table illustrates how inbound calls would be routed based on the routing table above and the information contained in each call:

Requirements:

Reference List

RFC 3261 – SIP: Session Initiation Protocol (http://www.ietf.org/rfc/rfc3261.txt)

RFC 2705 – Media Gateway Control Protocol (MGCP) Version 1.0 (http://www.ietf.org/rfc/rfc2705.txt)

Product Areas Affected

• This feature will only affect inbound calls using the SIP call control protocol.

API/Library Change(s):

• None

Performance Change(s):

• None

Documentation Change(s):

• The Dialogic Brooktrout Bfv APIs Reference Manual will be updated to document the new callctrl.cfg configuration file parameter that specifies the pathname to the routing table configuration file as well as the new parameters supported in the  routing table configuration file.  Updates to this manual will also illustrate how to configure SR140 Inbound Call Routing Rules.

Configuration Change(s):

• The callctrl.cfg configuration file will be updated to support the changes required for FR19312.  These changes will include a new parameter to specify the pathname to a routing table configuration file. 
• The new routing table configuration file will define the SR140 Inbound Call Routing Rules.  For each Routing Rule defined in this configuration file, new parameters will be defined to allow the user to specify the following:
  • SR140 channel(s) that the routing rule applies to
  • Called address the inbound call must match
  • Calling address the inbound call must match 

Build and Installation Change(s):

• None

Specific Product Deliverables:

*This feature will be implemented on the Windows Linux and Solaris Operating Systems (OSs).  However, testing of this feature will be limited to Windows and Linux OSs.  Testing of this feature on the Solaris OS will not be performed.

Required Purchases:

• None

Product SKUs and Materials:

• None

Test Scenario(s):

The developer test plan will document the full description of the test cases below along with the results of the developer testing. This testing shall, at a minimum, contain the following test case

• No Routing Rules Configured:
  This test case verifies that when FR19312 functionality is disabled and no routing rules are specified, that an inbound SIP call can be successfully routed to the first available SR140 channel waiting for a call.

   

• Routing Rules Configured, Inbound Call Match
  This test case verifies when FR19312 functionality is enabled and one or more routing rules are specified, that when an inbound SIP call is received that matches at least one of the configured routing rules, the call is successfully routed to an SR140 channel specified in the matching routing rule.  This test should be repeated for when a single SR140 channel and when multiple SR140 channels are assigned to a routing rule.

   

• Routing Rules Configured, Inbound Call Doesn’t Match, No Extra SR140 channels
  This test case verifies when FR19312 functionality is enabled and one or more routing rules are specified, that when an inbound SIP call is received that doesn’t match any one of the configured routing rules and there aren’t any extra SR140 channels not assigned to routing rules, the call is rejected with a SIP 486 (Busy Here).

   

• Routing Rules Configured, Inbound Call Doesn’t Match, Extra SR140 channels
  This test case verifies when FR19312 functionality is enabled and one or more routing rules are specified, that when an inbound SIP call is received that doesn’t match any one of the configured routing rules and there are extra SR140 channels not assigned to routing rules, the call is successfully routed to a SR140 channel not assigned to a routing rule.

   

• Routing Rules Configured, Inbound Call Matches Wildcard Pattern
  This test case verifies when FR19312 functionality is enabled and one or more routing rules with wildcard patterns are specified, that when an inbound SIP call is received that matches at least one of the configured wildcard pattern routing rules, the call is successfully routed to a SR140 channel specified in the matching routing rule.

   

• Routing Rules Configured, Inbound Call Matches Range Pattern
  This test case verifies when FR19312 functionality is enabled and one or more routing rules with range  patterns are specified, that when an inbound SIP call is received that matches at least one of the configured range pattern routing rules, the call is successfully routed to a SR140 channel specified in the matching routing rule.

   

• Routing Rules Configured, Inbound Call Match, No Channel Available
  This test case verifies when FR19312 functionality is enabled and one or more routing rules are specified, that when an inbound SIP call is received that matches at least one of the configured routing rules but none of the SR140 channels assigned to the routing rule are available, the call is rejected with a SIP 486 (Busy Here).

   

• Routing Rules Configured, Inbound Call Match, Overlapping Channels in Routing Rules
  This test case verifies when FR19312 functionality is enabled and multiple routing rules are specified, that when an inbound SIP call is received that matches one of the configured routing rules but the SR140 channels assigned to the routing rule overlap with the channels assigned to a non-matching routing rule, the call is successfully routed to a SR140 channel specified in the matching routing rule.

   

• Routing Rules Configured, Inbound Call Match, Overlapping Called/Calling Addresses in Routing Rules
  This test case verifies when FR19312 functionality is enabled and multiple routing rules are specified that have overlapping called and/or calling addresses, that when an inbound SIP call is received that matches multiple routing rules, the call is successfully routed to a SR140 channel specified in the highest priority matching routing rule.FRRD FR19312 - SR140 Inbound Call Routing.doc