XCAPI H.323 TechNote

TechNote
XCAPI H.323 TechNote
Configuring the XCAPI with the
Avaya Communication Manager
TE-SYSTEMS GmbH
On the first dialog of the Controller Wizard please
select the Add Voice-over-IP controller (VoIP) option and
continue by clicking on the NEXT button.
1 Introduction
This document is intended to support you with the
integration of the XCAPI version 3.3.71 into an existing
environment of the Avaya Communication Manager.
Though being based on release 5.0 of the Avaya
Communication Manager it should be applicable
to other Communication Manager and Media Gateway
versions, given a few adjustments.
This TechNote is device-based on a G450 MEDIA
GATEWAY (FW Version/HW Vintage: 28.17.0/1)
providing a S8300 (ICC MM, DSP TypeMP20, FW/HW
version 12/2) and MM710 (DS1 MM) module.
In the following sections we describe the essential
steps of configuration to allow for optimal cooperation
of both the XCAPI and the Avaya Communication
Manager by using the H.323 protocol stack.
At this point we suppose that the Avaya
Communication Manager, the hardware the XCAPI is
running on and 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 Website.
2 XCAPI Configuration
Please start up the XCAPI configuration to create a
new controller which will be assigned to the Avaya
Communication Manager.
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. For starting up the XCAPI Controller
Wizard on your own, just click the hyperlink labeled
Click here to add a controller on the main page of the
XCAPI configuration.
2.1 Network Interface
On this page of the XCAPI Controller Wizard you can
select the network adapter you want to bind to the
XCAPI controller.
2.2 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 Avaya Communication Manager option
here.

2.3 IP Address of the
Avaya Communication Manager
In the dialog Avaya Communication Manager please
provide the IP address of your gateway.
2.5 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.
2.4 Description and Channels
That’s about all information that has to be configured
with the XCAPI. The next-to-final dialog of the
Controller Wizard allows you to configure 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
provide. The maximum of available channels for VoIP
trunking depends on your purchased XCAPI and ACM
license files.
The controller you’ve just created now will appear
on the main page of the XCAPI configuration.
As we’re now finished with all XCAPI-related
configuration tasks, please save the changes you’ve
made and exit the configuration tool.
Hint: You need to restart the bound CAPI
applications and/or their running services to
take effect on any controller changes.
– 2 –

3 Configuring the
Avaya Communication Manager
In this configuration example we’ll use the AVAYA
SITE ADMINISTRATION - ACM G450 EMULATION: 531
service to access the ACM device.
Depending on your configuration by other means of
accessing it, such as SECURE SHELL connections might
be available. The communication manager offers a
command-line interface (CLI) which we assume some
general familiarity with. If there are doubts, please refer
to the relevant ACM guides.
3.1 IP Node Names
The Node-Names IP dialog is used for administering the
node names and their interworking IP addresses of the
switch and media processors.
The screenshot below shows that the IP node for the
XCAPI is assigned to the application server with the IP
address 192.168.1.222.
The Processor Ethernet interface node name (procr)
is properly assigned with IP address 192.168.1.126.
The according IP-Interface and IP-Network-Region
configuration setup won’t be shown detailed here at
all.
– 3 –

3.2 Signaling Groups
The signaling group dialog is used to specify various
signaling parameters coming into operation for the
related trunk group(s), see chapter Trunk Group starting
on page 6.
The screenshots in this chapter show the used ISDN
signaling group parameters, see signaling-group 1, for
the primary rate interface (PRI) and the H.323 signaling
parameters, see signaling-group 64, used for the XCAPI
trunk.
The ISDN signaling group, which should be already
properly configured for your environment, is here used
with the following configuration setup:
• As this signaling group is related to the ISDN
primary rate interface (PRI) the Group Type is set
to isdn-pri.
• The Associated Signaling?
default value y.
flag is used with its
• The Primary D-Channel is related to one of the
trunk group member assigned port, for this
example port 001V216.
• The Call Associated and Non Call Associate
Temporary Signaling Connections (NCA TSC),
in meaning of the Max number of NCA/CA
TSC parameter, must be adjusted to your
communication manager environment.
• The Trunk Group for Channel Selection is, however,
set to 1.
• TSC Supplementary Service Protocol is set b for
using the ISO QSIG protocol.
– 4 –

The H.323 signaling group is used, beside of some
not mentioned parameters with their default values,
with the following configuration setup:
• The Group Type, as this is the desired
communication protocol for ACM and XCAPI
interworking is set to the h.323 protocol.
• The Max number of CA/NCA TSC values
specifies how many signaling connections for
supplementary services can be established. Even
for large systems a value of 30 should be
sufficient but might be configured upon your
needs.
• The Trunk Group for Channel Selection is set to the
trunk group number 64.
• The TSC Supplementary Service Protocol is set to
option b, which respectively stands for the ISO
QSIG protocol.
• The Near-end Node Name is assigned to procr
listening to the Near-end Listen Port number 6400.
Here we didn’t use the standard port 1720
because there might listen already other nodes or
trunks to.
Please note that you have to assign the correct
port also to the XCAPI controller gateway
configuration, as described in the chapter XCAPI
Gateway Settings on page 22.
• The XCAPIs Far-end Node Name is, obviously,
named to XCAPI.
The according Far-end Listen Port is used with port
number 1720.
• The Far-end Network Region is assigned to the IP
network region number 1.
• The DTMF over IP signaling method is used with
the default out-of-band method.
• The Direct IP-IP Audio Connections?, valued y, and
the IP Audio Hairpinning?, valued n, are both used
with their default settings.
• The H.323 Outgoing Direct Media?
used with its default value n.
parameter is
• For the Interworking Message parameter you need
to specify the right selection, here, however, we
used the ALERTing option, as this is used when a
DS1 is connected to the public network and it is
determined that callers hear silence (rather than
ringback or busy tone) when a call incoming over
the DS1 interworks to a non-ISDN trunk.
• The parameter DCP/Analog Bearer Capability is
also used with its default value 3.1kHz.
– 5 –

3.3 Trunk Groups
The Trunk Group dialog is used for trunk-related
parameter configurations and their port assignments.
This chapter describes the most important parameters
for setting up an XCAPI-related H.323 trunk.
The ISDN trunk configuration, which is used for this
TechNotes configuration setup, will be also shown but
not described in its details.
3.3.1 H.323 Trunk Group
The H.323 trunk group configuration is used, beside of
some not mentioned parameters, with its default values
as described below:
• The H.323 trunk, which corresponds between the
ACM and the XCAPI, is for this example created
on Group Number 64 and used with the unique and
meaningful Group Name called XCAPI.
• The isdn Group Type specifies using a digital
trunk, in meaning of voice and data services,
which provides the necessary bandwidth for its
according applications. The Carrier Medium for
this trunk group is set to H.323.
• According to your Class of Restrictions (COR) and
Facility Restriction Levels (FRLs) configurations
you need to assign the relevant COR for this
H.323 trunk. As seen on the screenshot, for this
example the COR number 1 is used.
• The Trunk Access Code (TAC) is set to *64.
• The Direction parameter is set to two-way for
allowing network call redirections.
• The Outgoing Display? parameter is set to option
y, which allows telephones to display the name
and the number of the trunk group.
Here you might select value n for displaying only
the digits the caller dials.
• The Dial Access? parameter is set to y to allow
users route outgoing calls through a trunk group
by dialing its trunk access code.
• The Service Type is used with the tie option.
• The Member Assignment Method parameter is used
with its default value manual.
– 6 –

3.3.2 Trunk Parameters
The Trunk Parameters of the here described H.323 Trunk
Group is used with the following settings:
• The Supplementary Services parameter needs to
be set to option b in order to support QSIG.
This, of course, only needs to be set when using
supplementary services from within your CAPI
application.
• For this example, the Disconnect Supervision In?
parameter is set to y, thus allows trunk-to-trunk
transfer involving trunks in this group.
This field and the Trunk-to-Trunk Transfer
parameter of the Feature-Related System Parameters
dialog must be set to y.
The Disconnect Supervision Out? parameter is left
by its default value n.
– 7 –

3.3.3 Trunk Features
The Trunk Features of the here described H.323 Trunk
Group is used with the following settings:
• The NCA-TSC Trunk Member, is set to value 1 and
needs to be adjusted upon your needs.
• The Send Calling Number parameter is set to value
y for interworking with the ISDN Numbering
- Public/Unknown Format or ISDN Numbering -
Private screen settings.
• As the Send Calling Number parameter is enabled,
it’s necessary to specify a Format parameter.
Here the option unk-pvt is used which determines
the Type of Number from the Numbering - Private
Format screen but the Numbering Plan Indicator
(NPI) is unknown.
• As the QSIG Value-Added parameter is enabled,
see next chapter QSIG Trunk Group Options, it’s
necessary to specify a Send Called/Busy/Connected
Number parameter. Here the value y is selected,
which indicates that the ISDN Numbering -
Public/Unknown Format and/or ISDN Numbering
- Private dialog is used. It must be enabled
when the Calling Party Number of an incoming
ISDN call has to be displayed at the transferred-to
station after a QSIG transfer operation.
– 8 –

3.3.4 QSIG Trunk Group Options
Beside of the default values of this configuration screen,
the settings are used as follows:
• The Path Replacement Method is set to always,
for using any QSIG (SBS) trunk group as the
replacement trunk group.
• The SBS parameter (Separation of Bearer and
Signaling) is used with its default value n.
• The QSIG Value-Added?, as mentioned in the
chapter Trunk Features before, is enabled by value
y which provides QSIG-VALU services.
• The QSIG-Value Coverage Encoding parameter is
used with its proprietary default value, which
provides extension information in the normal
manner.
3.3.5 Trunk Group Member Assignments
Within the Trunk Group Member Assignments dialog you
need to setup an amount of members, in meaning of
ports/channels, according to this H.323 trunk group.
A trunk group offers configuring a number of
so called ports which can be assigned to different
signaling groups. For this example 8 ports were
assigned by entering the value IP as signaling group,
which becomes automatically related to the free port
addresses after saving the Trunk Group configuration.
Each entry is assigned to the according Signaling Group
(Sig Grp) number 64, as described in the chapter
Signaling Group starting on page 4.
– 9 –

3.3.6 ISDN Trunk Group
The ISDN Trunk Group settings for this example are
used as shown on screenshot below.
– 10 –

3.4 Route Patterns
Each route pattern contains one or several trunk groups
that can be used for routing calls. You may have to
insert or delete some digits for routing AAR or ARS calls
over different trunk groups, or need to convert an AAR
number to an international number with the Numbering
Format parameter for your numbering plan.
For this example route-pattern 1 is used with its
default values and was assigned to the properly
operating ISDN trunk group (Grp No) 1.
The Facility Restriction Level (FRL) is set to level
1, which is also used for the forthcoming described
XCAPI route pattern.
The CA-TSC Request parameter is used with option
as-needed. This is the Avaya recommended entry for
most situations. The Numbering Format parameter is
set to unk-unk, which specifies the unknown-unknown
format of the routing number used for the trunk group
for this preference.
– 11 –

3.5 Incoming Call Handling
With the Incoming Call Handling Treatment dialog, you
can configure unique call treatments for different
incoming calls on any ISDN trunk group.
This chapter is not essential for setting up
the XCAPI-related H.323 trunking, but shortly
described for giving an overview of this example
used numbering and the call handling. Here, the
inc-call-handling-trmt trunk-group 1
is used with a called length, see parameter Called Len,
of 6 digits. This describes the number of digits received
for an incoming call, which consist of the following
three parts.
The local Called Number 450 specifies the leading
digits received for an incoming call, which becomes
deleted again shortly after its detection by the
parameter Del valued with 3.
The Auto Alternate Routing (AAR) Access Code
number 6, as described in the chapter Feature Access
Codes (FAC) starting on page 12, is assigned to the
Feature Access Code (FAC) call type of the Dial Plan
Analysis, described in Dial Plan Analysis starting on
page 13.
The according Automatic Alternate Routing (AAR)
configuration, described on page 14, with the dial string
number 6 and a minimum and maximum digit length
of 3, shows that the calling range 600 to 699 is routed to
the XCAPI-H.323 Trunk.
3.6 Feature Access Codes (FAC)
The Feature Access Code (FAC) configuration dialog
assigns the dialed codes to the system features, which
in turn needs to be defined through the dial plan, as
described in the chapter
Dial Plan Analysis starting on page 13.
Here, the Auto Alternate Routing (AAR) Access Code
number 6 is used for accessing the XCAPI trunk and
the Auto Route Selection (ARS) - Access Code 1 numbered
with value 0 is used for accessing the public network.
– 12 –

3.7 Dial Plan Analysis
The Dial Plan Analysis Table configuration and the Dial
Plan Parameter settings define the system’s dial plan.
The analysis table determines the dialed strings,
their length and the according call type.
For this example the dialed string 0, in meaning of
the access code for the public network, and the dialed
string 6, in meaning of the access code for the H.323
trunk of the XCAPI, are both set to the call type Feature
Access Code (FAC).
The Dialplan Parameters are used with their default
settings as shown on screenshot below.
3.8 Uniform Dial Plan
This Uniform Dial Plan, which has to be enabled in
the System Parameters Customer-Options (Optional
Features), is used as shown on the screenshot below.
If you have any doubts here, please refer to according
chapters of the Feature Description and Implementation for
Avaya Communication Manager and Administrator Guide
for Avaya Communication Manager Documents.
– 13 –

3.9 Automatic Alternate Routing (AAR)
In this example, all dialed matching numbers from 600
to 699 will be routed to the XCAPI with their bound
CAPI application. This is realized, as seen on the next
screenshot, by setting up the Dialed String number 6
and using value 3 for the minimum (Min) and maximum
(Max) parameters. The according Route Pattern is set to
number 64 and the Call Type parameter is assigned to
the AAR.
The Digit Conversion Table is generally used for more
efficient routing. This is not relevant for the here
described H.323 Trunking at all and just shown to see
this configuration setup as a whole. Here, we use the
Matching Pattern 0 which becomes assigned to the ARS.
– 14 –

3.10 Private Numbering
Configuring Private Numbering Plans allows specifying
the digits to be put in the Calling Number information
element (IE), the Connected Number IE, and the QSIG
Party Number for extensions in the Private Numbering
Plan.
Thus enables properly interworking of services such
as path replacement, see chapter Path Replacement on
page 20, and message waiting indications as described
in the chapter Message Waiting indications on
page 20 or transferring redirection numbers, see chapter
Redirection Number on page 20.
3.11 Class of Restrictions (COR)
Class of Restrictions (COR) control call originations and
terminations. This setup needs only one single COR
for covering the calling privileges. Thus, none calling
or called party restrictions are used here, which surely
needs to be adjusted for your setup.
For this configuration setup the COR number 1
is used with Facility Restriction Level (FRL) 1, which
becomes utilized by the AAR and/or ARS features for
call access determination to an outgoing trunk group.
Both, the Calling and Called Party Restrictions aren’t set
and respectively used with option none.
– 15 –

3.12 Class of Services (COS)
The Class of Services dialog is used for administering
access permissions of the station call processing
features. Here, you might have to modify some
parameters for enabling the desired services.
– 16 –

3.13 IP Codec Set
The IP Codec Set configuration determines the codec
types and their related parameters for voice streaming
and facsimile transmissions.
For this setup the IP codec set number 1 is used with
the G.711MU audio codec, no Silence Suppression and a
Packet Size of 20 milliseconds which is equivalent to 2
Frames Per Pkt.
On the second page of the IP Codec Set dialog,
some advanced configuration settings for facsimile and
signaling behaviors can be made.
Please review the chapter Fax Services starting on
page 21, for a more detailed description.
For this example the codec setup, beside of the not
mentioned default settings, is used as follows:
• The FAX mode is set to off with a Redundancy level
of 0 for using the software fax method, see chapter
Software Fax on page 21.
– 17 –

3.14 Feature-Related System Parameters
The Feature-Related System Parameters implements
system parameters associated with various system
features, which are used as described below:
• The PARAMETERS FOR CREATING QSIG
SELECTION NUMBERS is set to Network Level
number 0 and used with no assigned Level 1 or
Level 2 code.
• The parameter Send Non-ISDN Trunk Group Name
as Connected Name? is enabled with option y
which allows sending a name of the non-ISDN
trunk group as the connected name when a call
routes from ISDN to non-ISDN and the call is
answered.
• The Display Connected Name/Number for ISDN
DCS Calls? parameter is enabled with y which
allows displaying the received connected name or
number for ISDN DCS calls.
• The Send ISDN Trunk Group Name on Tandem Calls?
parameter is also used enabled with option y,
which provides consistent display information, in
meaning of the trunk group name, regardless of
trunk type.
• The Send Custom Messages Through QSIG?
parameter is enabled with option y for providing
appropriate display information.
• The QSIG/ETSI TSC Extension is used with a
therefore unassigned value 199. This is a virtual
extension number, for QSIG Call Independent
Signaling Connections supporting both, ETSI and
QSIG temporary signaling connections.
• The MWI - Number of Digits Per Voice Mail
Subscriber parameter is set to 3 for providing an
indication of the number of digits per subscriber.
• The National CPN Prefix parameter is valued to
0 which applies as prefixes to national calling
numbers for display at receiving telephones.
• The International CPN Prefix parameter is set to 00
which applies as prefixes to international calling
numbers for display at receiving telephones.
• The Path Replacement with Measurements?
parameter is set to y for allowing QSIG path
replacement or DCS with Reroute to be attempted
on measured calls.
• The QSIG Path Replacement Extension parameter
is valued to 198 which is used as part of the
complete number sent in the Path Replacement
Propose message.
• The parameter Path Replace While in
Queue/Vectoring? is disabled with option n.
Here you might have to use option y to allow
Path Replacement after queue/vector processing
has started.
– 18 –

3.15 Stations
This chapter just shows the station configuration
dialog, which were used for this setup, of a 9620 client.
– 19 –

4 Supplementary Services
In this chapter we are going to describe some
basic configurations for supplementary services,
such as message waiting indications or path
replacement. Those services are signaled through VoIP
environments, respectively between the XCAPI and the
ACM, by the QSIG protocol family.
For full QSIG functionality, you must set the
Supplementary Service Protocol field on both the Trunk
Group and the Signaling Group screen to b (QSIG).
You must set this field to b, because some QSIG
features, such as QSIG Call Completion and QSIG
Message Waiting Indication, use QSIG feature signaling
on both the bearer call and on an NCA TSC to work
properly.
4.1 Message Waiting Indication
If you wish to use the Message Waiting Indication
supplementary service from within your CAPI
application, some further configuration is needed.
If you don’t need to use this feature you can freely skip
this section. For these configuration tasks to succeed
it’s a prerequisite that you have completed the QSIG
configuration tasks from the previous section.
These dialogs allow a great variety of settings. Here
we have only a closer look to the therefore described
MWI supplementary service, see chapter Feature-Related
System Parameters on page 18.
Here, the QSIG TSC Extension parameter valued 199
is used for specifying a phantom endpoint extension
for QSIG call independent signaling connections and
the MWI - Number of Digits Per Voice Mail Subscriber
parameter is set respectively to 3.
4.2 Path Replacement
The Avaya Communication Manager doesn’t really
support the Call Transfer supplementary service. What
it does support, is the QSIG Path Replacement
supplementary service, which pretty much has the
same effect on the outside, but different inner workings.
With the XCAPI and the ACM it’s possible to utilize
Path Replacement automatically, whenever your CAPI
application attempts to perform a call transfer.
If you want to enable this feature (on the XCAPIside
it’s enabled by default by the Controller Wizard),
please open the same dialog as in the previous section
by invoking the change system-parameters
features command and forwarding to appropriate
configuration screen.
For this example, as already described in the chapter
Feature-Related System Parameters on page 18, the QSIG
Path Replacement Extension parameter valued by 198 that
will be used as a part of the complete number sent in the
Path Replacement Propose message which also needs to
conform to the dial plan.
4.3 Redirection Number
Some CAPI applications need to receive a redirection
number beside the origin calling number, in meaning
of the calling number transmitted by the redirecting
station.
For this you have to select option unk-pvt for the
Format parameter of the Trunk Group Features dialog, as
described in the chapter Trunk Features on page 8.
– 20 –

5 Fax Services
In this chapter, we are going to describe the necessary
configuration for using Fax services. Please ensure that
the codecs with their related parameters are configured
in the right way.
5.1 Software Fax
With the software fax mode, the XCAPI simulates
an analogue Fax device by transmitting modulated
Fax-signals modem-like over the established audio
channels. To configure the software fax mode, please
open the XCAPI configuration utility and select in
the advanced configuration mode the H.323 controller
assigned to the gateway.
Open the configuration tab labeled Features.
Enable the SoftFax mode by setting the Always use
software fax over audio channels option and save the
changes to the XCAPI controller configuration.
Further you need to ensure that the according IP
codec set, as shown in the chapter IP Codec Set on
page 17, is used with the FAX Mode parameter OFF.
Software FAX transmissions are only supported when
using non-compressing voice codecs.
– 21 –

6 XCAPI Controller Settings
In this chapter we are going to review some XCAPIrelated
controller settings which should be set by
default, when using the XCAPI controller wizard and
selecting its Avaya Communication Mangager
Voice-over-IP environment.
The H.323 configuration tab determines the
tunneling of QSIG-related information.
The QSIG tunneling according to H.323 Annex M
option has to be disabled and the Non standard tunneling
via H.255.0 FACILITY information elements must be
enabled. The Transmitting direction must be set to option
H.255.0 FACILITY.
6.1 Controller Features
The Controller Features are set by default as shown on
the screenshot below.
6.2 QSIG Settings
Creating a H.323 controller with help of the
XCAPI Controller Wizard ensures setting up optimal
configuration flags by default. Next, we review the
most important QSIG settings of the H.323 XCAPI
controller. The option Enable QSIG/PSS-1 derived
supplementary services of the QSIG dialog must be set.
6.3 XCAPI Gateway Settings
Finally we review the gateway settings of the created
XCAPI H.323 controller. Here we set the port number
to 6400 as this was defined for the Near-end Listen Port
of the Processor Ethernet interface node name (procr), as
described in the chapter Signaling Groups on page 4.
This port is set by default, within the XCAPI and the
ACM configuration to 1720 and might differ from the
default value when it is already reserved by another
signaling group.
– 22 –

– 23 –

Copyright c○ by TE-SYSTEMS GmbH, Wolfsburg. All rights
reserved.
This document is property of TE-SYSTEMS GmbH and protected
by international copyright law.
TE-SYSTEMS GmbH does neither assume any liability or legal
responsibility nor any guarantee for this documents contents and its
context. Moreover, merchantability, fitness for a particular purpose
and accuracy and correctness in general cannot be guaranteed.
TE-SYSTEMS GmbH explicitly grants you the right to distribute,
to duplicate and to store this document, as long as its contents are
neither edited, modified nor used commercially in any way. Should
you desire to use this document in any other way, it’s mandatory that
you contact the copyright holder beforehand in written form.
All software and hardware terms mentioned in this manual are
registered trademarks and should be regarded as such.
– 24 –