Transcription
TechNoteMitel MiVoice Office 400 - R5May 18, 2017www.xcapi.de
Mitel MiVoice Office 400 - R5Page 2IntroductionThis document is intended to support you with the integration of the latest XCAPI version intoan existing environment of the Mitel MiVoice Office 400, formerly known as Aastra 400/470series.Though being based on the Mitel MiVoice Office 400 R5 and a Communication server Mitel470, it is applicable to other versions given a few adjustments.In the following sections we describe the essential configuration steps to allow optimalinterworking of both the XCAPI and the Mitel MiVoice Office 400. At this point we supposethat the VoIP environment is in operation which means that the Mitel MiVoice Office 400,XCAPI and CAPI applications are properly installed.For XCAPI basics please refer to the document XCAPI TechNote (en) - Quick Start Guide.pdf,which is available for registered users within our community download area. We also recommend to visit our YouTube channel for additional information and hints around XCAPI.XCAPI ConfigurationPlease start up the XCAPI configuration to create a new controller assigned to the MitelMiVoice Office 400. If you’ve just installed the XCAPI and start the configuration tool forthe first time or no controller is available at all, the XCAPI controller wizard will pop upautomatically. However, to start up the XCAPI controller wizard manually the hyperlinklabeled Click here to add a controller on the main page has to be clicked.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R52.1Page 3Type of ControllerOn the first page of the controller wizard PBX or other VoIP System must be selected.Afterwards, please continue with pushing the Next button.2.2VoIP EnvironmentThe VoIP Environment dialog shows a list of some common Voice-over-IP environments.Selecting one of those will configure the XCAPI controller with a selection of near-optimalpresets for the kind of environment you have, sparing you quite a lot of manual configuration.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R52.3Page 4Description and ChannelsWhen the VoIP environment was selected, the next dialog allows to set a meaningfuldescription for the controller. Also the number of channels that the new controller will beable to provide to the CAPI 2.0 application can be set. So please enter how many simultaneousconnections the XCAPI controller should handle when communicating with the Mitel MiVoiceOffice 400 and the CAPI 2.0 application.2.4Gateway AddressAfterwards, please provide the IP address of the Mitel MiVoice Office 400 gateway.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R52.5Page 5Network InterfaceNext, select the network interface that will be used for the inbound and outboundcommunication for this controller.2.6Port AllocationOn demand and in the case of any router or firewall restrictions for UDP (RTP/T.38) a port rangecan be specified. In this example no port range will be set which enables using a random portrange between 1024 and 65535.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R52.7Page 6ConfirmationThe final wizard dialog performs some checks on the configuration parameters you’ve made.If any errors are detected here, you can go back to the respective dialogs and correct theerroneous input. If everything is correct just push the Finish button in order to finally createthe new XCAPI controller.Now, the new created XCAPI controller appears on the main page of the configuration tool.As all XCAPI related configuration tasks are finished now, please save the changes and exit theconfiguration tool.Please note that you always need to restart the bound CAPI application, inmeaning of its services, for the changes to take effect. Restarting any XCAPIrelated services won’t help at all. If enabled and on success, the XCAPIdiagnostic monitor will pop-up with a reinit notification.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 7Mitel MiVoice Office 400 ConfigurationIn order to establish a connection between the XCAPI and the Mitel 400, you need to setupthe XCAPI as private SIP network (PISN) with all its appropriate configurations. The nextchapters show a basic configuration which can’t be assigned one-to-one to the environment.The according configuration dialogs have to be adapted to the PBX environment andhardware and the according CAPI application. Especially the DDI and Call DistributionElements must reflect the local circumstances as well as specific SIP and numbering relatedparameters.3.1System OverviewFirst we’ll give a short overview of this example’s Mitel 470 card integration and systemconfigurations. The accordance of VoIP mode VoIP and FoIP channels within the DSPconfiguration depends on the installed cards.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 8This environment uses the default bandwidth area which is related to the preferred codecand frame length G.711a / 20 ms. This frame length is also used by default from the XCAPIcontroller configuration.Also the VoIP settings of the IP Network configuration are used with the system given defaults.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 9Ensure that the required SIP Access Channels license is available for appropriate SIP trunkinterworking.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.2Page 10Private SIP NetworkingXCAPI has to be added as new SIP Node within the Private SIP networking configurations ofthe Mitel communication server.In this example the new node is added with the Route only calls to private destinations tothe new SIP node selection. The SIP remote node name is entered and the IP address / hostname is set to the XCAPI controller related Ethernet IP address, here IP address 172.18.0.152.The Port is used with the default (port 5060). If the default port will be adjusted the XCAPIcontrollers used listening port (which is also set by default to port 5060) has to be set conform.The Authentication name and Authentication password is left blank as no authentication isused here. The Internal number range to be routed to new SIP node is set to 4XX. The Routefor calls to private destinations is set to Route 4.As soon as applied, several useful pre-configurations (SIP networking node, PISN user, SIPTrunk, SIP Interface) will be created. The according configuration details will be shown inthe referring sections.At this point the SIP trunk and routing of the PISN user is already in operation up to a certainlevel.To allow appropriate routings of and between other nodes additional DDI plan configurationsmust be made. For example public calls via ISDN or SIP providers which has to related androuted to the PISN users numbering range for XCAPI.However, according to the local requirements and the VoIP environment, such preconfigurations needs additional adjustments which will be shown in the upcoming sections.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 11The newly created SIP trunk is now listed in the SIP networking overview as new remote sipnode entry.The XCAPI SIP trunk/node is here used with the preconfigured defaults.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.2.1Page 12PISN UserThe XCAPI related PISN user is used as shown on the next screenshot. For Softfax (G.711fax pass through), Fax over VoIP (G.711) must be selected as Fax device. Additional Softfaxinformation are given in the chapter Softfax (G.711 fax pass through) starting on page 18.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.3Page 13DDI PlanEnsure that the DDI plans and delivered numbers and matchings will be made up to the localrequirements. As showcase the DDI number range is here used from 400 to 410 with someDialing in number variations and related to the Call distribution elements (CDE).The DDI numbering range and single DDI numbers were added as shown below.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.4Page 14Call DistributionThe call distribution gives the overview of the configured DDI numbering plan relations.3.5Routing Graphical ViewThe incoming and outgoing numbering plan relations are used as shown next.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.6Page 15Network InterfacesThe XCAPI related network interface is used as shown next. Please note that enabling Use’ ’ as international prefix requires XCAPI controller adjustments which are not shown in thisdocument. PRACK support (RFC 3262) is not supported by XCAPI and thus has to be disabled.Nat and Authentication is not used at all here. The Audio settings are used with the givendefaults. The Transport protocol is used with the default (UDP).www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.7Page 16Trunk GroupsThe XCAPI related trunk group is used as shown below.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R53.8Page 17RouteThe XCAPI related route entry is used as shown below.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 18Configuration NotesIn these chapters you’ll find some configuration hints and settings for supplementary servicessuch as Softfax (via G.711), message waiting indication or call transfer. Such services areenabled by default to the XCAPI controller configuration. Nevertheless they should bereviewed just as the according gateway parameters for appropriate interworking.4.1Softfax (G.711 fax pass through)With the Softfax mode, the XCAPI simulates an analogue Fax device by transmitting modulatedFax-signals modem-like through the established G.711 audio channels. For enabling Softfax(G.711 fax pass through) it has to be set as Fax Method as shown next.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R54.2Page 19Message Waiting IndicationFor enabling message waiting indications, please ensure that the SIP NOTIFY method is setwithin the XCAPI controller configuration. It’s recommended to check if MWI is operable withall the different SIP devices (SIP phone and SIP extensions) that are connected to the MitelMiVoice Office 400.4.3Call TransferThe Simulated ECT by call-tromboning (line-interconnect) parameter within the XCAPIcontroller Features tab must be disabled for allowing call transfer via SIP REFER.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R54.4Page 20Redirection NumberSeveral CAPI applications need to receive a redirection number, in meaning of the gatewaygenerated SIP diversion header, beside of the origins calling number. Please ensure thataccording parameters are set, such as Send redirecting information of the SIP node, as shownin the chapter Private SIP Networking starting on page 10. If required, you can also adjust theXCAPI controller’s Diversion Handling.Ensure that the XCAPI related trunk group feature parameter Send redirection/redirectinginformation is enabled as shown in the chapter Trunk Groups starting on page 16.www.xcapi.deTelefon 49 5363 8195-0Fax 49 5363 8195-999
Mitel MiVoice Office 400 - R5Page 21Exclusion of LiabilityCopyright 2017 TE-SYSTEMS GmbHAll rights reservedThis document, in part or in its entirety, may not be reproduced in any form without the prior consent of TE-SYSTEMS GmbH.The information contained in this document was correct at the time of writing. TE-SYSTEMS GmbH reserves the right to make anyalterations without prior notice.The utmost care was applied during the compilation of texts and images, as well as during the creation of the software. Nevertheless,no responsibility can be taken for the content being accurate, up to date or complete, nor for the efficient or error-free operationof the software for a particular purpose. Therefore, TE-SYSTEMS GmbH cannot be held liable for any damages resulting directly orindirectly from the use of this document.TrademarksAll names of products or services used are trademarks or registered trademarks (also without specified indication) of the respectiveprivate or legal persons and are therefore subject to legal regulations.Third Party Disclaimer and LimitationsThis product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)This product includes cryptographic software written by Eric Young ([email protected]).This product includes software written by Tim Hudson ([email protected]).This product includes source code derived from the RSA Data Security, Inc. MD2, MD4 and MD5 Message Digest Algorithms.This product includes source code derived from the RFC 4634 Secure Hash Algorithm software.Copyright-NoticesAll files included in this sample are copyrighted by TE-SYSTEMS GmbH.All samples and the SDK may only be used in combination with the XCAPI-product.The SDK contains code from libtiff with the following copyright-notice:Copyright (c) 1988-1997 Sam LefflerCopyright (c) 1991-1997 Silicon Graphics, Inc.Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted withoutfee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the softwarewithout the specific, prior written permission of Sam Leffler and Silicon Graphics.THE SOFTWARE IS PROVIDED „AS-IS“ AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIALDAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOTADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USEOR PERFORMANCE OF THIS SOFTWARE.TE-SYSTEMS GmbHManaging Directors Andreas GeigerOliver KörberAddress Max-von-Laue-Weg 19D-38448 WolfsburgGermanyTel. 49 5363 8195-0Fax 49 5363 8195-999E-Mail [email protected] www.te-systems.dewww.xcapi.dewww.xcapi.deTelefon 49536353638195-08195-0phone 49Fax 49536353638195-9998195-999fax 49
www.xcapi.de Telefon 49 5363 8195-0 Fax 49 5363 8195-999 MitelMiVoiceOffice400-R5 Page3 2.1 TypeofController On the first page of the controller
