Dialogic® Diva® SIPcontrolTM Software 1.8 Reference Guide July 2008 206-477-05 www.dialogic.
Copyright and Legal Disclaimer Copyright and Legal Disclaimer Copyright © 2007-2008 Dialogic Corporation. All Rights Reserved. You may not reproduce this document in whole or in part without permission in writing from Dialogic Corporation at the address provided below. All contents of this document are furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation or its subsidiaries ("Dialogic").
Software License Agreement Software License Agreement This Software License Agreement ("Agreement") is a legal Agreement for the conditional use of the software provided herein ("Program") between you, the end-user, whether an individual or a company and all of its authorized users of the Program ("You"), and Dialogic Corporation ("Dialogic"). By downloading, copying or otherwise using the Program, You agree to be bound by the terms of the foregoing license.
Software License Agreement of Dialogic's standard Hardware product Warranty in effect at the time You purchased the hardware product concerned ("Hardware Warranty"). If a valid Advance Replacement Insurance policy contract is in place for the Dialogic hardware product concerned, Dialogic will endeavor to expedite provision of Activation Keys associated with the replacement device.
Software License Agreement Right to Audit If this Program is licensed for use in a Company, Your Company agrees to keep all usual and proper records and books of accounts and all usual proper entries relating to each installation of the Program during the term of this Agreement and for a period of three (3) years thereafter.
Contents Copyright and Legal Disclaimer.................................................................. 2 Software License Agreement ..................................................................... 3 About This Publication ............................................................................... 8 How to use this online guide ............................................................................................... 8 Structure of this guide .................................................
Routing examples .............................................................................................................47 How Call Addresses Are Processed .......................................................... 50 Possible scenarios ............................................................................................................50 How addresses are manipulated .........................................................................................50 How Address Maps Are Processed....
About This Publication About This Publication How to use this online guide • To view a section, click the corresponding bookmark located on the left. • To view a topic that contains further information, click the corresponding blue underlined phrase. • You may wish to print out the pages required for installing the drivers.
About the Dialogic® Diva® SIPcontrol™ Software CHAPTER 1 About the Dialogic® Diva® SIPcontrol™ Software The Diva SIPcontrol software is a gateway that translates call control information from the PSTN into SIP messages and vice versa. The Diva SIPcontrol software is installed on top of a Dialogic® Diva® Media Board, allowing the Diva board to be used as a SIP gateway within the computer or server that hosts the media server platform.
About the Dialogic® Diva® SIPcontrol™ Software • Called Party Number • Calling Party Number • Redirecting Number • Call Routing • Call Hold/Retrieve (e.g., Re-Invite mapping towards ISDN) • PSTN-side Call Transfer (i.e.
About the Dialogic® Diva® SIPcontrol™ Software • RFC3892 - SIP Referred - By Mechanism • RFC3951 - Internet Low Bit Rate Codec (iLBC) • RFC3952 - Real-time Transport Protocol (RTP) Payload Format for internet Low Bit Rate Codec (iLBC) Speech • RFC4028 - Session Timers in SIP • RFC4497 - Interworking between SIP and QSIG • RFC4566 - Session Description Protocol (SDP) • Draft: Diversion Indication in SIP (draft-levy-sip-diversion-08) Enhanced routing • Defines which CAPI controller is used for which calls fr
About the Dialogic® Diva® SIPcontrol™ Software Supported hardware The Dialogic® Diva® SIPcontrolTM software supports the following Dialogic® Diva® Media Boards (up to 240 channels are supported): Dialogic® Diva® ISDN BRI Media Boards • Diva BRI-2M 2.0 • Diva V-BRI-2 • Diva 4BRI-8M 2.0 • Diva V-4BRI-8 Dialogic® Diva® ISDN PRI Media Boards Diva PRI 3.
Software Installation CHAPTER 2 Software Installation To install the Dialogic® Diva® SIPcontrolTM Software, use the Dialogic® Diva® SIPcontrolTM Setup Wizard as described below: Note: If you want to upgrade from Diva SIPcontrol software version 1.5.1, DO NOT uninstall the software before you install the Diva SIPcontrol software version 1.8, since if you uninstall the software you might lose some settings, including your regular expressions. 1.
License Activation CHAPTER 3 License Activation The Dialogic® Diva® SIPcontrolTM Software includes a default license for two channels. This license can be used for testing and evaluating the Diva SIPcontrol software. You must activate a license if you need more than the two channels of the default license included with the Diva SIPcontrol software, or if you want to use G.729 speech compression, V.17 fax, or V.34 fax offered with the installed Dialogic® Diva® Media Board.
License Activation To register your PPC and DUID 1. Open the following web site: http://www.dialogic.com/activate. 2. Enter your PPC and click Check. Dialogic® Diva® SIPcontrolTM Software 1.
License Activation 3. If your PPC is valid, the following web site will open: Paste your Device Unique ID (DUID) that you saved earlier, and enter your email address to which the license file should be sent. 4. Click Activate to generate the license file that will be sent to the email address you have entered. 5. Save the license file and activate it. For more information, see To activate the license file below.
Dialogic® Diva® Media Board Configuration CHAPTER 4 Dialogic® Diva® Media Board Configuration With Dialogic® Diva® SIPcontrolTM Software version 1.8, Dialogic® Diva® Media Boards can be configured via the web interface. The configuration via the web interface can be accessed and updated remotely. The classic configuration via the Dialogic® Diva® Configuration Manager is also available, but it can only be accessed from the computer on which the Dialogic® Diva® System Release software is installed.
Dialogic® Diva® Media Board Configuration To configure Diva Media Board parameters, either click the board name or click the down arrow and select Configuration. A menu displaying the basic parameters will open: 3. You can also configure extended parameters that depend on the D-channel protocol you selected. To configure those parameters, select Yes under View Extended Configuration. An additional menu will open: 4.
Dialogic® Diva® Media Board Configuration The Board monitor If you click Board monitor on the left hand side, a page opens that allows one to control the current status and the configuration of the installed Dialogic® Diva® Media Boards, to read internal board trace buffers (XLOG) and to gain access to the management interface of Diva Media Boards and drivers: If you click the icon below Mgnt in the Available Diva Boards section, the management interface browser opens: The management interface browser al
Dialogic® Diva® Media Board Configuration The view report option If you click View report, the state and the cumulative statistics for the active Dialogic® Diva® Media Boards are shown: Dialogic® Diva® SIPcontrolTM Software 1.
Dialogic® Diva® Media Board Configuration If you click the board icon below Details, the following report information is displayed. The information contained in the report originates from the management interface of the Diva Media Boards. • Link status (Layer 1 state, Layer 1 alarms, Layer 2 state). • Total number of Layer1/Layer2 frames/bytes transferred over the D-channel. • Total number of Layer1/Layer2 errors detected in the D-channel frames.
Dialogic® Diva® Media Board Configuration Supported switch types and supported PBXs The following switch types are supported by the Dialogic® Diva® Media Boards: Public line ISDN protocols USA PRI and BRI • 5ESS Custom (AT&T) • 5ESS Ni (Lucent/Avaya) • DMS 100 (Nortel) • EWSD (Siemens) USA T.1/PRI • 4ESS • T.
Dialogic® Diva® Media Board Configuration PBX protocols • Generic Q.SIG T.1 and E.1 • ETSI Notes: • The Generic Q.SIG switch type can be used for the majority of PBXs. • Many European PBXs use the regular ETSI protocol (PRI and BRI).
Dialogic® Diva® SIPcontrol™ Software Configuration CHAPTER 5 Dialogic® Diva® SIPcontrol™ Software Configuration This chapter provides configuration tips and hints, it includes general information about each configuration, and it gives an overview of the configurable Diva SIPcontrol parameters. The configuration of the Dialogic® Diva® Media Boards is described in Dialogic® Diva® Media Board Configuration on page 17.
Dialogic® Diva® SIPcontrol™ Software Configuration Configuration Tips and Hints • Changes to the configuration will only take effect after you click Save at the bottom of each configuration page. • The settings will be lost if you close the Dialogic® Diva® SIPcontrolTM software web interface without having saved the configuration at the bottom of each configuration page. • A restart of the Diva SIPcontrol software is recommended if you change the IP address or the port on which SIPcontrol is listening.
Dialogic® Diva® SIPcontrol™ Software Configuration General Configuration You may configure the parameters shown in the graphic and explained in the table below: Hardware description: Displays the installed Dialogic® Diva® Media Board. This entry is predefined by the system and cannot be changed. PSTN interface number: Displays the number of the CAPI controller. The number is set automatically by the system. Name: Displays the name of the installed Dialogic® Diva® Media Board.
Dialogic® Diva® SIPcontrol™ Software Configuration Address Normalization You may configure the parameters shown in the graphic and explained below: Dialplan: Select the local dialplan to be used by the dialplan module of the Dialogic® Diva® SIPcontrolTM Software. The selected dialplan applies only to this controller. In most cases, the PSTN interfaces within the system share a common dialplan of the local environment, but configuring the dialplan per controller allows for handling variants, e.g.
Dialogic® Diva® SIPcontrol™ Software Configuration Transfer type: The following options are available: With consultation call (Call Deflection): The call is transmitted automatically. With consultation call (Explicit Call Transfer): After the transfer to the destination party, the channel is freed. The transfer may be announced or unannounced. With consultation call via tromboning: The call transfer is emulated. Two B-channels are blocked during the call transfer.
Dialogic® Diva® SIPcontrol™ Software Configuration Network Interface Configuration The network interface configuration allows for configuring the global network parameters of the Dialogic® Diva® SIPcontrolTM software, such as the IP addresses and the ports on which the Diva SIPcontrol software will be listening. The Diva SIPcontrol software 1.8 supports only a single IP address and port number.
Dialogic® Diva® SIPcontrol™ Software Configuration SIP Peer Configuration A SIP peer is a specific endpoint to and from which the Dialogic® Diva® SIPcontrolTM software will establish calls. The peer-specific settings may be used to adapt the Diva SIPcontrol software's behavior towards this peer. To add a SIP peer, click the Add button. To change the settings for the enabled SIP peer, click the Details button on the right hand side.
Dialogic® Diva® SIPcontrol™ Software Configuration Enhanced Configuration You may configure the parameters shown in the graphic and explained below: Default SIP to PSTN peer: Enable this option if the selected peer type should be used as default peer. Calls from unconfigured SIP peers will be assigned to this peer, and therefore are handled with these settings. If several peers are configured as default, the Diva SIPcontrol software takes the first to transmit the call.
Dialogic® Diva® SIPcontrol™ Software Configuration Reply-To format: You can configure this parameter only if you selected e-phone as Peer type in the Edit SIP Peer Configuration window. Enter the format that may be necessary for the e-phone server to handle the call. Normally, this is necessary to omit the 0 (zero) for external calls and to manipulate the address so the e-phone server is able to call back. Force T.38 reinvite: Some peers do not switch the media channel to T.
Dialogic® Diva® SIPcontrol™ Software Configuration Address normalization You may configure the parameters shown in the graphic and explained below: Dialplan: Select the local dialplan to be used by the dialplan module of the Dialogic® Diva® SIPcontrolTM Software. Configure the local dialplan under Dialplan Configuration as described on page 37 before you select it here. The dialplan selected here applies only to outgoing calls.
Dialogic® Diva® SIPcontrol™ Software Configuration Authentication Configuration You may configure the parameters shown in the graphic and explained below: Realm: Auth User Name: Password: A realm is a protection domain with its own user names and passwords. Enter the realm used by the SIP peer for authentication. The realm entered here needs to be the same as the realm of the endpoint. Enter a user name to be used with this realm. Enter the password to be used with this realm.
Dialogic® Diva® SIPcontrol™ Software Configuration Edit Routing Configuration You may configure the parameters shown in the graphic and explained below: Name: Enter a unique name for the route, e.g., "Calls to MS Exchange Server". Direction: Select if this route is for calls from SIP to PSTN or vice versa. Select Sources: Depending on the selected direction, this part either lists the configured PSTN interfaces or SIP peers.
Dialogic® Diva® SIPcontrol™ Software Configuration Conditions You may configure certain conditions for a route. If you do not configure any conditions, the route is used as default route. Note: If prefixes need to match, the digits of the prefix need to be prepended by a caret symbol ("^"); otherwise, these digits would match within the number as well, e.g. 0 would also match 1230@sipcontrol.com.
Dialogic® Diva® SIPcontrol™ Software Configuration Dialplan Configuration With help of the local phone settings, the Dialogic® Diva® SIPcontrolTM Software is able to convert a received call address to a normalized form, e.g., the E.164 format. This does not only ease the definition of subsequent conditions or maps, but it also converts the call to the format as required by the receiver.
Dialogic® Diva® SIPcontrol™ Software Configuration You may configure the parameters shown in the graphic and explained below: Name: Enter a name to easily identify the dialplan, e.g., Stuttgart office. Country code: Enter the country where the computer with the installed Dialogic® Diva® SIPcontrolTM Software is located. North-American numbering plan: Select this option if the North American numbering plan (NANP) is needed for your configuration.
Dialogic® Diva® SIPcontrol™ Software Configuration Access code: Enter the digits that are needed to get access to the public network, e.g., 9. PSTN access code provided by the SIP caller: Select this option if the SIP caller has to provide the access code. If the length of the called number is not sufficient to identify it as an internal number, activate this option to avoid ambiguous numbers. This is usually the case if you are not using the North American Numbering Plan (NANP).
Dialogic® Diva® SIPcontrol™ Software Configuration Address map name: Enter a name for the address map that helps you remember the purpose of the map. This name is shown in other menus where an address map may be selected. Note: The name may be edited only during the creation of a map. Rule name: Enter a name for the rule of the map, e.g., "Remove 9 from all incoming calls".
Dialogic® Diva® SIPcontrol™ Software Configuration Cause Code Mapping Configuration Depending on the type of SIP peer selected, different default mapping tables are used to adapt SIPcontrol's responses to the values expected by that peer. If the internal default mapping table provided by the Dialogic® Diva® SIPcontrolTM Software does not fulfill your needs, e.g.
Dialogic® Diva® SIPcontrol™ Software Configuration Codec Configuration To configure the codec list, click the Add button. To change the settings, click the Details button on the right hand side. If you create a codec profile, make sure to select it in the SIP Peer Configuration under Enhanced Configuration. To open the online help for a specific parameter, click the parameter and a window with the help text will pop up.
Dialogic® Diva® SIPcontrol™ Software Configuration V.34 Support: The V.34 fax transmission protocol allows facsimiles to be transmitted at a maximum speed of 33.600 bps. Enable this option if V.34 should be supported. Note that this feature is supported on Diva Media Boards with multiple ports only after activating the respective license. See License Activation on page 14 for more information. Maximum datagram size: This value defines the maximum amount of data that can be transmitted in one T.
Dialogic® Diva® SIPcontrol™ Software Configuration Domain: Enter the domain name of the registrar server. Own Display Name: Enter the name that should be displayed at the registrar server. Protocol: Select UDP if you register as e-phone gateway. Re-register Time: Enter the re-register time in seconds. This is the time the registration to the registrar server remains valid. After this time has elapsed, the SIP stack service would need to re-register to be available again.
How Calls Are Processed CHAPTER 6 How Calls Are Processed The Dialogic® Diva® SIPcontrolTM Software uses an endpoint-based approach to process calls, which means that every PSTN interface and every configured SIP peer is considered as a single endpoint. The endpoint saves the Diva SIPcontrol software settings for the respective PSTN interface or SIP peer.
How Calls Are Processed Every route defines only one direction. Therefore, at least two routes are needed to support both PSTN-to-SIP and SIP-to-PSTN connections. The basic call (without address manipulation) is processed as follows: 1. Find and assign an endpoint for an incoming call request (PSTN: lookup by CAPI controller number; SIP: lookup by "From" address of received message). 2.
How Calls Are Processed Emergency calls In many environments, certain numbers, e.g., 110/112 in Germany or 911 in the U.S., have to be handled differently from others. For example, they might need to be dialed without any access digit. This can be achieved by creating an additional route from any configured SIP peers to one or more PSTN interfaces and setting the called address expression to the emergency number(s). The route should be placed at the top position in the list.
How Calls Are Processed Connect two SIP peers to two PSTN interfaces exclusively If you choose to connect two SIP peers to two PSTN interfaces, so that each SIP peer may use one interface exclusively, then carry out the following configuration steps. The procedure is similar if you need to configure more PSTN interfaces, e.g., three PSTN interfaces to three SIP peers. 1. Under PSTN Interface Configuration, enable and configure the two PSTN interfaces. Confirm with OK. 2.
How Calls Are Processed • Select SIP to PSTN as direction. • Enable both SIP peers as source peer. • Enable the first PSTN interfaces as the Master destination. • Confirm with OK. 6. Save the configuration in the main configuration interface. If calls other than those beginning with 1 or 2 should also be directed to one peer, remove the condition from the respective PSTN to SIP route and move the route to the end of the list.
How Call Addresses Are Processed CHAPTER 7 How Call Addresses Are Processed The call addresses provided by the caller may be modified at different stages of the call processing within the Dialogic® Diva® SIPcontrolTM Software. The reason for multiple manipulation is that it allows for modifying the address where it is needed, which means that more complex environments can be configured with less effort, since data does not need to be entered redundantly at different places.
How Address Maps Are Processed CHAPTER 8 How Address Maps Are Processed Address maps are processed as follows: 1. Get the first map rule of the address map. 2. Verify if called, calling, and redirect expression each match the respective part of the call addresses (or are empty). If not, verify the next map rule. 3. If all three expressions match, apply each format string of the rule to the respective address match. 4. If the option Stop on match is enabled, stop processing.
How Numbers Are Processed CHAPTER 9 How Numbers Are Processed The Dialogic® Diva® SIPcontrolTM Software provides two mechanisms for number processing. Both mechanisms can be used together: 1. Number normalization based on a dialplan as described below. 2. Number modification using regular expressions as described on page 53.
How Numbers Are Processed length of the called number, this option can be disabled. In all other configurations with outside access digit this option has to be enabled. It is recommended to have this option enabled in dialplans with outside access digit. • The Diva SIPcontrol software's number normalization function does not remove outside access digits as a PBX can for external calls.
How Numbers Are Processed Common formats: Character Meaning 0-9,+ Inserts the respective character into the output (?n(digits)) Inserts the digits given only if the nth sub-expression of the expression matched $& Outputs what matched the whole expression $n Outputs the nth matched sub-expression + Indicates an international number type, if it is the first character in the string N Indicates a national number type, if it is the first character in the string S Indicates a subscriber number typ
How Numbers Are Processed Example: The number (01)1-472-333-7777 should be dialed as +1-472-333-7777 Expression entry: ^01 Format entry: + Replace an extension by another Task: Calls for specific extensions should be indicated with other extensions. Example: The extension 1111 should be replaced by 2222, and extension 3333 by extension 4444. First expression entry: 1111(@.*)?$ First format entry: 2222 Stop on Match: true Second expression entry: 3333(@.
Software Uninstallation CHAPTER 10 Software Uninstallation Note: If you want to upgrade from Dialogic® Diva® SIPcontrolTM Software version 1.5.1 to Diva SIPcontrol software version 1.8, DO NOT uninstall the software before you install the Diva SIPcontrol software version 1.8, since if you uninstall the software you might lose some settings, including your regular expressions. To uninstall the Diva SIPcontrol software: 1. Click Start > Settings > Control Panel. 2. Double-click Add or Remove Programs. 3.
Cause Code Mapping CHAPTER 11 Cause Code Mapping If the Dialogic® Diva® SIPcontrolTM Software uses Microsoft® Office Communications Server 2007 as SIP peer, the cause/response code tables are used as specified by Microsoft. See Default cause code mapping for Microsoft® Office Communications Server (OCS) 2007 SIP peers on page 60 for a detailed list of cause/response codes. If the Diva SIPcontrol software does not use Microsoft® OCS 2007, the default cause/response code mapping is used.
Cause Code Mapping ISDN cause code Description SIP response code Description forwarded to the SIP peer 47 Resource unavailable 503 Service unavailable 55 Incoming class barred within Closed User Group (CUG) 403 Forbidden 57 Bearer capability not authorized 403 Forbidden 58 Bearer capability not presently available 503 Service unavailable 63 Service or option not available, unspecified 488 Not acceptable here 65 Bearer capability not implemented 488 Not acceptable here 69 Requeste
Cause Code Mapping SIP response code from the SIP peer Description ISDN cause code Description 421 Extension required 79 Service/option not implemented 423 Interval too brief 63 Service or option unavailable 480 Temporarily unavailable 19 No answer from user 481 Call/transaction does not exist 41 Temporary failure 482 Loop detected 25 Exchange routing error 483 Too many hops 25 Exchange routing error 484 Address incomplete 28 Invalid number format (address incomplete) 485 Am
Cause Code Mapping Default cause code mapping for Microsoft® Office Communications Server (OCS) 2007 SIP peers The Dialogic® Diva® SIPcontrolTM Software includes a default cause/response code mapping table for Microsoft® OCS 2007 SIP peers that includes the most common (as of the date of publication of this document) cause codes according to RFC 3398 and RFC 4497. If you need to define a cause code mapping other than in the table, you can configure it in the Cause Code Mapping Configuration.
Cause Code Mapping ISDN cause code Description SIP response code forwarded to Microsoft® OCS 2007 Description 79 Service or option not implemented 501 Not implemented 87 User not member of Closed User Group 403 (CUG) Forbidden 88 Incompatible destination 400 Bad request 102 Recover on Expires timeout 504 Server time-out 111 Protocol error 500 Server internal error 127 Interworking, unspecified 500 Server internal error 500 Server internal error Any code other than listed above:
Cause Code Mapping Description SIP response code from Microsoft® OCS 2007 ISDN cause code Description 486 Busy here 17 User busy 488 Not acceptable here 65 Bearer capability not implemented 500 Server internal error 41 Temporary failure 501 Not implemented 79 Service/option not implemented 502 Bad gateway 38 Network out of order 503 Service unavailable 41 Temporary failure 504 Server time-out 102 Recovery on timer expiry 505 Version not supported 127 Interworking, unspecif
Event Logging Event Logging A computer with the Dialogic® Diva® SIPcontrolTM Software installed may write the following types of events into the System Event Log: • Errors • Warnings • Informational messages You can view the events in the Windows® Event Viewer. To do so, click Programs > Settings > Control Panel > Administrative Tools. In the Administrative Tools window, double-click Event Viewer and then Application, where the Diva SIPcontrol software stores the events.
Event Logging Warnings A warning is an event that is not necessarily significant but may indicate a possible future problem. See the following table for possible warnings. Variables are enclosed in angle brackets: Event ID Event Text Event Description 3000 SIP peer is not available. The SIP peer does not respond to keep-alive check requests, and has therefore been marked as inactive. It will receive no calls from SIPcontrol until the ongoing keep-alive check receives valid responses.
Customer Service CHAPTER 13 Customer Service Dialogic provides various options and arrangements for obtaining technical support for your Dialogic® Diva® product. We recommend that you use the Dialogic® Diva® Support Tools first before contacting your Dialogic Corporation supplier. We also suggest that you visit our help web, which includes detailed information about a variety of topics.
Customer Service Dialogic Customer Support If the information on the Dialogic Help Web was not sufficient to help you solve your problem, contact Dialogic Customer Support. See www.dialogic.com/support/contact for details on how to contact us. To provide help, Dialogic Customer Support will likely need from you: • A debug trace (see the Dialogic® Diva® Diagnostics Online Help file - DivaTrace.chm. • A copy of your active configuration (see the Dialogic® Diva® Configuration Manager Online Help file DSMain.
