Howto:XCAPI

2007-05-29T06:02:51Z

Oliverk: New page: ==Applies To== This information applies to * IP3000 Configuring the XCAPI with the innovaphone IP3000 == Introduction == This document is intended to support you with the integration o...

==Applies To==
This information applies to

* IP3000

Configuring the XCAPI with the innovaphone IP3000

== Introduction ==

This document is intended to support you with the integration of the XCAPI (version 3.2.20) into an existing environment of
the innovaphone IP3000 (Version 6). In the following sections we describe the essential steps of configuration to allow for optimal cooperation of both the XCAPI and the innovaphone PBX. At this point we suppose that the innovaphone PBX, the hardware the XCAPI is running on and both the XCAPI and your CAPI applications are already installed properly. For some extended information on installation procedures please refer to the respective manuals. A short installation manual for the XCAPI is available at the
XCAPI Homepage.

== Configuring the innovaphone PBX ==
In order to establish communications between the XCAPI and the innovaphone PBX using the H.323 protocol, you need to create a new controller inside the XCAPI and set up a connection to the XCAPI inside the innovaphone PBX. First, we start to configure the innovaphone PBX. Please open the web based innovaphone PBX configuration interface. The XCAPI can be configured as a PBX
object for assigning single MSNs or it can be configured as an external gateway, allowing the mapping of a route pattern with multiple extensions. In most cases, the second method should be preferred.

=== Configuring a VoIP Gateway ===
To add the XCAPI as a new gateway, you have to choose the Gateway dialog out of the Administration menu. If you haven’t logged in as administrator yet, you need to do now for accessing this configuration dialog. Now you can configure a new gateway in the VoIP
dialog. Click on an arbitrary '''GW Interface''' entry that is not configured yet. If you haven’t configured any gateway, please use GW1. A new window will open where you can configure the gateway settings. TechNote In this example we configure the new gateway as
described:

* The Name field should be set to a meaningful name. Here we enter the name XCAPI Gateway.
* Please make sure that the Disable option is not active.
* In the Protocol field we select the value H.323 as protocol for the communication between the XCAPI and the innovaphone PBX.
* The Gatekeeper Address (primary) field has to be filled with the IP address of the computer the XCAPI is running on.
* We recommend selecting a codec like G.711 a-Law or G.711 μ-Law for the internal communication between the XCAPI and the innovaphone PBX. Set both the General Coder Preference and the Local Network Coder to the appropriate codec that fits your VoIP environment. Set the Framesize ms of both codecs to the value of 20 ms. This is the default value for the XCAPI.
* Activate the Enable T.38 option for fax functionality.
* For best results, we recommend to activate the No Faststart and No H.245 tunneling options.

All other options that were not mentioned should be left by the default settings. Depending on your environment
some further settings could be necessary. Please refer the innovaphone PBX manual for detailed descriptions.
Finally, please click the '''APPLY''' button to add the new gateway to your innovaphone PBX configuration.
The IP address will be automatically assigned to the new added XCAPI Gateway after configuring the XCAPI.

=== Route Patterns ===
Please select the Routes dialog from the Administration - Gateway menu for configuring a route pattern. Here you
have to create one route for each direction, from ISDN to VoIP and the other way round.
We start with the route from the ISDN interface to the XCAPI. Please click the small icon with the arrow
pointing to the right. A new dialog will appear where you can set the route pattern and its direction. In the
Description field, you may enter a meaningful description for this route. In this example, we enter the value ISDN –> XCAPI Gateway.
From the list of checkboxes to the left, select the incoming interface, i.e. the interface from where the calls
for this route originate. We use the first PRI interface for the ISDN connection, so please activate the option PRI1.
The two text areas that are connected with an arrow are used for the route pattern. The left text area describes the incoming number, whereas the right text area describes the outgoing number that is delivered to the XCAPI. If, for example, the ISDN interface can be
reached using the trunk number ''123'' and you want to configure a pattern of numbers beginning with ''123100''
and ending with ''123199'', simply enter ''1231'' in both fields. If you would like to truncate the trunk number from
the route pattern, enter ''1231'' in the left field and ''1'' in the right field. This means that the route pattern can
be reached when dialling any number beginning with ''1231'', but only the part of the extension beginning with
the second ''1'' will be delivered to the XCAPI. From the list to the right, please select the Gateway
we have configured earlier (GW1 XCAPI Gateway).

Finally, confirm the settings with the '''APPLY''' button and close the window.

== XCAPI Configuration ==
Please start up the XCAPI configuration to create a new controller assigned to the innovaphone PBX. If you’ve just installed the XCAPI and start the configuration tool for the first time, the XCAPI Controller Wizard will pop up automatically. This will also happen if there’s no controller configured at all. To start up the XCAPI Controller Wizard on your own, just click the link labeled '''<u>Click here to add a controller</u>''' on the overview page of the XCAPI configuration tool. On the first page of the Controller Wizard please select the Add Voice-over-IP controller (VoIP) option and continue by clicking on the '''NEXT''' button.

Hint: You can best use the ControllerWizard by making the necessary adjustments in
the dialogs presented to you, using the '''NEXT''' and '''BACK''' buttons to navigate. When showing the relevant dialogs of the ControllerWizard
we won’t mention clicking '''NEXT''' to advance every time. Just assume you have to click '''NEXT''' after completing a dialog.

=== Network Interface ===
On this page of the XCAPI Controller Wizard you can select the network adapter you want to bind to the
XCAPI controller. Should you have any doubts here, please refer to the XCAPI Quick Start Guide for further details.

=== Voice-over-IP Environment ===
The next dialog of the configuration tool shows a list of some common Voice-over-IP environments. Selecting
one of those will configure the XCAPI with a selection of near-optimal presets for the kind of environment you
have, sparing you quite a lot of manual configuration. Please select the innovaphone option here.

=== IP address and gatekeeper ID ===
In this dialog you can provide the address of your innovaphone Gateway and enter a gatekeeper ID. Although it is recommended to let the system discover the IP address of the innovaphone device automatically you can provide the IP address of the innovaphone device and disable the automatic recovery. The gatekeeper ID may be left blank if you have provided the IP address of the innovaphone device or it is the only PBX (gatekeeper) in the network. In this example we disable the automatic recovery and provide the IP address of our innovaphone PBX device with the value ''192.168.1.205''. The left the innovaphone gatekeeper ID blank, as we use only one PBX
(Gatekeeper) in our environment.

=== Local telephone number and alias name ===
In this dialog you have to provide the telephone numberand the alias name that are configured at the innovaphone gateway. If no alias name is configured this field may be left blank. If an alias name is configured at the innovaphone PBX the alias name is required. In
this example we enter the value ''123'' in the Telephone number field that describes a six-digit long number so the XCAPI and the connected CAPI applications can be reached with the range of numbers between ''123000'' and ''123999''.

=== Description and Channels ===
That’s about all information that has to be configured with the XCAPI. The next-to-final dialog of the ControllerWizard
allows configuring a meaningful description for the controller you’re going to create. This isn’t really used anywhere, so you can enter a text of your choice here. This dialog, however, also allows configuring the
number of channels that the new controller will be able to provide. Please enter how many simultaneous connections
the XCAPI should handle when communicating with the PBX.

=== Confirmation ===
The final dialog of the Controller Wizard 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 the necessary input.
If everything is correct please use the '''FINISH''' button in order to finally create the new controller.
The controller you’ve just created now will appear on the overview page of the XCAPI configuration tool.
As we’re now finished with all XCAPI-related configuration tasks, please save the changes you’ve made
and exit the configuration tool.

== Related Articles ==



* http://www.xcapi.de
* http://www.te-systems.de

[[Category:Faq|{{PAGENAME}}]]

innovaphone wiki - User contributions [en]

Howto:XCAPI