Berocapi

From berofix - professional SIP gateway
Jump to: navigation, search

beroCAPI / FSC

beroCAPI is a pure software solution which enables you to use berofix Gateways and berofix Gateway cards with your existing CAPI 2.0 based applications such as:

  • Unified Messaging (UMS)
  • Interactive Voice Respondes(IVR)
  • Automatic Call Distribution (ACD)
  • Fax servers

beroCAPI is a standalone software product installed on your Windows system, which provides a CAPI Interface and maintains a LAN connection to the berofix device, using the standard ‘Voice over IP’ protocol stack SIP. Using beroCAPI gives you the freedom to use the advanced berofix Gateways instead of using propiatary ISDN Hardware. beroCAPI opens a way for you to use your existing CAPI application, lower operation and maintenance costs and use you all the advancements of a Virtual Enviroment.

Based on the beroCAPI the additional „Fax Services Connector“ (FSC) is available. The FSC enables sending and recieving of Faxes in a Windows environment using the Microsoft Fax Services, simply by printing out documents to the „Fax Printer“ of Windows.

beroCAPI and the beroCAPI FSC will be available as a software download and are licensed per channel (between 2-60 Channels ) foreach berofix device. This small Howto will show you how to install and configure a beroCAPI setup together with a berofix Gateway. The next figure will show you a small overview of our Test scenario:

Berocapi-overview.jpg



Requirement

The beroNet Gateway needs to have a firmware Version >= 2.2-sp2. Please find the newest beroNet Gateway firmware here:

Downloads

Download beroCAPI

You can download beroCAPI from our website:

http://www.beronet.com/downloads/berofix/berocapi/

It includes a 30-day trail licence which you can use to test beroCAPI with your application before you have to order a license.

Installing beroCAPI

beroCAPI is compatible with the following Windows System and has been prooven, others might work as well, but these are tested:

Server:
  • Windows Server 2008 and 2008 R2
  • Windows Server 2003 (SP1 and higher)
  • Windows 2000 Server (SP4 and higher, with KB975337)
Workstation:
  • Windows 7
  • Windows Vista
  • Windows XP (SP2 and higher)
  • Windows 2000 (SP4 and higher, with KB975337)
With:
  • Native support of x32 and x64 platforms
  • Designed for Virtualized Environments


After you have download the beroCAPI, we can proceed and install beroCAPI.

Berocapi-install 1.jpg



During the installation process the beroCAPI installer will let you install the Fax Service Connector also. Customers who want to use beroCAPI together with the Windows Fax Service and have an according license, need to check this Box. All others can skip this step.

Berocapi-install 2.jpg



Licensing beroCAPI

After you have successfully installed beroCAPI you can use it for a trial period of 30 days. After this period you need a license code to use beroCAPI. If you already have a license code you can go to the menupoint Licenses and press Add License on the ComISDN Configuration ManagerGUI, where you can enter the purchased license code as you can see in the next figure

ATTENTION! YOU HAVE TO REBOOT WINDOWS TWICE TO ACTIVATE THE LICENSE!


Berocapi-systemid.png


If you don't have a license code and want to order one, we need the following information to generate one:
  • berofix serial
  • beroCAPI system ID
  • Amount of concurrent Channels
The berofix serial can be obtained from the berofix GUI by going to the menupoint Mangement->Info" as you can see in the next figure.

Berocapi-serial.png


The beroCAPI system ID can be obtained by going to the menupoint Licenses and press Add License on the ComISDN Configuration ManagerGUI as you can see in the first picture of this chapter.
With these two serialnumbers and the amount of concurrent Channels you can send your order to sales@beroNet.com or visit our online Shop at http://shop.beroNet.com

Configuration beroCAPI

After you have successfully installed the beroCAPI, you can go ahead and configure it. There are 3 steps you have to do

  • Licensing beroCAPI
  • Configuration of the beroCAPI
  • Configuration of the beroNet VoIP Gateway

These steps will be described in detail in the following Chapters

Configure beroCAPI

After installing beroCAPI on your PC, it will provide a CAPI2.0 interface for your 3rd party CAPI Application. The communication between the beroCAPI and the berofix gateway is established via SIP over your IP-Network. Therfore we need to configure the SIP connectivity between the beroCAPI and the berofix gateway.
Go to the menupoint Network and Accounts (Netzwerk / Kontos) as you can see in the next figure to configure the SIP related stuff:


Berocapi-SIP 1.jpg


  • SIP-Konto verwenden / Activate SIP Account has to be checked
  • Benutzername / Username SIP Authname for instance berocapi
  • Kennwort / Password SIP Passowrd for instance berocapi
  • Domäne / Domain the IP-address of the berofix for instance 172.20.8.10:5060


It is recommended to change the SIP standard listining port 5060 of the beroCAPI to avoid a conflict with other programs which might run in the background and block this port. Go to the TAB NAT/Firewall and change the Host-Address as you can see in the next figure. After you have made the changes press the close button of the Window (top right) and confirm the changes in the next Popup. Please don't use button "activate configuration" only use the close button of the window on the top right. Otherwise the changes will not be applied.

Berocapi-SIP 2.jpg


The 172.20.8.100 is the IP-Address of computer running beroCAPI and the :5061 tells beroCAPI to listen for inbound SIP traffic on Port 5061. You might need to choose a different port in case 5061 is in use. You can check this with the command line tool netstat if the port you want to use is already blocked with the following command:
  • netstat -ano | find "5061"



Configuration beroNet VoIP Gateway

Configure beroNet Gateway

After you have configured the SIP connectivity for the beroCAPI, go ahead and configure the beroNet gateway with according settings. First step you have to configure is the SIP trunk. In our example the beroNet gateway has the IP address 172.20.8.10. Open your favorite web browser and login to the beroNet gateway (default user/password is admin/admin). If you haven't done any configurations on the beroNet gateway, a green "Easy Configuration Wizard" will appear on the screen as you can see in the next figure. If you don't see this button you have to go to the menu point Management+-> Reboot/Reset, where you will find the Wizard. This Wizard will guide you to the rest of the configuration process.



Easy config wizard.jpg


1.Choose your scenario
The 'Easy Configuration wizard will first ask for the scenario, where you have 3 option. In our case the scenario Gateway will most fit to our example, so we are going to choose this.



Wizard1.jpg


2.SIP Connectivity
In the next step the wizard would ask for the SIP credentials as you can see in the next figure.



Capi wiz1.jpg


  • Name: beroCAPI' -name of this SIP account. You can choose any name in our case we set this to beroCAPI
  • Server Address:172.20.8.100:5061' -the IP address of the PC where beroCAPI is installed. Optionally specify also the SIP Port (:5061)
  • User: berocapi' -the authentication username
  • Secret: berocapi' -the authentication password
Keep in mind if you want to manually configure the SIP Trunk between the beroNet gateway and the beroCAPI, that the beroNet gateway should not register to the beroCAPI. So please let the "Register" flag unchecked.
Note: Please double check, if your beroCAPI is listening on a different SIP port then 5060, please exclude this specific port in the RTP port range. You can find the RTP port range under SIP+ -> SIP General. For instance if beroCAPI is listening on port 5062, then exclude this port from the RTP Port range as described in the next picture.
Rtp-portrange.jpg


3.PSTN Technology
Depending on the module configuration of your beroNet gateway, select your outgoing PSTN technology.
  • PRI -primary rate interface (E1 / S2M)
  • BRI -basic rate interface (S0 / ISDN)
  • FXO -foreign exchange office (to connect to analog lines)
  • FXS -foreign exchange station (to connect analog phones)
  • GSM -to connect to GSM networks


4.PSTN Settings
In our example we want to connect BRI Port 1 (Protocol: PMP) to our ISDN provider. We choose BRI as technology and create a group including port 1 and use 'TE_PMP' as 'Group Name' as you can see in the next figure.


Capi wiz2.jpg


5.Validating Settings
The last page of the wizard would show you a summary of all settings. After validating the settings press 'Finish' to confirm them. After that the beroNet gateway have to reboot.
Note:Using the Wizard will overwrite all previous settings.


6.Adjusting Settings
  • Inbound Call with hidden CallerID
Inbound Call with hidden CallerID are responsible for an empty "SIP From User Field". This causes interoperability problem between the gateway and the beroCAPI. To avoid that we have to replace empty CallerID with for instance a string like unknown. On the beroNet gateway this can be solved with the CLIR_ON_OAD Field. You will find this will under the more button of the PSTN port groups, in our case TE_PTMP as you can see in the next figure:
CLIROAD.jpg


  • Customers in AT and Switzerland
Due to some slight ISDN country difference in AT and CH regarding the signaling of the CalledID, we can get an empty "SIP To User Field". This causes interoperability problem between the gateway and the beroCAPI. To avoid that we have to replace empty CalledID with for instance a string like unknown. On the beroNet gateway this can be solved with an additional Dialplan rule. Be aware that this Dialplan rule is in the priority above the general one (Row 2 and 3). Please have a look to the next figure
CLIRDAD.jpg


  • Fax settings
If you using beroCAPI together with Faxes it is important to know that some older Fax machines or Fax splitter, detecting Faxes based on the ISDN Bearer Capability 3.1khz Audio. By default the beroNet gateway sends all outgoing call regardless if it is a Fax or Voice call with the bearer Capability speech. To change this go to the beroNet gateway GUI, menu PSTN+ and select the ISDN Portgroup (in our case TE_PMP) and choose "more". Change Bearer to AUDIO_3_1_k as described in the next figure.
Capi bearer.jpg


Also this might be useful to you: Howto use Berofix with GFI Faxmaker 2013.

FAQ

When i send a Fax over beroCapi, the other End receives a Header that overwrites the Header of my Faxserver.

This happens with GFI Faxmaker and the Tobit Faxserver. You can disable the beroCapi header by using Regedit to edit:

HKEY_LOCAL_MACHINE\SOFTWARE\Comisdn\TSP\CSP\VoIP

There you must add a REG_DWORD:

T38_T30_HeadLine

and give it the Value "1" ( = Disabled)

Can't change the SIP listening port

After you have changed the listening port over the menu Network->Net/Firewall in the field Host Address like 172.20.8.10:5070 (where :5070 is the new listening port), you have to close the window and confirm the settings in the next popup.

Send or received Faxes are not complete

Inbound faxing does not work