XCAPI H.323 TechNote

Configuring the XCAPI with theAvaya Communication ManagerTE-SYSTEMS GmbH

1 Introduction

This document is intended to support you with theintegration of the XCAPI version 3.3.71 into an existingenvironment of the Avaya Communication Manager.

Though being based on release 5.0 of the AvayaCommunication Manager it should be applicableto other Communication Manager and Media Gatewayversions, given a few adjustments.

This TechNote is device-based on a G450 MEDIAGATEWAY (FW Version/HW Vintage: 28.17.0/1)providing a S8300 (ICC MM, DSP TypeMP20, FW/HWversion 12/2) and MM710 (DS1 MM) module.

In the following sections we describe the essentialsteps of configuration to allow for optimal coopera-tion of both the XCAPI and the Avaya CommunicationManager by using the H.323 protocol stack.

At this point we suppose that the AvayaCommunication Manager, the hardware the XCAPI isrunning on and the XCAPI and your CAPI applicationsare already installed properly. For some extendedinformation on installation procedures please refer tothe respective manuals.

A short installation manual for the XCAPI isavailable at the XCAPI Website.

2 XCAPI Configuration

Please start up the XCAPI configuration to create anew controller which will be assigned to the AvayaCommunication Manager.

If you’ve just installed the XCAPI and start theconfiguration tool for the first time, the XCAPIController Wizard will pop up automatically.

This will also happen if there’s no controllerconfigured at all. For starting up the XCAPI ControllerWizard on your own, just click the hyperlink labeledClick here to add a controller on the main page of theXCAPI configuration.

On the first dialog of the Controller Wizard pleaseselect the Add Voice-over-IP controller (VoIP) option andcontinue by clicking on the NEXT button.

2.1 Network Interface

On this page of the XCAPI Controller Wizard you canselect the network adapter you want to bind to theXCAPI controller.

2.2 Voice-over-IP Environment

The next dialog of the configuration tool shows a list ofsome common Voice-over-IP environments. Selectingone of those will configure the XCAPI with a selectionof near-optimal presets for the kind of environment youhave, sparing you quite a lot of manual configuration.Please select the Avaya Communication Manager optionhere.

TechNote

2.3 IP Address of theAvaya Communication Manager

In the dialog Avaya Communication Manager pleaseprovide the IP address of your gateway.

2.4 Description and Channels

That’s about all information that has to be configuredwith the XCAPI. The next-to-final dialog of theController Wizard allows you to configure a meaningfuldescription for the controller you’re going to create.This isn’t really used anywhere, so you can enter a textof your choice here.

This dialog, however, also allows configuring thenumber of channels that the new controller willprovide. The maximum of available channels for VoIPtrunking depends on your purchased XCAPI and ACMlicense files.

2.5 Confirmation

The final dialog of the Controller Wizard performssome checks on the configuration parameters you’vemade. If any errors are detected here, you can goback to the respective dialogs and correct the necessaryinput.

If everything is correct please use the FINISH buttonin order to finally create the new controller.

The controller you’ve just created now will appearon the main page of the XCAPI configuration.

As we’re now finished with all XCAPI-relatedconfiguration tasks, please save the changes you’vemade and exit the configuration tool.

Hint: You need to restart the bound CAPIapplications and/or their running services totake effect on any controller changes.

– 2 –

3 Configuring theAvaya Communication Manager

In this configuration example we’ll use the AVAYASITE ADMINISTRATION - ACM G450 EMULATION: 531service to access the ACM device.

Depending on your configuration by other means ofaccessing it, such as SECURE SHELL connections mightbe available. The communication manager offers acommand-line interface (CLI) which we assume somegeneral familiarity with. If there are doubts, please referto the relevant ACM guides.

3.1 IP Node Names

The Node-Names IP dialog is used for administering thenode names and their interworking IP addresses of theswitch and media processors.

The screenshot below shows that the IP node for theXCAPI is assigned to the application server with the IPaddress 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-Regionconfiguration setup won’t be shown detailed here atall.

– 3 –

3.2 Signaling Groups

The signaling group dialog is used to specify varioussignaling parameters coming into operation for therelated trunk group(s), see chapter Trunk Group startingon page 6.

The screenshots in this chapter show the used ISDNsignaling group parameters, see signaling-group 1, forthe primary rate interface (PRI) and the H.323 signalingparameters, see signaling-group 64, used for the XCAPItrunk.

The ISDN signaling group, which should be alreadyproperly configured for your environment, is here usedwith the following configuration setup:

• As this signaling group is related to the ISDNprimary rate interface (PRI) the Group Type is setto isdn-pri.

• The Associated Signaling? flag is used with itsdefault value y.

• The Primary D-Channel is related to one of thetrunk group member assigned port, for thisexample port 001V216.

• The Call Associated and Non Call AssociateTemporary Signaling Connections (NCA TSC),in meaning of the Max number of NCA/CATSC parameter, must be adjusted to yourcommunication manager environment.

• The Trunk Group for Channel Selection is, however,set to 1.

• TSC Supplementary Service Protocol is set b forusing the ISO QSIG protocol.

– 4 –

The H.323 signaling group is used, beside of somenot mentioned parameters with their default values,with the following configuration setup:

• The Group Type, as this is the desiredcommunication protocol for ACM and XCAPIinterworking is set to the h.323 protocol.

• The Max number of CA/NCA TSC valuesspecifies how many signaling connections forsupplementary services can be established. Evenfor large systems a value of 30 should besufficient but might be configured upon yourneeds.

• The Trunk Group for Channel Selection is set to thetrunk group number 64.

• The TSC Supplementary Service Protocol is set tooption b, which respectively stands for the ISOQSIG protocol.

• The Near-end Node Name is assigned to procrlistening to the Near-end Listen Port number 6400.

Here we didn’t use the standard port 1720because there might listen already other nodes ortrunks to.

Please note that you have to assign the correctport also to the XCAPI controller gateway

configuration, as described in the chapter XCAPIGateway Settings on page 22.

• The XCAPIs Far-end Node Name is, obviously,named to XCAPI.

The according Far-end Listen Port is used with portnumber 1720.

• The Far-end Network Region is assigned to the IPnetwork region number 1.

• The DTMF over IP signaling method is used withthe default out-of-band method.

• The Direct IP-IP Audio Connections?, valued y, andthe IP Audio Hairpinning?, valued n, are both usedwith their default settings.

• The H.323 Outgoing Direct Media? parameter isused with its default value n.

• For the Interworking Message parameter you needto specify the right selection, here, however, weused the ALERTing option, as this is used when aDS1 is connected to the public network and it isdetermined that callers hear silence (rather thanringback or busy tone) when a call incoming overthe DS1 interworks to a non-ISDN trunk.

• The parameter DCP/Analog Bearer Capability isalso used with its default value 3.1kHz.

– 5 –

3.3 Trunk Groups

The Trunk Group dialog is used for trunk-relatedparameter configurations and their port assignments.This chapter describes the most important parametersfor setting up an XCAPI-related H.323 trunk.

The ISDN trunk configuration, which is used for thisTechNotes configuration setup, will be also shown butnot described in its details.

3.3.1 H.323 Trunk Group

The H.323 trunk group configuration is used, beside ofsome not mentioned parameters, with its default valuesas described below:

• The H.323 trunk, which corresponds between theACM and the XCAPI, is for this example createdon Group Number 64 and used with the unique andmeaningful Group Name called XCAPI.

• The isdn Group Type specifies using a digitaltrunk, in meaning of voice and data services,which provides the necessary bandwidth for itsaccording applications. The Carrier Medium forthis trunk group is set to H.323.

• According to your Class of Restrictions (COR) andFacility Restriction Levels (FRLs) configurationsyou need to assign the relevant COR for thisH.323 trunk. As seen on the screenshot, for thisexample the COR number 1 is used.

• The Trunk Access Code (TAC) is set to *64.

• The Direction parameter is set to two-way forallowing network call redirections.

• The Outgoing Display? parameter is set to optiony, which allows telephones to display the nameand the number of the trunk group.Here you might select value n for displaying onlythe digits the caller dials.

• The Dial Access? parameter is set to y to allowusers route outgoing calls through a trunk groupby dialing its trunk access code.

• The Service Type is used with the tie option.

• The Member Assignment Method parameter is usedwith its default value manual.

– 6 –

3.3.2 Trunk Parameters

The Trunk Parameters of the here described H.323 TrunkGroup is used with the following settings:

• The Supplementary Services parameter needs tobe set to option b in order to support QSIG.This, of course, only needs to be set when usingsupplementary services from within your CAPIapplication.

• For this example, the Disconnect Supervision In?parameter is set to y, thus allows trunk-to-trunktransfer involving trunks in this group.

This field and the Trunk-to-Trunk Transferparameter of the Feature-Related System Parametersdialog must be set to y.

The Disconnect Supervision Out? parameter is leftby its default value n.

– 7 –

3.3.3 Trunk Features

The Trunk Features of the here described H.323 TrunkGroup is used with the following settings:

• The NCA-TSC Trunk Member, is set to value 1 andneeds to be adjusted upon your needs.

• The Send Calling Number parameter is set to valuey 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 determinesthe Type of Number from the Numbering - PrivateFormat 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’snecessary to specify a Send Called/Busy/ConnectedNumber 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 enabledwhen the Calling Party Number of an incomingISDN call has to be displayed at the transferred-tostation 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 thereplacement trunk group.

• The SBS parameter (Separation of Bearer and

Signaling) is used with its default value n.

• The QSIG Value-Added?, as mentioned in thechapter Trunk Features before, is enabled by valuey which provides QSIG-VALU services.

• The QSIG-Value Coverage Encoding parameter isused with its proprietary default value, whichprovides extension information in the normalmanner.

3.3.5 Trunk Group Member Assignments

Within the Trunk Group Member Assignments dialog youneed to setup an amount of members, in meaning ofports/channels, according to this H.323 trunk group.

A trunk group offers configuring a number ofso called ports which can be assigned to differentsignaling groups. For this example 8 ports wereassigned by entering the value IP as signaling group,which becomes automatically related to the free portaddresses after saving the Trunk Group configuration.Each entry is assigned to the according Signaling Group(Sig Grp) number 64, as described in the chapterSignaling Group starting on page 4.

– 9 –

3.3.6 ISDN Trunk Group

The ISDN Trunk Group settings for this example areused as shown on screenshot below.

– 10 –

3.4 Route Patterns

Each route pattern contains one or several trunk groupsthat can be used for routing calls. You may have toinsert or delete some digits for routing AAR or ARS callsover different trunk groups, or need to convert an AARnumber to an international number with the NumberingFormat parameter for your numbering plan.

For this example route-pattern 1 is used with itsdefault values and was assigned to the properlyoperating ISDN trunk group (Grp No) 1.

The Facility Restriction Level (FRL) is set to level1, which is also used for the forthcoming describedXCAPI route pattern.

The CA-TSC Request parameter is used with optionas-needed. This is the Avaya recommended entry formost situations. The Numbering Format parameter isset to unk-unk, which specifies the unknown-unknownformat of the routing number used for the trunk groupfor this preference.

– 11 –

3.5 Incoming Call Handling

With the Incoming Call Handling Treatment dialog, youcan configure unique call treatments for differentincoming calls on any ISDN trunk group.

This chapter is not essential for setting upthe XCAPI-related H.323 trunking, but shortlydescribed for giving an overview of this exampleused numbering and the call handling. Here, theinc-call-handling-trmt trunk-group 1is used with a called length, see parameter Called Len,of 6 digits. This describes the number of digits receivedfor an incoming call, which consist of the followingthree parts.

The local Called Number 450 specifies the leading

digits received for an incoming call, which becomesdeleted again shortly after its detection by theparameter Del valued with 3.

The Auto Alternate Routing (AAR) Access Codenumber 6, as described in the chapter Feature AccessCodes (FAC) starting on page 12, is assigned to theFeature Access Code (FAC) call type of the Dial PlanAnalysis, described in Dial Plan Analysis starting onpage 13.

The according Automatic Alternate Routing (AAR)configuration, described on page 14, with the dial stringnumber 6 and a minimum and maximum digit lengthof 3, shows that the calling range 600 to 699 is routed tothe XCAPI-H.323 Trunk.

3.6 Feature Access Codes (FAC)

The Feature Access Code (FAC) configuration dialogassigns the dialed codes to the system features, whichin turn needs to be defined through the dial plan, asdescribed in the chapter

Dial Plan Analysis starting on page 13.Here, the Auto Alternate Routing (AAR) Access Codenumber 6 is used for accessing the XCAPI trunk andthe Auto Route Selection (ARS) - Access Code 1 numberedwith value 0 is used for accessing the public network.

– 12 –

3.7 Dial Plan Analysis

The Dial Plan Analysis Table configuration and the DialPlan 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 ofthe access code for the public network, and the dialedstring 6, in meaning of the access code for the H.323trunk of the XCAPI, are both set to the call type FeatureAccess Code (FAC).

The Dialplan Parameters are used with their defaultsettings as shown on screenshot below.

3.8 Uniform Dial Plan

This Uniform Dial Plan, which has to be enabled inthe System Parameters Customer-Options (OptionalFeatures), is used as shown on the screenshot below.If you have any doubts here, please refer to accordingchapters of the Feature Description and Implementation forAvaya Communication Manager and Administrator Guidefor Avaya Communication Manager Documents.

– 13 –

3.9 Automatic Alternate Routing (AAR)

In this example, all dialed matching numbers from 600to 699 will be routed to the XCAPI with their boundCAPI application. This is realized, as seen on the next

screenshot, by setting up the Dialed String number 6and using value 3 for the minimum (Min) and maximum(Max) parameters. The according Route Pattern is set tonumber 64 and the Call Type parameter is assigned tothe AAR.

The Digit Conversion Table is generally used for moreefficient routing. This is not relevant for the heredescribed H.323 Trunking at all and just shown to see

this configuration setup as a whole. Here, we use theMatching Pattern 0 which becomes assigned to the ARS.

– 14 –

3.10 Private Numbering

Configuring Private Numbering Plans allows specifyingthe digits to be put in the Calling Number informationelement (IE), the Connected Number IE, and the QSIGParty Number for extensions in the Private NumberingPlan.

Thus enables properly interworking of services suchas path replacement, see chapter Path Replacement onpage 20, and message waiting indications as describedin the chapter Message Waiting indications onpage 20 or transferring redirection numbers, see chapterRedirection Number on page 20.

3.11 Class of Restrictions (COR)

Class of Restrictions (COR) control call originations andterminations. This setup needs only one single CORfor covering the calling privileges. Thus, none callingor called party restrictions are used here, which surelyneeds to be adjusted for your setup.

For this configuration setup the COR number 1is used with Facility Restriction Level (FRL) 1, whichbecomes utilized by the AAR and/or ARS features forcall access determination to an outgoing trunk group.Both, the Calling and Called Party Restrictions aren’t setand respectively used with option none.

– 15 –

3.12 Class of Services (COS)

The Class of Services dialog is used for administeringaccess permissions of the station call processing

features. Here, you might have to modify someparameters for enabling the desired services.

– 16 –

3.13 IP Codec Set

The IP Codec Set configuration determines the codectypes and their related parameters for voice streamingand facsimile transmissions.

For this setup the IP codec set number 1 is used withthe G.711MU audio codec, no Silence Suppression and aPacket Size of 20 milliseconds which is equivalent to 2Frames Per Pkt.

On the second page of the IP Codec Set dialog,

some advanced configuration settings for facsimile andsignaling behaviors can be made.

Please review the chapter Fax Services starting onpage 21, for a more detailed description.

For this example the codec setup, beside of the notmentioned default settings, is used as follows:

• The FAX mode is set to off with a Redundancy levelof 0 for using the software fax method, see chapterSoftware Fax on page 21.

– 17 –

3.14 Feature-Related System Parameters

The Feature-Related System Parameters implementssystem parameters associated with various systemfeatures, which are used as described below:

• The PARAMETERS FOR CREATING QSIGSELECTION NUMBERS is set to Network Levelnumber 0 and used with no assigned Level 1 orLevel 2 code.

• The parameter Send Non-ISDN Trunk Group Nameas Connected Name? is enabled with option ywhich allows sending a name of the non-ISDNtrunk group as the connected name when a callroutes from ISDN to non-ISDN and the call isanswered.

• The Display Connected Name/Number for ISDNDCS Calls? parameter is enabled with y whichallows displaying the received connected name ornumber 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, inmeaning of the trunk group name, regardless oftrunk type.

• The Send Custom Messages Through QSIG?parameter is enabled with option y for providingappropriate display information.

• The QSIG/ETSI TSC Extension is used with atherefore unassigned value 199. This is a virtualextension number, for QSIG Call IndependentSignaling Connections supporting both, ETSI andQSIG temporary signaling connections.

• The MWI - Number of Digits Per Voice MailSubscriber parameter is set to 3 for providing anindication of the number of digits per subscriber.

• The National CPN Prefix parameter is valued to0 which applies as prefixes to national callingnumbers for display at receiving telephones.

• The International CPN Prefix parameter is set to 00which applies as prefixes to international callingnumbers for display at receiving telephones.

• The Path Replacement with Measurements?parameter is set to y for allowing QSIG pathreplacement or DCS with Reroute to be attemptedon measured calls.

• The QSIG Path Replacement Extension parameteris valued to 198 which is used as part of thecomplete number sent in the Path ReplacementPropose message.

• The parameter Path Replace While inQueue/Vectoring? is disabled with option n.Here you might have to use option y to allowPath Replacement after queue/vector processinghas started.

– 18 –

3.15 Stations

This chapter just shows the station configurationdialog, which were used for this setup, of a 9620 client.

– 19 –

4 Supplementary Services

In this chapter we are going to describe somebasic configurations for supplementary services,such as message waiting indications or pathreplacement. Those services are signaled through VoIPenvironments, respectively between the XCAPI and theACM, by the QSIG protocol family.

For full QSIG functionality, you must set theSupplementary Service Protocol field on both the TrunkGroup and the Signaling Group screen to b (QSIG).

You must set this field to b, because some QSIGfeatures, such as QSIG Call Completion and QSIGMessage Waiting Indication, use QSIG feature signalingon both the bearer call and on an NCA TSC to workproperly.

4.1 Message Waiting Indication

If you wish to use the Message Waiting Indicationsupplementary service from within your CAPIapplication, some further configuration is needed.If you don’t need to use this feature you can freely skipthis section. For these configuration tasks to succeedit’s a prerequisite that you have completed the QSIGconfiguration tasks from the previous section.

These dialogs allow a great variety of settings. Herewe have only a closer look to the therefore describedMWI supplementary service, see chapter Feature-RelatedSystem Parameters on page 18.

Here, the QSIG TSC Extension parameter valued 199is used for specifying a phantom endpoint extensionfor QSIG call independent signaling connections andthe MWI - Number of Digits Per Voice Mail Subscriberparameter is set respectively to 3.

4.2 Path Replacement

The Avaya Communication Manager doesn’t reallysupport the Call Transfer supplementary service. Whatit does support, is the QSIG Path Replacementsupplementary service, which pretty much has thesame effect on the outside, but different inner workings.

With the XCAPI and the ACM it’s possible to utilizePath Replacement automatically, whenever your CAPIapplication attempts to perform a call transfer.

If you want to enable this feature (on the XCAPI-side it’s enabled by default by the Controller Wizard),please open the same dialog as in the previous sectionby invoking the change system-parametersfeatures command and forwarding to appropriateconfiguration screen.

For this example, as already described in the chapterFeature-Related System Parameters on page 18, the QSIGPath Replacement Extension parameter valued by 198 thatwill be used as a part of the complete number sent in thePath Replacement Propose message which also needs toconform to the dial plan.

4.3 Redirection Number

Some CAPI applications need to receive a redirectionnumber beside the origin calling number, in meaningof the calling number transmitted by the redirectingstation.

For this you have to select option unk-pvt for theFormat parameter of the Trunk Group Features dialog, asdescribed in the chapter Trunk Features on page 8.

– 20 –

5 Fax Services

In this chapter, we are going to describe the necessaryconfiguration for using Fax services. Please ensure thatthe codecs with their related parameters are configuredin the right way.

5.1 Software Fax

With the software fax mode, the XCAPI simulatesan analogue Fax device by transmitting modulatedFax-signals modem-like over the established audiochannels. To configure the software fax mode, please

open the XCAPI configuration utility and select inthe advanced configuration mode the H.323 controllerassigned to the gateway.

Open the configuration tab labeled Features.Enable the SoftFax mode by setting the Always usesoftware fax over audio channels option and save thechanges to the XCAPI controller configuration.

Further you need to ensure that the according IPcodec set, as shown in the chapter IP Codec Set onpage 17, is used with the FAX Mode parameter OFF.Software FAX transmissions are only supported whenusing non-compressing voice codecs.

– 21 –

6 XCAPI Controller Settings

In this chapter we are going to review some XCAPI-related controller settings which should be set bydefault, when using the XCAPI controller wizard andselecting its Avaya Communication MangagerVoice-over-IP environment.

6.1 Controller Features

The Controller Features are set by default as shown onthe screenshot below.

6.2 QSIG Settings

Creating a H.323 controller with help of theXCAPI Controller Wizard ensures setting up optimalconfiguration flags by default. Next, we review themost important QSIG settings of the H.323 XCAPIcontroller. The option Enable QSIG/PSS-1 derivedsupplementary services of the QSIG dialog must be set.

The H.323 configuration tab determines thetunneling of QSIG-related information.

The QSIG tunneling according to H.323 Annex Moption has to be disabled and the Non standard tunnelingvia H.255.0 FACILITY information elements must beenabled. The Transmitting direction must be set to optionH.255.0 FACILITY.

6.3 XCAPI Gateway Settings

Finally we review the gateway settings of the createdXCAPI H.323 controller. Here we set the port numberto 6400 as this was defined for the Near-end Listen Portof the Processor Ethernet interface node name (procr), asdescribed in the chapter Signaling Groups on page 4.This port is set by default, within the XCAPI and theACM configuration to 1720 and might differ from thedefault value when it is already reserved by anothersignaling group.

– 22 –

– 23 –

Copyright c© by TE-SYSTEMS GmbH, Wolfsburg. All rightsreserved.

This document is property of TE-SYSTEMS GmbH and protectedby international copyright law.

TE-SYSTEMS GmbH does neither assume any liability or legalresponsibility nor any guarantee for this documents contents and itscontext. Moreover, merchantability, fitness for a particular purposeand 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 areneither edited, modified nor used commercially in any way. Shouldyou desire to use this document in any other way, it’s mandatory thatyou contact the copyright holder beforehand in written form.

All software and hardware terms mentioned in this manual areregistered trademarks and should be regarded as such.

– 24 –