OpenScape Business

CTI (CSTA)

Attention

According to Unify, a connection of CSTA with open numbering is not released.

System architecture

The OpenScape Business system is connected via the CSTA interface using a special component of the PBX system, the CSTA service provider. This service provider is operated on an independent machine in the OpenScape Business V2 hardware. Two different variants are possible:

OpenScape Business V2 hardware (mainboard)

1. Using the UC Booster Card OCAB (OpenScape Application Board). This involves a circuit board inserted in the OpenScape Business assembly frame where it is also supplied with power.

2. Using the UC Booster Server. This variant is available as an independent software package which can be installed on its own PC hardware or a virtual computer.

Hint

If the V2 hardware is operated with V3 software, the same prerequisites mentioned above apply.

If this service provider is operated on the OpenScape Business V3 hardware on the mainboard. The following must be observed:

OpenScape Business V3 hardware (mainboard)

• A CSTA license is required to connect external CSTA services in OpenScape Business.

Architecture when using OpenScape Business S: (V2 hardware):

Architecture when using the Booster Server (V2):

Architecture when using OpenScape Business S:

Another variant involves connecting to an OpenScape Business network via the master node of an OpenScape Business S system, whereby connection is exclusively via the master node; the slave nodes do not require a CSTA interface.

Hint

Please note that such a system requires a unique private number plan throughout the network.

System requirements

OpenScape Business

• Software version V7 from version osbiz_v1_R2.0.0_028

• OpenScape Business X3/X5/X8 version osbiz_v1_R2.0.0_028 or higher, see also Unify release info.

• OpenScape Business Booster Card: See Unify release notes (only for V2 hardware (mainboard) of OpenScape Business)

• OpenScape Business Booster Server Version osbiz_v1_R1.1.0_204a or higher. (only for V2 software version of OpenScape Business).

As a general rule, the following product is required:

L30251-U600-A837 OpenScape Business UC Booster Server / S Software auf DVD (SLES11 SP2 64 Bit)

For installation on separate hardware and under vSphere (ESXi): See Unify release info.

Hint

CTI for networked systems with activated Open numbering is not supported at OpenScape Business!

Attention

Functional restrictions can arise when using OptiPoint end devices. Support for OptiPoint end devices has been discontinued by Unify. In certain constellations, calls can not be picked up using the XPhone Connect Client. And problems can also arise when ending or forwarding calls. Functions are available again once a newer end device is used for the same user.

Licenses:

OSBiz V2

The`` L30251-U600-A837 OpenScape Business UC Booster Server / S software on DVD (SLES11 SP2 64 bit`` referred to above includes the requisite licenses for operating the Booster Server (including operating system). A separate license is not required for the CSTA interface.

OSBiz V3

A separate CSTA license from V3 is required. The booster card and booster server are not required. The connection is made directly to the mainboard.

Expansion limits for CSTA:

The OpenScape Business CSTA interface supports max. 4 CSTA applications. One of these is intended as an interface for external CSTA applications (e.g. XPhone Connect Server). Other CSTA links are available when the following applications are NOT used:

• OpenScape Business UC Suite

• TAPI120

• DSS Server (only required for multi-node systems)

XPhone Connect Server

Supported from XPhone Connect Server V5.0

Configuring the PBX

Basic installation

• Run the basic set-up of OpenScape Business using the initial start-up wizard in Web-Based-Management (WBM).

• If you are using a Booster Card assembly (OCAB), put it into operation in accordance with the system documentation. Enter the assembly IP address under Application Board. If you are not using a Booster Card, please leave the IP address field blank.

• If you are using a Booster Server, please enter it in the corresponding wizard dialogue when selecting the application:

• Change into Expert mode and then Applications/Middleware. Enter the access parameters for the CSTA interface and activate the automatic CSP start. Note down the access data for later use in configuring the XPhone Connect Server. Use a password of sufficient length and complexity.

• This page also shows the CSP operating parameters (top right in the Statistics tab). This shows what applications are active. The Booster Server is displayed as UC Suite there and the XPhone Connect Server as Default.

• If the feature is to use Indirect Dial (One-Number Dialling, FMC_Function), the Transit feature must be activated in the OpenScape Business System:

XPhone Connect configuration

System settings > Telephony & Meetings > Telephony > CTI

Click new landline gateway in the table header. The Create new landline gateway dialogue opens:

PBX type:

Select Unify OpenScape Business (CSTA).

Name:

Enter a unique name here.

Dialling parameter:

Select a dialling parameter.

Deactivated:

Set this flag if this gateway is to be pre-configured but not activated.

Unify OpenScape Business (CSTA):

Host name or IP address:

• OSBiz V2: Enter the IP address of the Booster server or the Booster card (not the IP address of the OpenScape Business). The port specification refers to the configured port for the CSTA service (default: 8800).

• OSBiz V3: Enter the IP address of the OpenScape Business. The port specification refers to the configured port for the CSTA service (default: 8800).

Access parameters:

Enter the login name and password of the CSTA link. This data was stored under Applications/Middleware when setting up OpenScape Business.

System settings > Telephony & Meetings > Telephony > CTI > New Landline gateway

When the configuration is completed, click Save.

Diagnostics

You can find information on diagnostics here.

XPhone Connect Line configuration

System settings > Telephony & Meetings > Telephony > Lines

The corresponding lines and users must be set up and configured in the XPhone Connect Server.

Attention

In master/slave networked systems, all systems must be via CSTA connected to the XPhone server if EnableAgent is to be used in the Advanced settings of the line.

UM

System requirements

OpenScape Business

• Software version V7 from version osbiz_v1_R2.0.0_028

• Licence requirement: Networking license (Native-SIP-Trunking)

XCAPI

• from version 3.3.249a

XPhone Connect Server

• Supported from XPhone Connect Server V5.0

The XPhone Connect Server uses the middleware XCAPI for connection to the PBX system. No other solution that providing or using a CAPI interface (e.g. Fritz!) must be installed on the computer on which XCAPI is to be installed.

Hint

Voice or fax connections must not be made via linked PBX systems to external lines but must be connected to external ISDN lines via the node with which the XPhone Connect Server is connected to XCAPI.

An external line access via SIP trunks is currently not released.

The network transmitting the SIP connection to the PBX system must meet the general requirements for quality of service for transmitting voice or fax data (T.38 or fax via G.711). The following limitations in the functionality of the overall solution must be considered: SMS dial providers (V.120 or X.75) are not longer supported. Text messages must be sent via an HTTP gateway. Using the T.38 interface for fax transport is generally possible. However, this document only describes the soft fax variant since it proved to be extremely unproblematic in practice.

Number of channels:

The number of channels is limited by the DSP resources of OpenScape Business. There are 8 channels in the X8 system. Additional channels can be made available by using OCCB boards.

• 48 channels with OCCB1-Board

• 128 channels with OCCB3-Board

XCAPI configuration

1. Start the XCAPI setup programme (path on XPhone DVD Server3rdPartyxcapi) and install the application middleware. We recommend installing XCAPI before installing the XPhone Connect Server. Install XCAPI on the same computer where the XPhone UM services are installed (all solution components are generally installed on one machine). Make sure that no other CAPI products are installed on the target machine. The set-up assistant starts after the installation. Proceed with the following steps:

   

2. Unify OpenScape Business V1 is selected as PBX-Type:

   

3. Enter the name and number of channels:

   

4. Enter the host name or the IP address of the OpenScape business:

   

5. Select a network interface card:

   

6. Configure the port reservation, if necessary:

   

   and click Finish in the following mask to add the configuration to the new controller.

7. Licensing by XCAPI must follow installation. Operation without licenses is also possible. A maximum of 2 channels can be used in this case. Notification announcements are made during voice transmission and fax documents have a watermark. Perform licensing as follows:

   1. Make sure you have an activation code for XCAPI. This code is provided together with your XPhone Connect Server license certificate. If you do not have an activation code, contact your C4B solution partner. Alternatively, XCAPI can be run in demo mode with 2 channels.

   2. Have the MAC address of the machine on which XCAPI is installed ready. If you run XCAPI on a virtual system, you will need the so-called hardware ID. MAC address or hardware ID are read and generated with the XCAPI license assistant (see description below).

   3. Obtain a license file from TE-Systems with the data determined previously. TE-Systems

      • Import the delivered license file with the XCAPI license assistant. If the computer on which XCAPI is installed has an internet connection, an alternative “on demand” activation is possible. To run the XCAPI license assistant, start the XCAPI configuration in the start menu of the operating system (Start > All programmes > XCAPI > XCAPI configuration).

   4. Follow the assistant to activate the license. Make sure that the correct “Standard” view is selected. You can also determine the correct hardware ID or MAC address of your server using the assistant. You can recognise the hardware by the equal sign as the last digit:

   

8. Subsequently, make sure that the settings shown in the following screenshots are selected:

   

   

9. The XCAPI controller tweak NCS_SET_MODE_DELAY should be set to the value 100 (ms). It causes a small delay when switching (SIP clean) to fax. This delay does not affect voice-only connections. The XCAPI controller tweak PREFERRED_IDENTITY must be added and set to value 1:

10. Then install the XPhone Connect Server if you have not already done so. We recommend restarting your computer after the installation is completed.

Configuring the PBX - OSB V1

Voice Gateway

1. Start the Web-Based Management of the OpenScape Business as administrator with Expert role. Switch to Expert mode and there under Telephony > Voice gateway. Set the parameters according to the screenshots:

   

2. T.38 is activated here, since XCAPI is configured for Softfax:

   

3. Under Payload set the Fax parameters as shown:

   

4. Now set up the trunking to XCAPI under SIP connection. Select the trunk type Native SIP server trunk. As trunk ID- use SIP connection 1 or SIP connection 2 depending on which ID is not yet used elsewhere in the system. Make sure that this trunk ID is not already used by other trunk types (e.g. Application Suite or SIPQ Server trunk).

   Under Remote domain name and IP address, enter the IP address of the network card to which XCAPI has bound itself in XPhone UC Server. The port must correspond to the one entered in the XCAPI configuration under Hipath 3000 > SIP > Protocol > Local port for UDP/TCP:

   

5. Cross-checking of the parameters in the XCAPI configuration:

   

Lines

1. The connection between Openscape Business and the XPhone Connect Server is made via SIP trunks. In the Expert mode, open Telephone Lines > Networks: Name direction 11 in XCAPI and activate the block selection by selecting Block notes in the item Dialling transmission:

   

2. Set other direction parameters as shown:

   

3. Under Lines, open the category of the trunking type you entered before under Voice gateway/SIP connection/Native SIP Server trunk. This was SIP connection 2 in the example. If required, add new lines or delete redundant lines. Create twice as many lines as licensed in XCAPI:

   

4. For the trunks to be able to establish connections to the office, the transit permission must be activated:

   

Set up LCR

1. In LCR, routing of certain telephone number is specified for Directions. Activate this function. Keep in mind that this setting affects the entire system. Make sure that office accesses set up previously still function:

   

2. The example shows how the telephone number band -81XXX (extensions 81000 to 81999) and -82XXX is provided for Unified Messaging, e.g. for fax or voicemail boxes. You may need multiple routes (e.g. separately for fax and voicemail or one route for the central voicemail access number). All routes used the direction XCAPI, the dialling rule is always E1A, the procedure of the network provider is Corporate Network:

   

Attention

For each route set up here, a corresponding route must exist in the voice gateway.

3. If the same telephone number is set up for the place code as for the office access (this is normally “0”, see “System settings/Drop/VPL”), an additional route must be set up for access of the XCAPI-SIP trunk to the office. This is necessary because Openscape Business first searches for the dialling target of a SIP trunk in the extension number plan. If the extension “0” exists there, this target is called. It is important that a number combination is selected for office access that is not used as extension number and internal telephone number. In the example “999” was dialled.

4. We recommend to change the value for the minimum authorisation of a route from 15 to 1 if this is in agreement with the routing requirements of the client (office authorisations). Otherwise, connections may be blocked by the telephone system in some cases.

Message Waiting Indication

Hint

Please note that further settings are necessary for MWI in the XPhone Connect Server. More information can be found in the following chapters under XPhone Connect configuration in 4.

1. First, create a virtual participant with the web-based management.

   

2. Redirect the virtual participant to the telephone number, which you can use to call the voicemail function in the system (e.g. telephone number 139). This redirecting is via the function Associated services. For the given example, enter the following number sequences at an authorised device:

• *83 8839 *1 1 139

3. Now go the Hipath Manager E V10, since the callback access can not be administrated for phonemail with the web-based management. Make sure that the type of the virtual participant is set to a 5-digit phonemail port. Enter the telephone number of the phonemail port again under Connections/Phonemail.

4. We recommend switching off the display for info notifications so that MWI signalling is only via the lamp at the letter box button:

   

5. Finally, configure a button with the Mailbox function on the end devices.

Linked PBX systems

Keep in mind that operating linked systems is only possible in certain conditions:

• For fax operation: The fax data stream must not run through linked nodes. The data stream does not have to run directly from the XCAPI trunk to the ISDN central office of the same node.

• Calls to the voicemail system must either run directly from ISDN office of a node to the XCAPI trunk of the same node or must come from an internal extension that is connected to a linked node. The voice quality depends on a number of factors (QoS, latency periods, etc.), which cannot be influenced by XCAPI.

Configuring the PBX - OSB V2

Corresponding connection information can be found in the XCAPI documentation. Notes on the connection as follows:

1. Start the web-based management of Openscape Business as administrator with Expert role. Change into the Expert mode .

2. Set up the SIP trunk as described here and observe the following notes:

3. Do not forget to add a native SIP server trunk user for the native SIP trunk under Voice Gateway > Native SIP Server Trunk > Native SIP trunk > Add Native SIP Trunk User.

   • Otherwise, OSBiz will not respond to SIP Option messages and thus the SIP trunk will not go active.

4. If more than one SIP trunk is required in the direction of XPhone Connect Server, separate SIP ports must be assigned for each Native SIP trunk under, Voice Gateway > Native SIP Server Trunk > Native SIP trunk > Edit Native SIP Server Trunk > SIP Server.

   • Settings for the native SIP Trunk1 (XPhone Call Controller - XCC connection):

5. Settings for the native SIP trunk 2 (XCAPI connection):

6. Configuring the routing parameters:

7. LCR - dial plan configuration:

8. LCR - configuration of the routing

9. LCR - configuration of the dialing rules

10. Line overview

Hint

Make sure to set up Native SIP Trunks! A SIP Trunk under SIPQ Interconnection is not supported and is exclusively intended for Unify networks!

XPhone Connect configuration

The following special features should be noted:

1. The following special features must be observed:If the previously described trunk route was set up in the automatic route search (LCR), the code number must also be made in the UM Gateway settings. Note that a new entry LocalAccess must be created under Advanced Settings, which also contains the trunk code: System settings > Dialing parameter > Dialing parameter object > Advanced Settings

2. Only an HTTP gateway can be used as the SMS gateway, since SIP cannot transport protocols that can be used to operate a dialup provider. We recommend Any-SMS as the HTTP SMS provider. A registration can be done via the link http://www.any-sms.info/index.php?p=anmelden&pid=100920.

3. Control the type of call transfer for the voicemail feature Connect with representative: System settings > UM > Voicemail > General > Call-Transfer.

4. The Message Waiting Indication (MWI) function is executed via CTI interface. System settings > UM > Voicemail > MWI

5. Enter under System settings > Telephony & Meetings > Telephony > CTI > CTI Gateway Object > Advanced Settings the phone number of the phonemail port set in the OpenScape Business, as well as with the name PhonemailPort the central voicemail number:

6. Enter the parameter VMPClip under System settings > UM > Voicemail > General > Advanced settings and enter central voicemail number as value. This value defines the phone number that is transmitted for calls via the voicemail player service. The voicemail player service is required if, for example, a received voicemail is to be listened to via the callback function or if voicemail announcements are to be recorded via telephone.

• If no entry is made for VMPClip, Openscape Business rejects the call.

Diagnostics

Information on the subject of diagnosis can be found in the chapter: UM Troubleshooting and diagnostics.

XCC

The SIP gateway for the AnyDevice and conference service functions is configured completely independently of the SIP gateway for the UM functions.

The following sample setup was done on an OpenScape Business with the version: osbiz_v2_R0.3.0_119

Hint

You need a networking license (native SIP trunking) for the OpenScape Business.

Configuring the PBX

Line configuration

Create new lines in Expert mode (under Lines). For each AnyDevice call, two lines are required for the connection between PBX and XCC (e.g., 20 lines for ten simultaneous calls!). Therefore, when configuring lines, take into account lines that have already been set up so as not to exceed the limit of the PBX.

Establishment of direction XCC

Hint

A separate direction for the XCC must be defined under the heading Direction. Set the exchange code (2nd AKZ) = 0 , otherwise the incorrect call number will be displayed when making TeamDesk calls to a CTI telephone!

Now adjust the direction parameters:

Hint

The Always use DSP checkbox should only be used in exceptional situations. If, for example, the IP routing does not allow the endpoints to communicate directly with each other, you could tick this box in this case at the expense of the DSPs, provided that the customer has sufficient DSPs available. In general, C4B cannot make any recommendations here, as XPhone works with or without IP routing in the customer network.

Control of the lines

In the lines, check that the direction for the XCC has been assigned correctly:

SIP trunk configuration

A new Native SIP Server Trunk must be set up in expert mode under voice gateway:

1. Enter a name for the trunk.

2. Confirm the checkbox for Activate Trunk.

3. Trunk ID in the system: corresponds to the direction for the XCC.

4. Remote domain name: IP address of the XPhone Connect Server.

5. Transport protocol: UDP

6. IP adress / hostname: IP adresse of the XPhone Connect Servers.

7. Port: by default 5060 – If another port is defined in XPhone Connect, it must be entered here.

8. STUN is not used.

Set up LCR

In the LCR, the forwardings to the AnyDevice phone number or to the conference server must be defined. In this example, the phone number 581 was assigned for AnyDevice and the phone numbers 582-584 for the conference servers. This results in the following entry in the LCR:

Selection table 3 does not necessarily have to be used:

The standard dialing rule “MEB” can be used for connection to the XCC. The “E1A” dialing rule is hidden behind this.

Configuration completion

After setting up the SIP trunks on the OpenScape Business, it must be rebooted. After the reboot, the calls are sent from the OpenScape Business to the XPhone Connect server via the new SIP trunks. If the reboot is not performed, a “Busy” or “Currently not possible” is signaled in most cases.

Configuring XPhone Connect

Dialling parameter

Depending on the release version and configuration of the PBX, the following parameters may differ from the description. A new dialing parameter for the OpenScape Business XCC connection should be set up in the XPhone Connect dialing parameters.

Hint

In this case, the length of the internal phone number corresponds to the length of the AnyDevice or conference number.

System settings > Dialing parameter

SIP Gateway

Configure a new SIP gateway:

System settings > Telephony & Meetings > Telephony > SIP > SIP Gateway Objekt

Select the Unify OpenScape Business gateway type and assign a name. Now select the dialing parameter you created earlier.

Connection:

• Host name or IP address (local): XPhone Connect server address and defined SIP port (default 5060)

• Host name or IP address (Gateway): OpenScape Business address and defined SIP port (default 5060)

• CLIP No Screening:

  This parameter influences the display of the signaled phone number on voice terminals in connection with AnyDevice. The CLIP No Screening feature must have been enabled by the fixed network provider for the company and must be supported by your voice communication system. Your selection determines how the Calling Line Identification (CLI) is passed over SIP:

• Remote Party ID (see SIP Extensions for Caller Identity and Privacy)

• P-Asserted-Identity (see RFC 3325)

• Off: the phone number is not passed in any special SIP element.

AnyDevice:

Enter the configured number from the OpenScape Business LCR here: e.g. AnyDevice: 581

Conference:

Enter the configured numbers from the OpenScape Business LCR here and activate the conference service: e.g. Conference: 582 - 584

Advanced settings

The XccFromHeaderAsCLIP parameter solves the problem that, in the case of an AnyDevice FollowMe Call, the PBX’s own phone number appears as the caller in the call journal. This can be the case, for example, if the PBX transfers the wrong value in the Remote Party ID or P Asserted Identity header, as is currently the case with OpenScape Business. This display error is corrected on the XPhone Connect Server by using the From header of the first call leg as the CLIP.

In order for the parameter to take effect, the value True must be set for XccFromHeaderAsCLIP on the corresponding SIP gateway.

Have you found a mistake on this page?

Or is something not formulated well or too vague? Then we look forward to receiving an e-mail, preferably with a suggestion for improvement, to doku@c4b.de. Thank you very much!