hipath common application platform hipath cap v3.0 … management features, ... part of the siemens...

HiPath CAP V3.0 Prospect-1.1.doc Controlled Document 01-31-2005

HiPath Common Application Platform

HiPath CAP V3.0

Prospect

Status: released

Revision: 1.1

Approval or Release Date: 01-31-2005

The approved revision(s) of this document are available in NetInfo. Any paper copy, or other electronic copy, is not necessarily the current revision and is an uncontrolled copy. It is the user’s responsibility to ascertain whether this is a current copy. The master list identifying the current revision is NetInfo.

Copyright © 2005, Siemens AG

Copying of this document, or giving it to others, or the use or communication of the contents thereof, is forbidden without prior written authorization. The copyright notice hereon shall not constitute or imply publication. All rights are reserved.

HiPath CAP V3.0 Prospect

HiPath CAP V3.0 Prospect-1.1.doc Controlled Document 01-31-2005 Revision: 1.1 Page 1

Table of contents

History of Change 2

1 HiPath CAP 3 1.1 General Role within HiPath Architecture 3 1.2 Basic Product Structure 4 1.3 Feature Overview 6 1.4 Availability 7

2 HiPath CAP Architecture 8 2.1 Structure and Components 8 2.2 Configuration Scenarios 9 2.2.1 Single HiPath CAP with one Switch 9 2.2.2 Single HiPath CAP Scenario with Multiple Switches 10 2.2.3 Multiple HiPath CAP Scenario 11

3 Feature Overview 12 3.1 Delivery 12 3.2 HiPath CAP Management 13 3.2.1 HiPath CAP Configuration Management 14 3.2.2 HiPath CAP User Management 14 3.2.3 HiPath CAP License Management 14 3.2.3.1 License handling for applications 15 3.2.3.2 Partner Business 15 3.2.3.3 CAP Inside Business 15 3.2.4 HiPath CAP Fault Management 16

4 APIs and Interfaces 17 4.1 TAPI Interface 19 4.2 CSTA Interface 19 4.3 JTAPI Interface 19

5 Certification 20

6 Technical Data 22 6.1 Infrastructure Requirements 22 6.2 Performance 23

7 Links for more Information 24

8 Abbreviations 25

Appendices 27



History of Change

Rev. No.

Description of Change(s) By Whom Start Date

End Date

0.1 Update for CAP V3.0 - draft Schulz 11-11-04

0.2 Update – document ready for review Schulz 11-23-04

1.0 Release after review Schulz 12-15-04

1.1 Final version for M2 Schulz 01-31-05



1 HiPath CAP

This document describes the Common Application Platform within the HiPath Architecture. In the following the abbreviation CAP or HiPath CAP will be used as a synonym.

1.1 General Role within HiPath Architecture

HiPath CAP is a central part of the HiPath Architecture. It serves as a powerful middleware, offering benefits to customers and to partners alike.

Benefits to the customer

• Flexibility to use applications based on standards

• CTI application support for clients in different infrastructures

• Support for media handling without need for expensive hardware

• Integration of HiPath CAP and applications into HiPath Management System

• Keep the same application while migrating the infrastructure from classic telephone network to IP

• Integration of XML-based applications

• CTI enhancements for legacy applications



Services to application partners

• Develop applications once - HiPath CAP ensures them to work with different switches in different technologies

• Use CAP-provided services to enhance their own applications with management features, serviceability and security

• Speed up application development by leveraging CAP services

• Integrate their applications with HiPath applications and make them part of the Siemens application portfolio with full leverage of HiPath

• Reduced training costs due to XML

• XML Phone Services API with interactive development tool

• Harmonization reduces effort for development and sustaining

• Additional business opportunities due to huge installed base

1.2 Basic Product Structure

HiPath CAP is built as a modular construction set. It provides applications with access across multiple communication servers and offers

• Standard APIs and protocols

• Multiple connectivity to communication platforms

• Services for HiPath integration and application support



In order to cover requirements from different market segments, HiPath CAP V3.0 will be marketed based on CAP clients, licensing features (CSTA services) in different license levels to individual clients. No server licenses are needed anymore.

Please note that client subsequently refers to a monitored device (for device types, cf. section 4), except for media services which translate to channels.

HiPath CAP V3.0 Entry Clients are targeted at Direct and Partner Business; these support all interfaces (CSTA XML, CSTA ASN.1, TAPI, JTAPI), providing CTI functions for outgoing calls only. They come in a 10-client package only, meant as an “appetizer” for customers to become more interested in CTI functionality for applications.

HiPath CAP V3.0 Standard Clients are targeted at Direct and Partner Business; these support all interfaces (CSTA XML, CSTA ASN.1, TAPI, JTAPI), providing all CTI functions available except agent / call center features. They come in 10 – 25 – 100 client packages. A site license is available on request.

HiPath CAP V3.0 Advanced Clients are targeted at Direct and Partner Business; these support all interfaces (CSTA XML, CSTA ASN.1, TAPI, JTAPI), providing the complete CTI feature set. They come in 10 – 25 – 100 client packages. A site license is available on request. Advanced clients are targeted at the higher priced call center market.

HiPath CAP V3.0 Media Services are targeted at Direct and Partner Business; these support media streaming interfaces via TAPI 2.1, wave and FAX (T.38) drivers for the HiPath 4000 V2.0 and HiPath 3000/5000 V5.0 communication platforms. One license is required for every media channel.

HiPath CAP V3.0 Connectivity to Foreign PBX is targeted at Direct and Partner Business; it supports connectivity to non-HiPath switches and must be accompanied by “normal” Entry, Standard, or Advanced Client licenses to provide the respective feature sets via all interfaces (CSTA XML, CSTA ASN.1, TAPI, JTAPI). One foreign client license is required for every client connected to a non-HiPath switch.

Providing additional, private services to external application partners is possible only with explicit authorization by Product Management, based on an Interface License Agreement.

HiPath CAP Inside is the marketing model targeted at Siemens applications only.

For the CAP inside model, CAP components are integrated in applications like HiPath ProCenter, HiPath ComAssistant, HiPath SimplyPhone family, HiPath Display Telephone Book, HiPath Busy Lamp Field, HiPath Hotel, or others. No separate order of HiPath CAP and no additional HiPath CAP client licenses are required in that case.



1.3 Feature Overview

HiPath CAP V3.0 is a powerful middleware that plays an important role in the HiPath architecture. It supports efficiency improvements and cost reduction by

• providing standard protocols and APIs for application developers

• supporting application development with services (for CTI, management, and licensing, with an SDK available as well)

• supporting migration from Hicom 300 H to HiPath 4000 with multiple connectivity to different communication platforms, which makes applications nearly independent of the underlying infrastructure.

Highlights

• Standard protocols and API´s: CSTA XML, CSTA III ASN.1, JTAPI, TAPI

• Services

Call Control Service for CTI

o Multi domain feature

o Harmonization of call models of HiPath 3000/5000, HiPath 4000, Hicom 300, Octopus, and Realitis; non-Siemens switches will be included as far as technically feasible

Media Service for CTI (SMR 3)

o Support for HiPath 3000 and HiPath 4000 / latest releases

License, User, and Configuration Management Services

o Common license structure

o Integrated license and user management

o LM as a service for licensing HiPath CAP and applications alike

Fault Management Service

o Centralized handling of errors / status changes

o Integration into HiPath Management

XML Phone Service (currently available for HiPath4000 V2.0 only)

o HiPath ComScendo “On a Button Suite” EasySee EasyLookup EasyMail EasyShare EasyConference (SMR 2)

o SDK for XML Phone Services (SMR 2)



• Connectivity

Connectivity to HiPath 3000/500 V4.0 and V5.0

Connectivity to HiPath 4000 V1.0 and V2.0 via CA4000

Connectivity to Hicom 300 H via CA300

Connectivity to Octopus E300/800 Rel. 6.5/10 (SMR 1)

Connectivity to Realitis via CallBridge DX (SMR 1)

Connectivity to Nortel Meridian X11 Rel. 24 via Meridian Link SR 4.0

Connectivity to Alcatel A4400 (OmniPCX Enterprise) R3.0 or later

Connectivity to Avaya Definity G3 V6 (SMR 2)

Connectivity to Cisco Call Manager V3.1 (SMR 2)

1.4 Availability

General Availability – M3 in 02/05.

SMR 1 – SMR 3 service maintenance releases will follow subsequently in the 2005 spring to summer time frame.



2 HiPath CAP Architecture

2.1 Structure and Components

The following graph shows

• interfaces and APIs provided by HiPath CAP for application developers

• PBX connectivity as supported by this version of HiPath CAP

• interface to HiPath Management

• HiPath CAP components and their relations

Within one HiPath CAP installation, multiple instances of the Call Control Service (SCC), Connectivity Adapter (CA4000 / CA300) and Fault Management Service (SFM) components may exist. HiPath CAP Management is a unique component - every HiPath CAP installation requires exactly one HiPath CAP Management.

HiPath CAP regularly provides interfaces CSTA, JTAPI, and TAPI to applications in a harmonized way across multiple switches (“multi domain / heterogeneous / harmonized” interfaces), so applications neither have to address a specific switch directly nor need to care about specifics of different switch types.

Additionally, the native CSTA ASN.1 interfaces of different switches (CSTA phase I, II or III, depending on the switch type) are made available directly without harmonization for



legacy applications. In that case, multi-domain support is provided across switches of the same type only (“single or multi domain / homogeneous / native” interfaces).

General recommendation to application developers

As this documentation cannot cover all details of the HiPath CAP CTI / programming interfaces and in particular cannot handle every exceptional case of a specific operational environment, we strongly recommend to contact CAP support ([email protected]) for detailed discussion of the CAP configuration and interfaces suitable to host your application.

2.2 Configuration Scenarios

HiPath CAP can be used in different configuration scenarios as described below.

2.2.1 Single HiPath CAP with one Switch

Example 1

HiPath CAP resides on a single PC, with exactly one component of each type installed, connected to the ACL-C interface of HiPath 4000.

HiPath CAP

HiPath4000

CA4000

Call Control

(SCC)

CAP Mgmnt

WAN(IP)

HiPath CAP works with HiPath 4000 in a single system image as well as in an

Internet Protocol Distributed Architecture (IPDA)

Example 2

HiPath CAP resides on a single PC, with exactly one component of each type installed, connected to the CSTA interface of HiPath 3000.

HiPat CAP

HiPath 3000

Call Control

(SCC) CAP

Mgmnt

HiPath CAP

HiPath 3000

Call Control

(SCC) CAP

Mgmnt



For improved performance or security, the HiPath CAP installation can be distributed among several PCs, with multiple SCC and CA4000 instances as shown in the example below.

HiPath4000

HiPath CAP

Server 1

CA4000

Call Control

(SCC)

Server 2

CA4000

Call Control

(SCC)

CAP Mgmnt

2.2.2 Single HiPath CAP Scenario with Multiple Switches

In a network of switches, HiPath CAP can be installed as a distributed system on several server PCs.



The HiPath CAP connectivity adapter (CA4000 / CA300) instances would be installed close to the respective switch. Please note that unlike HiPath CAP V1.0, there is no requirement any more to host different CA instances on different servers.

With HiPath CAP V3.0, several CA instances can run on the same host, linked to one switch each via the SL200 based TCP/IP connection.

HiPath CAP Call Control Service (SCC) instances (one per switch / connectivity adapter) can be distributed across the network according to load balancing, performance or security requirements.

HiPath CAP Management (administration and licensing) can be installed on any one PC, but there is only one Management for one distributed HiPath CAP installation.

2.2.3 Multiple HiPath CAP Scenario

This scenario includes several independent HiPath CAP installations, which means several HiPath CAP Management instances as well. It allows for the customer to handle separate user groups or to serve different applications specifically (e.g. with specific license handling and billing procedures, or with harmonized vs. native interface types).



3 Feature Overview

3.1 Delivery

HiPath CAP V3.0 linear

PST Features Hint Vers. Ctry.

Feat.-No. VG FaGr

&

HiPath CAP V3.0 linear

1 Software CD

BDF330 HiPath CAP V3.0 Server SW Comprises: - Software - Documentation - Basic Tool Kit

L30280-D600-F330 58604 06612

2 Licenses

BDF331 HiPath CAP V3.0 Entry 10 Clients 10 clients for „make call“ function L30280-D622-F331 58604

06612

BDF332 HiPath CAP V3.0 Standard 10 Clients 10 clients for CTI applications without Call Center features L30280-D622-F332 58604

06612


06612


06612

BDF336 HiPath CAP V3.0 Standard SL Site License for a minimum of 500 clients. Supports CTI applications without Call Center features. License for a customer-specific number of clients in a CAP installation. Price on request.

L30280-D622-F336 58604 06612

BDF337 HiPath CAP V3.0 Advanced 10 Clients 10 clients for CTI applications with Call Center features L30280-D622-F337 58604

06612


06612


06612

BDF341 HiPath CAP V3.0 Advanced SL Site License for a minimum of 500 clients. Supports CTI applications with Call Center features. License for a customer-specific number of clients in a CAP installation. Price on request.

L30280-D622-F341 58604 06612

BDF346 HiPath CAP V3.0 connectivity to non-Siemens telecommunication systems Per client

L30280-D622-F346 58604 06612

BDF356 HiPath CAP Client Site License for a customer-specific number of clients for a CAP-Installation

L30280-D600-F356 58603 6612

+

License keys for HiPath CAP can be ordered from your local Siemens representative, or they implicitly come with application licenses in case of HiPath CAP inside business.



3.2 HiPath CAP Management

HiPath CAP Management serves as the central component for controlling and administrating a (potentially distributed) HiPath CAP installation. As shown in the scenarios, HiPath CAP components like Call Control service (SCC), Connectivity Adapter (CA4000), and Fault Management service (SFM) may occur several times on various servers in the net. HiPath CAP Management, however, exists exactly once per HiPath CAP installation.

HiPath CAP Management comes with a web based user interface; accordingly, it may be accessed from every administrator workstation via web browser.

CAP Management Server

SUM

SCM

SLM

SFM

CAP Management

GUI

HTTP

As shown in the diagram, this allows for administration tasks to be conducted over the web, from a remote site or even by a service technician from outside the customer’s intranet. Of course, this feature is available only for persons that have been assigned the administrator role and privileges in HiPath CAP User Management. Administrator access is protected by password and (in case access to a company intranet is required from outside) requires permission to pass through the company firewall.

HiPath CAP Management tasks include

• administrating the distribution of HiPath CAP components across servers (e.g. tracking that an SCC can be reached via a specific IP address)

• administrating HiPath CAP users (e.g. mapping HiPath CAP user IDs to the SCC providing access to the switch that handles the user’s phone device)

• administrating licenses for HiPath CAP as well as HiPath CAP based applications

• controlling license usage by HiPath CAP users, and administrating user roles

Fault Management - which by definition is one of the Management tasks - plays a specific role: in contrast to “HiPath CAP Management” as defined above, it will reside on any of the nodes that host a HiPath CAP component, i.e. it will be installed more than once per HiPath CAP installation.

All of these tasks are described in more detail in the subsequent sections.



3.2.1 HiPath CAP Configuration Management

HiPath CAP Configuration Management (SCM) serves to define the mapping between PBXs and SCC servers.

Defining the configuration normally will be done after HiPath CAP installation has been completed; changes are possible whenever the configuration is modified later on. Please note the 1-to-1 link between SCC4000 and CA4000 / SCC300 and CA300 instances is established explicitly as the administrator configures specific “switch connectivity” instances.

Additionally, a set of features for monitoring the HiPath CAP installation (e.g. display HiPath CAP server nodes) and for troubleshooting (e.g. start, stop, restart HiPath CAP processes) is provided.

3.2.2 HiPath CAP User Management

Prior to using HiPath CAP, every HiPath CAP user must be defined in HiPath CAP User Management (SUM), providing identification and authentication data and defining a user’s access rights.

As described above, HiPath CAP Management functions are bound to the administrator role, i.e. only those users configured as administrators and authenticated by respective passwords are granted access to HiPath CAP Management. A generic “Admin” user is pre-configured to get HiPath CAP Management up and running initially; of course that user can be deleted after specific users have been defined and identified as administrators.

With HiPath CAP User Management, same basic synchronization facilities are provided to import / export user data from / to the switch database (like HDMS / HiPath Manager).

3.2.3 HiPath CAP License Management

HiPath CAP provides a HiPath CAP License Management service (SLM) that is used by HiPath CAP and is offered as a service that can be used by HiPath CAP-based applications. SLM is to process license keys provided by Siemens, activate the licenses, and keep them ready for use by HiPath CAP clients and applications. SLM keeps track of available licenses and licenses in use, issuing an alert when the number of requests for licenses exceeds the number of licenses available. SLM provides a web based user interface within HiPath CAP Management for activating license keys and monitoring the license distribution.

HiPath CAP licenses come as described in sections 1.2 and 3.1.

According to the customer’s order, a set of license keys is generated at the Siemens production site for download via an Internet site. A license key contains the information

• Application vendor (info only)

• Application ID, either identifying a “real” application (application licensing), or one of CAP-E, CAP-S, CAP-A / CAP-M / CAP-F for licenses not tied to a specific application (depending on the licenses purchased)

• Application version (info only)

• Customer ID (info only)



• System ID (MAC ID of the target server machine)

• Delivery date (info only)

• Valid thru, by default set to “unlimited”

• Number of clients sold

3.2.3.1 License handling for applications

For any application using one of the HiPath CAP CTI interfaces, a client license is required for each user that has been configured to use that application / interface.

This is based on users being registered for the application in HiPath CAP user management (SUM): In SUM, users can be given access rights for specific applications / interfaces. SUM makes sure with SLM that the number of users being registered for an application / interface doesn’t exceed the number of licenses available for that application / interface. Prior to granting an application user access to SCC, SUM checks if that user has been registered for the respective application / interface.

This approach supports both application specific and interface specific licensing: For application specific licensing, an application specific license is required, and the application is to show its ID when connecting to HiPath CAP. Accordingly, SUM checks if the user has been configured to use that application, hence indirectly verifying that an application specific client license has been reserved. For interface specific licensing, no application specific license is required (i.e. a license key with application ID CAP-E, CAP-S or CAP-A is used), and the application needn’t provide its ID when connecting to HiPath CAP. Accordingly, SUM checks if the user has been configured to use the respective interface, hence indirectly verifying that a (non-application-specific) client license has been reserved.

Application specific license handling will be used – among others - for HiPath CTI applications ComAssistant / SimplyPhone for Web and SimplyPhone for Outlook / Lotus Notes. For partner applications, both application specific and interface specific licensing is available.

3.2.3.2 Partner Business

For running partner applications, the customer is to order HiPath CAP licenses as required for the specific application. It’s up to the application partner to install and test the application at the customer’s site.

3.2.3.3 CAP Inside Business

For “CAP inside” business, which refers to Siemens applications only, application providers integrate HiPath CAP inside with an individual application package, implicitly delivering HiPath CAP to the customer as well. License keys as described above must be provided implicitly with the order processing in AKABAM, the content for application vendor, ID, and version being generated automatically.



3.2.4 HiPath CAP Fault Management

HiPath CAP Fault Management (SFM) enables integration of HiPath CAP components as well as HiPath CAP based applications into HiPath Fault Management. The functionality of SFM is based on SNMP and a HiPath MIB and comprises the features

• Basic auto discovery

• MIB based information retrieval

• Trap notification

The auto discovery feature enables automatic identification and integration of a PC with SFM into HiPath Fault Management. A part of the information required for auto discovery is to be provided to SFM during the installation process; it is stored in the Windows registry.

The information retrieval feature provides HiPath Fault Management with an access to information defined in the HiPath MIB. The information, e.g. about installed applications and the respective executables, will be retrieved by SFM on demand. The information available is defined in the HiPath MIB.

Trap notification provides HiPath CAP based applications with two interfaces for reporting errors / status changes to HiPath Fault Management as SNMP traps.

Details are shown in the diagram below.

HiPath Fault Management

CA4000

CA4000 Error Log

SNMP

SFM component

ProCenter / Xpressions

W indows Event Log

SFM Client (DLL)

SCC

Standalone SFM SNMP - Agent

SCC Error (DLL)



SFM Client (DLL)

CA4000 Trace Log

Windows Event Log

SCC Error Log

HiPath MIB

SFM Data

CAP FM Trace Log

Windows Registry

• A message-based interface supports sending SNMP traps to the SFM SNMP agent directly; the SNMP agent forwards traps to HiPath Fault Management accordingly.

• For applications that don’t want to handle SNMP traps directly, the Windows event log provides a convenient alternative (as shown for ProCenter / Xpressions in the diagram): SFM scans the event log for status changes / error messages and generates SNMP traps from event log entries. This will be done for applications / executables that have provided SFM with necessary data during initialization / setup.

The trap notification format is defined in the HiPath Management Information Base (MIB).



4 APIs and Interfaces

The following table provides a high level overview of features available through the CTI interfaces of HiPath CAP V3.0. Please note that details will vary for different interfaces (CSTA III ASN.1 native vs. CSTA XML harmonized vs. JTAPI vs. TAPI …) and for different switching platforms; i.e. not every feature listed below will be supported through all of the CTI interfaces on all platforms. For additional detail, please refer to the appendices of this document; final statements including PICS (protocol implementation conformance statements) will be provided in the Application Developers’ Guide coming with the CAP software.

Feature Available Remark

Phone Features

incoming call signaling

calling line identification

calling name display

suppress caller ID

called party ID

calling party forwarded

hands free mode -

toggle mode (hands free / hand set) -

clear call / connection

consultation call

toggle call

conference call

call hold

single step transfer

consultation transfer

do not disturb (on / off)

pick up call (group) -

directed pick up

answer call

dialing hook off

park / unpark

call forwarding

call back (call related)

call back if no reply

call back if busy

call back after busy

redial

display call length



Feature Available Remark

boss / secretary

camp on -

predictive call

deflect call (extension)

Key and Display Handling

key string input / output data

display output in dialog

display output at any time

LED on / off / blinking

set LED

clear LED

ACD Feature Support

agent state

group agent state

ACD logon

ACD logoff

ACD queue status

route trigger (ACD)

reject call (ACD)

divert call (ACD)

continue call (ACD)

Other Features

user data send / receive

global call ID

call detail recording services via accounting service

Device types supported on the HiPath 4000 are

o station analog

o station digital

o CMI

o phantom line

o functional (ISDN)

o attendant console

o general attendant

o route control group

o hunt group

o trunk



For the HiPath 3000

o monitoring of TDM trunks is supported

o monitoring of IP trunks is not supported

Please note that feature availability may vary for different device types – for details see ADG.

4.1 TAPI Interface

The feature set provided via the HiPath CAP V3.0 TAPI interface is described in the appendix. Please refer to the “TAPI Supported Functions” section.

4.2 CSTA Interface

The feature set provided via the HiPath CAP V3.0 CSTA interfaces (ASN.1 coded as well as CSTA XML) is described in the appendix. Please refer to the “CSTA Supported Functions” section.

4.3 JTAPI Interface

The feature set provided via the HiPath CAP V3.0 JTAPI interface is described in the appendix. Please refer to the “JTAPI Supported Functions” section.



5 Certification

HiPath CAP is a standard based middleware. Due to this fact certification of an application is a choice for the application partner and not longer a must. It’s a question of quality of the individual product and the marketing approach of the application partner.

Businesses are increasingly realizing the importance of integrating their various applications into a seamless environment capable of delivering uniform quality of service to customers for all their sales, service and support needs. Many times, a single vendor cannot supply all of the elements required to complete an application solution. Vendors able to assemble components from outside vendor partners and to simplify integration of vendor products enhance their potential for success within these complex markets. Very important is the reduction of service cost for installations and sustaining, both for Siemens and for the 3rd party vendors.

Every 3rd party vendor can choose to either

• develop and sell an application without certification (own responsibility)

or may rather

• pursue certification at a Siemens HiPath Ready Lab, with the additional benefit to advertise with that.

Siemens HiPath Ready Partner advantages include

Technical support from a global leading supplier of IP convergence solutions

A powerful worldwide accepted base of HiPath Communication Platforms for a wide range of sophisticated partner applications

Access authorization for HiPath Open Interfaces

Convenient access to Siemens technical support

Shorter development times, lower development costs

Reduced development effort, quality assurance

Shorter time to market, with total flexibility and complete control of business

Transparency at partners level

Opportunities for cooperation with other Siemens HiPath Ready partners

Public relations opportunities

Reduce Siemens and 3rd Party Vendors cost for integration and sustaining service



Siemens HiPath Ready Standard package

• Self certification

• Ability to test off line

• Vendors can use certification option

• Remote test option

Siemens HiPath Ready Advanced package

• Siemens conducted certification

• Available test packages

• Partner listing

• Partner events (Siemens HiPath Ready – Well connected)

• Siemens offers service component for 3rd party vendors

In any case, the partner remains responsible for the function of his application running on HiPath CAP and has to validate the availability of services and events required for the application.

Contact

http://www.siemens.com/hipathready



6 Technical Data

6.1 Infrastructure Requirements

Server

Windows 2000 Professional or Server Windows XP Professional

Off the shelf PC Hardware, standard PC 500 MB of disk space at least 512 MB RAM at least Caveat: This figure depends on the server load; for reasonable CAP operation, memory size should be large enough to prevent the server PC from swapping suitable backup medium NIC (Ethernet) for CTI link to switch LAN card required to support 10MB TP Caveat: We recommend not to use the 3COM 905C LAN card as that one caused some serious problems during system test NIC (Ethernet) for customer LAN access

Client

For CAP components SCCP, SCC, CA:

Windows 2000 Professional or Server Windows XP Professional

For remote access to CAP Management:

Any operating system supporting Web Browsers Internet Explorer 5.0 and above Netscape Navigator 7.x and above Mozilla 1.x and above

For clients hosting CAP TAPI Service Provider

Windows 2000 Professional or Server Windows XP Professional Windows 2000 Terminal Server Terminal Server Citrix Metaframe XP 1.0 (Rel. Features 3)

Off the shelf PC Hardware, standard PC 100 MB of disk space at least 256 MB RAM at least NIC (Ethernet) for customer LAN access

To realize remote access, standard OEM components can be used.



6.2 Performance

Performance is a result of load per time unit at the system interfaces (e.g. user behavior, CTI links, requirements of communication channels and applications), taking under consideration the influence of other non-HiPath activities in the network as well.

For HiPath CAP V3.0 to meet specific performance and capacity requirements (like BHCAs, number of monitored devices, number of supported clients and switch domains), the system can be scaled up accordingly, making use of

• configuration possibilities

• server sizing

• distribution of components across several servers.



7 Links for more Information

HiPath Architecture

http://www.hipath.com

Product Management (Sales & Marketing)

mailto:[email protected]

Product Management (Technical)

mailto:[email protected]

Siemens HiPath Ready

http://www.siemens.com/hipathready



8 Abbreviations

ACL Application connectivity link

AKABAM Siemens system for order processing

AMO Administration and Maintenance Order

API Application programming interface

ASN.1 Abstract syntax notation no. 1

BHCA Busy hour call attempts

CA Connectivity adapter

CAP Common Application Platform

CBfWG CallBridge for Workgroups

CRM Customer Relationship Management

CSTA Computer supported telephony application

CTI Computer telephony interface

DB Database

DBMS Database management system

ECMA European Computer Manufacturers Association

GUI Graphical user interface

HTML Hypertext markup language

HTTP Hypertext transport protocol

I/F Interface

LAN Local area network

MIB Management information base

OS Operating system

PBX Private Business Exchange

PST Public switched telephony

PSTN Public switched telephony network

RAC-T Remote Assistance Center Technical

SCC Call Control Service

SDK Software development kit

SFM Fault Management Service

S-HTTP Secure HTTP

SCM Configuration Management Service

SFM Fault Management Service



SLM License Management Service

SMTP Simple message transport protocol

SNMP Simple network management protocol

SUM User Management Service

TAPI Telephony application interface

TSP TAPI service provider

WAN Wide area network

XML eXtended markup language



Appendices

CSTA Supported Functions

TAPI Supported Functions

JTAPI Supported Functions

HiPath CAP V3.0 Supported Functions CSTA XML

CAP V3.0 CSTA XML Multi Domain Harmonized Feature Set

Yes = supported by PBXNo = not supported by PBX

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Get logical device information Yes Yes No NoGet physical device information Yes Yes No YesGet switching function capabilities Yes Yes No YesGet switching function device Yes Yes No NoSwitching function devices Yes Yes No No

Change system status filter Yes Yes No NoSystem register Yes Yes No NoSystem register abort No No No NoSystem register cancel Yes Yes No No

Request system status Yes Yes No NoSystem status Yes Yes Yes YesSwitching function capabilities changed No No No NoSwitching function devices changed Yes Yes No No

Change monitor filter Yes Yes Yes YesMonitor start (device-type only) Yes Yes Yes YesMonitor stop Yes Yes Yes Yes

Snapshot call Yes Yes No NoSnapshot device Yes Yes Yes YesSnapshot calldata No No No NoSnapshot devicedata Yes Yes No Yes

Accept call No No No NoAlternate call Yes Yes Yes YesAnswer call Yes Yes Yes YesCall back call-related Yes Yes No NoCall back message call-related No No No NoCamp on call No No No NoClear call No No No NoClear connection Yes Yes Yes YesConference call Yes Yes Yes YesConsultation call Yes Yes Yes YesDeflect call Yes Yes No YesDial digits Yes Yes Yes No

Capability exchange services

Services

System services

Registration services

Services

Monitoring services

Services

Services

Call control services & events

Services

Snapshot services

01-25-2005 Page A - 1




Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Directed pickup call No No No YesGroup pickup call No No No YesHold call Yes Yes Yes YesIntrude call No No No NoJoin call No No No NoMake call Yes Yes Yes YesMake predictive call Yes Yes No NoPark call No No No NoReconnect call Yes Yes Yes YesRetrieve call Yes Yes Yes YesSingle step conference call No No No NoSingle step transfer call Yes Yes No YesTransfer call Yes Yes Yes Yes

Bridged No No No NoCall cleared No No No NoConferenced Yes Yes Yes YesConnection cleared Yes Yes Yes YesDelivered Yes Yes Yes YesDigits dialed Yes Yes No NoDiverted Yes Yes Yes YesEstablished Yes Yes Yes YesFailed Yes Yes Yes YesHeld Yes Yes Yes YesNetwork capabilities changed No No Yes 4.0 NoNetwork reached Yes Yes Yes YesOffered No No No NoOriginated Yes Yes Yes YesQueued Yes Yes Yes YesRetrieved Yes Yes Yes YesService initiated Yes Yes Yes YesTransferred Yes Yes Yes Yes

Associate data No No No NoCancel telephony tones No No No NoGenerateDigits Yes Yes Yes YesGenerate telephony tones Yes Yes No NoSend user information Yes Yes No No

Call information Yes Yes Yes NoCharging No No No YesDigits generated Yes Yes No NoTelephony tones generated Yes Yes No No

Events

Call associated features

Services

Events

01-25-2005 Page A - 2




Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Service completion failure No No No No

Attach media service No No No NoDetach media service No No No No

Media attached No No No NoMedia detached No No No No

Route register Yes Yes No NoRoute register abort No No No NoRoute register cancel Yes Yes No No

Re-Route Yes Yes Yes NoRoute end Yes Yes Yes NoRoute reject Yes Yes No NoRoute request No Yes Yes NoRoute select Yes Yes Yes NoRoute used No No No No

Button press No No No YesGet auditory apparatus information No No No NoGet button information No No No YesGet display No No No NoGet hookswitch status No No No YesGet lamp information No No No NoGet lamp mode No No No NoGet message waiting indicator Yes Yes No YesGet microphone gain No No No NoGet microphone mute No No No YesGet ringer status No No No NoGet speaker mute No No No YesGet speaker volume No No No YesSet button information No No No NoSet display Yes Yes No YesSet hookswitch status No No No NoSet lamp mode Yes Yes No YesSet message waiting indicator Yes Yes No YesSet microphone gain No No No NoSet microphone mute No No No YesSet ringer status No No No NoSet speaker mute No No No Yes

Events

Routing services


Services

Physical device features

Services

Media attachment services & events

Services

01-25-2005 Page A - 3




Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Set speaker volume No No No Yes

Button information No No No NoButton press No No No YesDisplay updated No No No NoHookswitch No No No YesLamp mode No No No NoMessage waiting Yes Yes No YesMicrophone gain No No No NoMicrophone mute No No No NoRinger status No No No NoSpeaker mute No No No NoSpeaker volume No No No No

Call back non-call-related No No No NoCall back message non-call-related No No No YesCancel call back Yes Yes No NoCancel call back message No No No YesGet agent state Yes Yes Yes YesGet auto answer No No No YesGet auto work mode No No No YesGet caller id status No No No YesGet do not disturb Yes Yes Yes YesGet forwarding Yes Yes Yes YesGet last number dialled No No No NoGet routeing mode Yes Yes No NoSet agent state Yes Yes Yes YesSet auto answer No No No NoSet auto work mode No No No NoSet caller id status No No No YesSet do not disturb Yes Yes No YesSet forwarding Yes Yes Yes YesSet routeing mode Yes Yes No No

Agent busy Yes Yes No YesAgent logged off Yes Yes Yes YesAgent logged on Yes Yes Yes YesAgent not ready Yes Yes Yes YesAgent ready Yes Yes Yes YesAgent working after call Yes Yes Yes YesAuto answer No No No NoAuto work mode No No No NoCall back Yes Yes No No

Events

Logical device features

Services

Events

01-25-2005 Page A - 4




Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Call back message No No No NoCaller id status No No No NoDo not disturb Yes Yes Yes YesForwarding Yes Yes Yes YesRouteing mode Yes Yes No No

Back in service Yes Yes No YesDevice capabilities changed No No No NoOut of service Yes Yes No Yes

I/O register Yes Yes No NoI/O register abort No No No NoI/O register cancel Yes Yes No No

Data path resumed Yes Yes No NoData path suspended Yes Yes No NoFast data Yes Yes No NoResume data path No No No NoSend broadcast data No No No NoSend data Yes Yes No YesSend multicast data No No No NoStart data path Yes Yes No YesStop data path Yes Yes No YesSuspend data path No No No No

Data Collected No No No NoData Collection Resumed No No No NoData Collection Suspended No No No NoResume Data Collection No No No NoStart Data Collection No No No NoStop Data Collection No No No NoSuspend Data Collection No No No No

Concatenate message No No No NoDelete message No No No NoPlay message No No No YesQuery voice attribute No No No NoRecord message No No No NoReposition No No No NoResume No No No No

Device Maintenance events

Events

I/O services


Services

Data Collection Services

Services

Voice unit services & events

Services

01-25-2005 Page A - 5




Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000

V4.

0 / V

5.0

Review No No No NoSet voice attribute No No No NoStop No No No YesSuspend No No No NoSynthesize message No No No No

Play No No No YesRecord No No No NoReview No No No NoStop No No No YesSuspend play No No No NoSuspend record No No No NoVoice attribute changed No No No No

Call detail records notification No No No NoCall detail records report No No No YesSend Call Detail Records No No No NoSend stored call detail records No No No NoStart call detail records transmission No No No YesStop call detail records transmission No No No Yes

Escape register No No No NoEscape register abort No No No NoEscape register cancel No No No No

Escape Yes Yes Yes YesSet lower Class of Service Yes Yes No NoGet lower Class of Service Yes Yes No NoPrivate Data Version Selection Yes Yes No No

Private Event No No No No

Events

Call detail record (CDR) services

Services

Vendor specific extensions services & events

Services

Services

Events

01-25-2005 Page A - 6




Get logical device information Get physical device informationGet switching function capabilitiesGet switching function deviceSwitching function devices

Change system status filterSystem registerSystem register abortSystem register cancel

Request system status System statusSwitching function capabilities changedSwitching function devices changed

Change monitor filterMonitor start (device-type only)Monitor stop

Snapshot callSnapshot deviceSnapshot calldataSnapshot devicedata

Accept callAlternate call Answer call Call back call-relatedCall back message call-relatedCamp on callClear callClear connectionConference callConsultation call Deflect call Dial digits


Services

System services


Services

Monitoring services

Services

Services


Services

Snapshot services

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

No No No NoNo No No No

No No NoNo No No NoNo No No No

No No No NoNo No No

No No No NoNo No No

Yes Yes NoYes No Yes


No No No NoYes Yes YesYes Yes Yes

No No YesYes Yes Yes

No No No NoNo No Yes No

No No No NoNo No YesYes Yes YesNo No No

No No No NoNo No No

No No No NoYes Yes YesYes No YesYes Yes YesYes No YesNo No No

01-25-2005 Page A - 7




Directed pickup call Group pickup call Hold call Intrude call Join callMake callMake predictive call Park callReconnect call Retrieve call Single step conference callSingle step transfer callTransfer call

BridgedCall clearedConferencedConnection clearedDeliveredDigits dialedDiverted Established Failed HeldNetwork capabilities changed Network reached OfferedOriginatedQueued Retrieved Service initiatedTransferred

Associate dataCancel telephony tonesGenerateDigits Generate telephony tonesSend user information

Call informationChargingDigits generated Telephony tones generated

Events


Services

Events

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

No No NoNo No NoNo No YesNo No No

No No No NoYes Yes Yes


No Yes YesNo No No NoNo No No No

No No NoYes Yes Yes

No No NoNo No NoNo Yes YesNo Yes YesNo Yes YesNo No NoYes No YesYes Yes YesNo Yes YesNo Yes Yes

No No No NoNo Yes YesNo No NoNo Yes YesNo No YesNo Yes YesNo Yes YesNo Yes Yes

No No NoNo No No No

No No NoNo No No NoNo No No No

No No No NoNo No No NoNo No No NoNo No No No

01-25-2005 Page A - 8




Service completion failure

Attach media service Detach media service

Media attached Media detached

Route register Route register abort Route register cancel

Re-RouteRoute end Route rejectRoute requestRoute select Route used

Button press Get auditory apparatus informationGet button information Get display Get hookswitch statusGet lamp informationGet lamp modeGet message waiting indicatorGet microphone gainGet microphone muteGet ringer statusGet speaker muteGet speaker volumeSet button informationSet displaySet hookswitch statusSet lamp modeSet message waiting indicatorSet microphone gainSet microphone muteSet ringer statusSet speaker mute

Events

Routing services


Services


Services


Services

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

No No No No



No No No NoNo No No NoNo No No No

No No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No No

No No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No No

No No NoNo No No No

No No NoNo No No


01-25-2005 Page A - 9




Set speaker volume

Button informationButton pressDisplay updatedHookswitchLamp modeMessage waitingMicrophone gainMicrophone muteRinger statusSpeaker muteSpeaker volume

Call back non-call-relatedCall back message non-call-relatedCancel call backCancel call back messageGet agent stateGet auto answerGet auto work modeGet caller id statusGet do not disturb Get forwarding Get last number dialledGet routeing modeSet agent stateSet auto answerSet auto work modeSet caller id statusSet do not disturbSet forwarding Set routeing mode

Agent busyAgent logged off Agent logged on Agent not ready Agent ready Agent working after call Auto answerAuto work modeCall back

Events


Services

Events

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

No No No No

No No No NoNo No No


No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No No


No No NoNo No No No

Yes No YesNo No No NoNo No No NoNo No No NoNo No No No

No Yes NoNo No No NoNo No No No

Yes No YesNo No No NoNo No No NoNo No No NoNo No No No

Yes Yes NoNo No No No

No No YesYes No YesYes No YesYes No YesYes No YesYes No Yes


No No No

01-25-2005 Page A - 10




Call back messageCaller id statusDo not disturbForwarding Routeing mode

Back in serviceDevice capabilities changedOut of service

I/O registerI/O register abortI/O register cancel

Data path resumedData path suspendedFast dataResume data pathSend broadcast dataSend dataSend multicast dataStart data pathStop data pathSuspend data path

Data CollectedData Collection Resumed Data Collection Suspended Resume Data CollectionStart Data CollectionStop Data CollectionSuspend Data Collection

Concatenate messageDelete messagePlay messageQuery voice attributeRecord messageRepositionResume


Events

I/O services


Services


Services


Services

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0


No No NoNo No No No

Yes No NoNo No No No

Yes No No

No No NoNo No NoNo No No

No No NoNo No NoNo No No


No No NoNo No No No

No No NoNo No No

No No No No

No No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No NoNo No No No


01-25-2005 Page A - 11




ReviewSet voice attributeStopSuspendSynthesize message

PlayRecordReviewStopSuspend playSuspend recordVoice attribute changed

Call detail records notificationCall detail records reportSend Call Detail RecordsSend stored call detail recordsStart call detail records transmissionStop call detail records transmission

Escape registerEscape register abortEscape register cancel

EscapeSet lower Class of ServiceGet lower Class of ServicePrivate Data Version Selection

Private Event

Events


Services


Services

Services

Events

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

No No No NoNo No No NoNo No No NoNo No No NoNo No No No


No No No NoNo No No NoNo No NoNo No No NoNo No No NoNo No No No



No No No No

01-25-2005 Page A - 12

HiPath CAP V3.0 Supported Functions CSTA III ASN.1

CAP V3.0CSTA III ASN.1 Feature Set


License N = available without a license E = available with Entry license S = available with Standard license A = available with Advanced license NA = feature not supported

Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Get logical device information N Yes No No NoGet physical device information N Yes No Yes NoGet switching function capabilities N Yes No Yes NoGet switching function devices N Yes No No NoSwitching function devices N Yes No No No

Change system status filter N No No No NoSystem register N Yes No No NoSystem register abort N No No No NoSystem register cancel N No No No No

Request system status S Yes No No NoSystem status S Yes Yes Yes YesSwitching function capabilities changed N No No No NoSwitching function devices changed N No No No No

Change monitor filter S Yes Yes Yes YesMonitor start (device-type only) S Yes Yes Yes YesMonitor stop S Yes Yes Yes Yes

Snapshot call S Yes No No YesSnapshot device S Yes Yes Yes YesSnapshot calldata NA No No No NoSnapshot devicedata S No No Yes No

Accept call NA No No No NoAlternate call S Yes (Yes) Yes YesAnswer call S Yes Yes Yes YesCall back call-related S Yes No No NoCall back message call-related NA No No No NoCamp on call S No No No NoClear call S No No No NoClear connection S Yes Yes Yes YesConference call S Yes Yes Yes YesConsultation call S Yes Yes Yes YesDeflect call S Yes No Yes YesDial digits S Yes Yes No No


Services

Monitoring services

Services

Snapshot services

Services

Services

System services


Services


01-25-2005 Page B - 13





Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Directed pickup call S No No Yes NoGroup pickup call S No No Yes NoHold call S Yes (Yes) Yes YesIntrude call S No No No NoJoin call NA No No No NoMake call E Yes Yes Yes YesMake predictive call S Yes No No YesPark call NA No No No NoReconnect call S Yes Yes Yes (Yes)Retrieve call S Yes (Yes) Yes YesSingle step conference call NA No No No NoSingle step transfer call S Yes No Yes (No)Transfer call S Yes Yes Yes Yes

Bridged NA No No No NoCall cleared S No No No NoConferenced S Yes Yes Yes YesConnection cleared S Yes Yes Yes YesDelivered S Yes Yes Yes YesDigits dialed S Yes No No NoDiverted S Yes Yes Yes YesEstablished S Yes Yes Yes YesFailed S Yes Yes Yes YesHeld S Yes Yes Yes YesNetwork capabilities changed S No Yes 4.0 No NoNetwork reached S Yes Yes Yes YesOffered NA No No No NoOriginated S Yes Yes Yes YesQueued S Yes Yes Yes YesRetrieved S Yes Yes Yes YesService initiated S Yes Yes Yes YesTransferred S Yes Yes Yes Yes

Associate data NA No No No NoCancel telephony tones NA No No No NoGenerateDigits S Yes Yes Yes NoGenerate telephony tones S Yes No No NoSend user information S Yes No No No

Call information S Yes Yes No YesCharging S No No Yes NoDigits generated S Yes No No NoTelephony tones generated S Yes No No No

Services

Events

Events


01-25-2005 Page B - 14





Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Service completion failure NA No No No No

Attach media service NA No No No NoDetach media service NA No No No No

Media attached NA No No No NoMedia detached NA No No No No

Route register S Yes No No NoRoute register abort NA No No No NoRoute register cancel S Yes No No No

Re-Route S No Yes No YesRoute end S No** Yes No YesRoute reject S No No No NoRoute request S No** Yes No YesRoute select S No** Yes No YesRoute used S No No No Yes

Button press S No No Yes NoGet auditory apparatus information NA No No No NoGet button information S No No Yes NoGet display NA No No No NoGet hookswitch status S No No Yes NoGet lamp information NA No No No NoGet lamp mode NA No No No NoGet message waiting indicator S Yes No Yes NoGet microphone gain NA No No No NoGet microphone mute S No No Yes NoGet ringer status NA No No No NoGet speaker mute S No No Yes NoGet speaker volume S No No Yes NoSet button information NA No No No NoSet display S Yes No Yes NoSet hookswitch status NA No No No NoSet lamp mode S Yes No Yes NoSet message waiting indicator S Yes ? Yes NoSet microphone gain NA No No No NoSet microphone mute S No No Yes NoSet ringer status NA No No No No


Services

Events

Routing services


Services


Services

01-25-2005 Page B - 15





Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Set speaker mute S No No Yes NoSet speaker volume S No No Yes No

Button information NA No No No NoButton press S No No Yes NoDisplay updated NA No No No NoHookswitch S No No Yes NoLamp mode NA No No No NoMessage waiting S Yes No Yes NoMicrophone gain NA No No No NoMicrophone mute NA No No No NoRinger status NA No No No NoSpeaker mute NA No No No NoSpeaker volume NA No No No No

Call back non-call-related NA No No No NoCall back message non-call-related S No No Yes NoCancel call back S Yes No No NoCancel call back message S No No Yes NoGet agent state A Yes Yes Yes YesGet auto answer S No No Yes NoGet auto work mode S No No Yes NoGet caller id status S No No Yes NoGet do not disturb S Yes Yes Yes NoGet forwarding S Yes Yes Yes NoGet last number dialled NA Yes No No NoGet routeing mode S No No No NoSet agent state A Yes Yes Yes YesSet auto answer NA No No No NoSet auto work mode NA No No No NoSet caller id status S No No Yes NoSet do not disturb S Yes No Yes NoSet forwarding S Yes Yes Yes NoSet routeing mode S Yes No No No

Agent busy A Yes No Yes YesAgent logged off A Yes Yes Yes YesAgent logged on A Yes Yes Yes YesAgent not ready A Yes Yes Yes YesAgent ready A Yes Yes Yes YesAgent working after call A Yes Yes Yes YesAuto answer NA No No No NoAuto work mode NA No No No No

Services

Events

Events


01-25-2005 Page B - 16





Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Call back S Yes No No NoCall back message NA No No No NoCaller id status NA No No No NoDo not disturb S Yes Yes Yes NoForwarding S Yes Yes Yes NoRouteing mode S Yes No No No

Back in service E Yes No Yes NoDevice capabilities changed NA No No No NoOut of service E Yes No Yes No

I/O register S Yes No No NoI/O register abort NA No No No NoI/O register cancel S Yes No No No

Data path resumed S Yes No No NoData path suspended S Yes No No NoFast data S Yes No No NoResume data path NA No No No NoSend broadcast data NA No No No NoSend data S Yes No Yes NoSend multicast data NA No No No NoStart data path S Yes No Yes NoStop data path S Yes No Yes NoSuspend data path NA No No No No

Data Collected NA No No No NoData Collection Resumed NA No No No NoData Collection Suspended NA No No No NoResume Data Collection NA No No No NoStart Data Collection NA No No No NoStop Data Collection NA No No No NoSuspend Data Collection NA No No No No

Concatenate message NA No No No NoDelete message NA No No No NoPlay message S No No Yes NoQuery voice attribute NA No No No NoRecord message NA No No No No

Services


Services

I/O services


Services



Events

01-25-2005 Page B - 17





Lic

ense

Sie

men

s H

iPat

h 4

000

sin

gle

do

mai

n n

ativ

e m

od

e

Sie

men

s H

ico

m 3

00

Sie

men

s H

iPat

h 3

000

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Reposition NA No No No NoResume NA No No No NoReview NA No No No NoSet voice attribute NA No No No NoStop S No No Yes NoSuspend NA No No No NoSynthesize message NA No No No No

Play S No No Yes NoRecord NA No No No NoReview NA No No No NoStop S No No Yes NoSuspend play NA No No No NoSuspend record NA No No No NoVoice attribute changed NA No No No No

Call detail records notification NA No No No NoCall detail records report S No No Yes NoSend stored call detail records NA No No No NoStart call detail records transmission S No No Yes NoStop call detail records transmission S No No Yes No

Escape register NA No No No NoEscape register abort NA No No No NoEscape register cancel NA No No No No

Escape S Yes Yes Yes YesSet lower Class of Service S Yes No No NoGet lower Class of Service S Yes No No NoPrivate Data Version Selection S Yes No No No

Private Event NA Yes ? No ?

Events

Events




Services

01-25-2005 Page B - 18

HiPath CAP V3.0 Supported Functions TAPI

CAP V3.0TAPI Feature Set



Lic

ense

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000/

5000

V4.

0 / V

5.0

tapiGetLocationInfo S Yes Yes Yes YestapiRequestDrop NAtapiRequestMakeCall E Yes Yes Yes YestapiRequestMediaCall NA

lineAnswer S Yes Yes Yes YeslineClose E Yes Yes Yes YeslineConfigDialog S Yes Yes Yes YeslineConfigDialogEdit NAlineDeallocateCall S Yes Yes Yes YeslineDial S Yes Yes Yes YeslineDrop S Yes Yes Yes YeslineGetAddressCaps S Yes Yes Yes YeslineGetAddressID S Yes Yes Yes YeslineGetAddressStatus S Yes Yes Yes YeslineGetCallInfo S Yes Yes Yes YeslineGetCallStatus S Yes Yes Yes YeslineGetConfRelatedCalls S Yes Yes Yes YeslineGetCountry S Yes Yes Yes YeslineGetDevCaps S Yes Yes Yes YeslineGetDevConfig NAlineGetIcon NAlineGetID S No No No NolineGetLineDevStatus S Yes Yes Yes YeslineGetMessage S Yes Yes Yes YeslineGetNewCalls S Yes Yes Yes YeslineGetNumRings NAlineGetRequest S Yes Yes Yes YeslineGetStatusMessages S Yes Yes Yes YeslineGetTranslateCaps S Yes Yes Yes YeslineHandoff S Yes Yes Yes YeslineInitialize E Yes Yes Yes YeslineInitializeEx E Yes Yes Yes YeslineMakeCall E Yes Yes Yes YeslineNegotiateAPIVersion E Yes Yes Yes YeslineOpen E Yes Yes Yes YeslineRegisterRequestRecipient S Yes Yes Yes YeslineSetAppSpecific S Yes Yes Yes YeslineSetCallPrivilege S Yes Yes Yes YeslineSetCurrentLocation S No No No NolineSetDevConfig NAlineSetNumRings NAlineSetStatusMessages S Yes Yes Yes Yes

Assisted Telephony Services Functions

Basic Telephony Services Functions

01-25-2005 Page C - 19





Lic

ense

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000/

5000

V4.

0 / V

5.0

lineSetTollList S Yes Yes Yes YeslineShutdown E Yes Yes Yes YeslineTranslateAddress S Yes Yes Yes YeslineTranslateDialog S Yes Yes Yes Yes

lineAccept S Yes Yes Yes YeslineAddProvider S Yes Yes Yes YeslineAddToConference S Yes Yes Yes YeslineAgentSpecific A Yes Yes Yes YeslineBlindTransfer SlineCompleteCall(MODE_CAMPON) NAlineCompleteCall(MODE_CALLBACK) S Yes YeslineCompleteCall(MODE_INTRUDE) NAlineCompleteCall(MODE_MESSAGE) NAlineCompleteTransfer(CONFERENCE) S Yes Yes Yes YeslineCompleteTransfer(TRANSFER) S Yes Yes Yes YeslineConfigProvider S Yes Yes Yes YeslineForward (MODE_UNCOND) S Yes Yes Yes YeslineForward (MODE_BUSY) S Yes Yes YeslineForward (MODE_NOANSW) S Yes Yes YeslineForward (MODE_BUSYINTERNAL) S YeslineForward (MODE_BUSYEXTERNAL) S YeslineForward (MODE_NOANSWINTERNAL) S YeslineForward (MODE_NOANSWEXTERNAL) S YeslineForward (MODE_UNCONDINTERNAL) S Yes Yes YeslineForward (MODE_UNCONDEXTERNAL) S Yes Yes YeslineGatherDigits NAlineGenerateDigits NAlineGenerateTone NAlineGetAgentActivityList A Yes Yes Yes YeslineGetAgentCaps A Yes Yes Yes YeslineGetAgentGroupList A Yes Yes Yes YeslineGetAgentStatus A Yes Yes Yes YeslineGetAppPriority S Yes Yes Yes YeslineGetProviderList S Yes Yes Yes YeslineHold S Yes Yes Yes YeslineMonitorDigits NAlineMonitorMedia NAlineMonitorTones NAlinePark DIRECT NAlinePark NONDIRECT NAlinePickup (lpszGroupID == NULL) S YeslinePickup (lpszGroupID != NULL) S YeslinePrepareAddToConference S Yes Yes Yes Yes

Supplementary Telephony Services Functions

01-25-2005 Page C - 20





Lic

ense

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000/

5000

V4.

0 / V

5.0

lineProxyMessage S Yes Yes Yes YeslineProxyResponse S Yes Yes Yes YeslineRedirect S Yes Yes YeslineReleaseUserUserInfo NAlineRemoveFromConference S Yes Yes YeslineRemoveProvider S Yes Yes Yes YeslineSecureCall NAlineSendUserUserInfo NAlineSetAgentActivity A Yes Yes Yes YeslineSetAgentGroup NAlineSetAgentState A Yes Yes Yes YeslineSetAppPriority S Yes Yes Yes YeslineSetCallData S Yes Yes Yes YeslineSetCallParams NAlineSetCallQualityOfService NAlineSetCallTreatment NAlineSetLineDevStatus NAlineSetMediaControl NAlineSetMediaMode NAlineSetTerminal NAlineSetupConference S Yes Yes Yes YeslineSetupTransfer S Yes Yes Yes YeslineSwapHold S Yes Yes Yes YeslineUncompleteCall NAlineUnhold S Yes Yes Yes YeslineUnpark DIRECT NAlineUnpark NONDIRECT NA

phoneClose S Yes Yes Yes YesphoneConfigDialog S Yes Yes Yes YesphoneGetButtonInfo NAphoneGetData S Yes Yes Yes YesphoneGetDevCaps S Yes Yes Yes YesphoneGetDisplay NAphoneGetGain NAphoneGetHookSwitch NAphoneGetIcon NAphoneGetID S Yes Yes Yes YesphoneGetLamp NAphoneGetMessage S Yes Yes Yes YesphoneGetRing NAphoneGetStatus S Yes Yes Yes YesphoneGetStatusMessages S Yes Yes Yes YesphoneGetVolume NA

Phone Services

01-25-2005 Page C - 21





Lic

ense

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000/

5000

V4.

0 / V

5.0

phoneInitialize E Yes Yes Yes YesphoneInitializeEx E Yes Yes Yes YesphoneNegotiateAPIVersion E Yes Yes Yes YesphoneOpen E Yes Yes Yes YesphoneSetButtonInfo NAphoneSetData S Yes Yes Yes YesphoneSetDisplay SphoneSetGain NAphoneSetHookSwitch NAphoneSetLamp S Yes Yes YesphoneSetRing NAphoneSetStatusMessages S Yes Yes Yes YesphoneSetVolume NAphoneShutdown E Yes Yes Yes Yes

lineDevSpecific NAlineDevSpecificFeature S Yes Yes Yes YeslineNegotiateExtVersion S Yes Yes Yes YesphoneDevSpecific NAphoneNegotiateExtVersion S Yes Yes Yes Yes

LINE_ADDRESSSTATE S Yes Yes Yes YesLINE_AGENTSPECIFIC S Yes Yes Yes YesLINE_AGENTSTATUS S Yes Yes Yes YesLINE_APPNEWCALL S Yes Yes Yes YesLINE_CALLINFO S Yes Yes Yes YesLINE_CALLSTATE S Yes Yes Yes YesLINE_CLOSE E Yes Yes Yes YesLINE_CREATE E Yes Yes Yes YesLINE_DEVSPECIFIC NALINE_DEVSPECIFICFEATURE NALINE_GATHERDIGITS NALINE_GENERATE NALINE_LINEDEVSTATE S Yes Yes Yes YesLINE_MONITORDIGITS NALINE_MONITORMEDIA NALINE_MONITORTONE NALINE_PROXYREQUEST A Yes Yes Yes YesLINE_REMOVE E Yes Yes Yes YesLINE_REPLY E Yes Yes Yes YesLINE_REQUEST E Yes Yes Yes Yes

Line Device Messages

Extended Telephony Services

01-25-2005 Page C - 22





Lic

ense

Sie

men

s H

iPat

h 4

000

V1.

0

Sie

men

s H

iPat

h 4

000

V2.

0

Sie

men

s H

ico

m 3

00 H

V1.

0

Sie

men

s H

iPat

h 3

000/

5000

V4.

0 / V

5.0

PHONE_BUTTON NAPHONE_CLOSE S Yes Yes Yes YesPHONE_CREATE S Yes Yes Yes YesPHONE_DEVSPECIFIC NAPHONE_REMOVE S Yes Yes Yes YesPHONE_REPLY S Yes Yes Yes YesPHONE_STATE NA

Phone Device Messages

01-25-2005 Page C - 23





Lic

ense

tapiGetLocationInfo StapiRequestDrop NAtapiRequestMakeCall EtapiRequestMediaCall NA

lineAnswer SlineClose ElineConfigDialog SlineConfigDialogEdit NAlineDeallocateCall SlineDial SlineDrop SlineGetAddressCaps SlineGetAddressID SlineGetAddressStatus SlineGetCallInfo SlineGetCallStatus SlineGetConfRelatedCalls SlineGetCountry SlineGetDevCaps SlineGetDevConfig NAlineGetIcon NAlineGetID SlineGetLineDevStatus SlineGetMessage SlineGetNewCalls SlineGetNumRings NAlineGetRequest SlineGetStatusMessages SlineGetTranslateCaps SlineHandoff SlineInitialize ElineInitializeEx ElineMakeCall ElineNegotiateAPIVersion ElineOpen ElineRegisterRequestRecipient SlineSetAppSpecific SlineSetCallPrivilege SlineSetCurrentLocation SlineSetDevConfig NAlineSetNumRings NAlineSetStatusMessages S

Assisted Telephony Services Functions

Basic Telephony Services Functions

Oct

op

us

E30

0/80

0 R

el 6

.5/1

0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

Yes Yes

Yes Yes

Yes Yes YesYes Yes YesYes Yes

Yes Yes YesNo Yes YesYes Yes YesYes Yes YesYes Yes YesYes Yes YesYes Yes YesYes Yes YesYes YesYes YesYes Yes Yes

No No YesYes Yes

? Yes? Yes Yes

Yes YesYes Yes Yes

YesYes

Yes YesYes Yes YesYes Yes YesYes YesYes Yes Yes

YesYes YesYes YesNo No

Yes Yes Yes

01-25-2005 Page C - 24





Lic

ense

lineSetTollList SlineShutdown ElineTranslateAddress SlineTranslateDialog S

lineAccept SlineAddProvider SlineAddToConference SlineAgentSpecific AlineBlindTransfer SlineCompleteCall(MODE_CAMPON) NAlineCompleteCall(MODE_CALLBACK) SlineCompleteCall(MODE_INTRUDE) NAlineCompleteCall(MODE_MESSAGE) NAlineCompleteTransfer(CONFERENCE) SlineCompleteTransfer(TRANSFER) SlineConfigProvider SlineForward (MODE_UNCOND) SlineForward (MODE_BUSY) SlineForward (MODE_NOANSW) SlineForward (MODE_BUSYINTERNAL) SlineForward (MODE_BUSYEXTERNAL) SlineForward (MODE_NOANSWINTERNAL) SlineForward (MODE_NOANSWEXTERNAL) SlineForward (MODE_UNCONDINTERNAL) SlineForward (MODE_UNCONDEXTERNAL) SlineGatherDigits NAlineGenerateDigits NAlineGenerateTone NAlineGetAgentActivityList AlineGetAgentCaps AlineGetAgentGroupList AlineGetAgentStatus AlineGetAppPriority SlineGetProviderList SlineHold SlineMonitorDigits NAlineMonitorMedia NAlineMonitorTones NAlinePark DIRECT NAlinePark NONDIRECT NAlinePickup (lpszGroupID == NULL) SlinePickup (lpszGroupID != NULL) SlinePrepareAddToConference S

Supplementary Telephony Services Functions

Oct

op

us

E30

0/80

0 R

el 6

.5/1

0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

YesYes Yes YesYes YesYes Yes

Yes Yes YesYes YesYes YesNo YesNo YesYes ?Yes ?Yes ?

?Yes Yes ?Yes Yes ?Yes YesNoNoNoNoNoNoNoNoNo

YesYes

No YesNo YesNo YesNo YesYes YesYes Yes YesYes Yes Yes

Yes

Yes

NoNoYes Yes

01-25-2005 Page C - 25





Lic

ense

lineProxyMessage SlineProxyResponse SlineRedirect SlineReleaseUserUserInfo NAlineRemoveFromConference SlineRemoveProvider SlineSecureCall NAlineSendUserUserInfo NAlineSetAgentActivity AlineSetAgentGroup NAlineSetAgentState AlineSetAppPriority SlineSetCallData SlineSetCallParams NAlineSetCallQualityOfService NAlineSetCallTreatment NAlineSetLineDevStatus NAlineSetMediaControl NAlineSetMediaMode NAlineSetTerminal NAlineSetupConference SlineSetupTransfer SlineSwapHold SlineUncompleteCall NAlineUnhold SlineUnpark DIRECT NAlineUnpark NONDIRECT NA

phoneClose SphoneConfigDialog SphoneGetButtonInfo NAphoneGetData SphoneGetDevCaps SphoneGetDisplay NAphoneGetGain NAphoneGetHookSwitch NAphoneGetIcon NAphoneGetID SphoneGetLamp NAphoneGetMessage SphoneGetRing NAphoneGetStatus SphoneGetStatusMessages SphoneGetVolume NA

Phone Services

Oct

op

us

E30

0/80

0 R

el 6

.5/1

0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

No YesNo YesYes Yes Yes

YesYes Yes Yes

No YesNoNo YesYes YesNo Yes

Yes Yes YesYes Yes YesYes YesNoYes Yes Yes

No YesNo YesNoNo YesNo YesNoNoNoNoNo YesNoNo YesNoNo YesNo YesNo

01-25-2005 Page C - 26





Lic

ense

phoneInitialize EphoneInitializeEx EphoneNegotiateAPIVersion EphoneOpen EphoneSetButtonInfo NAphoneSetData SphoneSetDisplay SphoneSetGain NAphoneSetHookSwitch NAphoneSetLamp SphoneSetRing NAphoneSetStatusMessages SphoneSetVolume NAphoneShutdown E

lineDevSpecific NAlineDevSpecificFeature SlineNegotiateExtVersion SphoneDevSpecific NAphoneNegotiateExtVersion S

LINE_ADDRESSSTATE SLINE_AGENTSPECIFIC SLINE_AGENTSTATUS SLINE_APPNEWCALL SLINE_CALLINFO SLINE_CALLSTATE SLINE_CLOSE ELINE_CREATE ELINE_DEVSPECIFIC NALINE_DEVSPECIFICFEATURE NALINE_GATHERDIGITS NALINE_GENERATE NALINE_LINEDEVSTATE SLINE_MONITORDIGITS NALINE_MONITORMEDIA NALINE_MONITORTONE NALINE_PROXYREQUEST ALINE_REMOVE ELINE_REPLY ELINE_REQUEST E

Line Device Messages

Extended Telephony ServicesO

cto

pu

s E

300/

800

Rel

6.5

/10

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

No YesNo YesNo YesNo YesNoNo YesNoNoNoNoNoNo YesNoNo Yes

Yes YesYes YesNoNo Yes

Yes YesNo YesNo YesYes YesYes YesYes YesYes YesYes Yes

Yes Yes

NoYes YesYes YesYes Yes

01-25-2005 Page C - 27





Lic

ense

PHONE_BUTTON NAPHONE_CLOSE SPHONE_CREATE SPHONE_DEVSPECIFIC NAPHONE_REMOVE SPHONE_REPLY SPHONE_STATE NA

Phone Device Messages

Oct

op

us

E30

0/80

0 R

el 6

.5/1

0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P V

3.0

Ste

p 1

NoNo YesNo YesNoNo YesNo Yes

01-25-2005 Page C - 28

HiPath CAP V3.0 Supported Functions JTAPI

CAP V3.0

JTAPI Feature Set


Sie

men

s H

iPat

h 4

000

V 1

.0

Sie

men

s H

iPat

h 4

000

V 2

.0

Sie

men

s H

ico

m 3

00 H

V 1

.0

Sie

men

s H

iPat

h 3

000/

5000

V 4

.0 /

V 5

.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

getName Yes Yes YesgetProvider Yes Yes YesgetCapabilities Yes Yes YesgetConnections Yes Yes YesgetObservers Yes Yes YesremoveObserver Yes Yes YesaddCallListener Yes Yes YesgetCallListeners Yes Yes YesremoveCallListener Yes Yes YesgetTerminals Yes Yes YesaddCallObserver Yes Yes YesgetCallObservers Yes Yes YesremoveCallObserver Yes Yes YesgetAddressCapabilities Yes Yes YesaddAddressListener Yes Yes YesgetAddressListeners Yes Yes YesremoveAddressListener Yes Yes Yes

addressChangedEvent Yes Yes Yes

connect Yes Yes YesgetProvider Yes Yes YesgetState Yes Yes YesgetCapabilities Yes Yes YesgetConnections Yes Yes YesaddObserver Yes Yes YesgetObservers Yes Yes YesremoveObserver Yes Yes YesgetCallCapabilities Yes Yes YesaddCallListener Yes Yes YesgetCallListeners Yes Yes YesremoveCallListener Yes Yes Yes

callChangedEvent Yes Yes Yes

disconnect Yes Yes YesgetState Yes Yes YesgetAddress Yes Yes YesgetCapabilities Yes Yes YesgetTerminalConnections Yes Yes YesgetCall Yes Yes YesgetConnectionCapabilities Yes Yes Yes

CallObserver

Connection

Address

AddressObserver

Call

01-25-2005 Page D - 29


CAP V3.0

JTAPI Feature Set


Sie

men

s H

iPat

h 4

000

V 1

.0

Sie

men

s H

iPat

h 4

000

V 2

.0

Sie

men

s H

ico

m 3

00 H

V 1

.0

Sie

men

s H

iPat

h 3

000/

5000

V 4

.0 /

V 5

.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

getName Yes Yes Yes Yes YesgetProvider Yes Yes Yes Yes YesgetServices Yes Yes Yes Yes Yes

getJtapiPeer Yes Yes Yes Yes YesgetDefaultJtapiPeerName Yes Yes Yes Yes Yes

shutdown Yes Yes YesgetName Yes Yes YesgetState Yes Yes YesgetAddress Yes Yes YesgetTerminal Yes Yes YesgetCapabilities Yes Yes YesgetTerminalConnectionCapabilities(Terminal) Yes Yes YesgetTerminalConnectionCapabilities() Yes Yes YesaddObserver Yes Yes YesgetObservers Yes Yes YesremoveObserver Yes Yes YesgetCallCapabilities(Address) Yes Yes YesgetCallCapabilities() Yes Yes YesgetTerminals Yes Yes YesgetAddressCapabilities() Yes Yes YesgetAddressCapabilities(Terminal) Yes Yes YesgetAddresses Yes Yes YesgetTerminalCapabilities(Terminal) Yes Yes YesgetTerminalCapabilities() Yes Yes YesgetConnectionCapabilities() Yes Yes YesgetConnectionCapabilities(Terminal,Address) Yes Yes YesgetCalls Yes Yes YescreateCall Yes Yes YesgetProviderCapabilities() Yes Yes YesgetProviderCapabilities(Terminal) Yes Yes YesaddProviderListener Yes Yes YesgetProviderListeners Yes Yes YesremoveProviderListener Yes Yes Yes

Provider

JtapiPeer

JtapiPeerFactory

01-25-2005 Page D - 30


CAP V3.0

JTAPI Feature Set


Sie

men

s H

iPat

h 4

000

V 1

.0

Sie

men

s H

iPat

h 4

000

V 2

.0

Sie

men

s H

ico

m 3

00 H

V 1

.0

Sie

men

s H

iPat

h 3

000/

5000

V 4

.0 /

V 5

.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

providerChangedEvent Yes Yes Yes

getName Yes Yes YesgetProvider Yes Yes YesgetCapabilities Yes Yes YesaddObserver Yes Yes YesgetObservers Yes Yes YesremoveObserver Yes Yes YesaddCallListener Yes Yes YesgetCallListeners Yes Yes YesremoveCallListener Yes Yes YesaddCallObserver Yes Yes YesgetCallObservers Yes Yes YesremoveCallObserver Yes Yes YesgetAddresses Yes Yes YesgetTerminalConnections Yes Yes YesgetTerminalCapabilities Yes Yes YesaddTerminalListener Yes Yes YesgetTerminalListeners Yes Yes YesremoveTerminalListener Yes Yes Yes

getConnection Yes Yes YesgetState Yes Yes YesgetTerminal Yes Yes Yesanswer Yes Yes YesgetCapabilities Yes Yes YesgetTerminalConnectionCapabilities Yes Yes Yes

terminalChangedEvent Yes Yes Yes

TerminalObserver

Call Control package

Supported methods for package javax.telephony.callcontrol

Class name

ProviderObserver

Terminal

TerminalConnection

01-25-2005 Page D - 31


CAP V3.0

JTAPI Feature Set


Sie

men

s H

iPat

h 4

000

V 1

.0

Sie

men

s H

iPat

h 4

000

V 2

.0

Sie

men

s H

ico

m 3

00 H

V 1

.0

Sie

men

s H

iPat

h 3

000/

5000

V 4

.0 /

V 5

.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

setForwarding No No No No NogetForwarding No No No No NocancelForwarding No No No No NogetDoNotDisturb No No No No NosetDoNotDisturb No No No No NogetMessageWaiting No No No No NosetMessageWaiting No No No No No

drop Yes Yes YesgetCallingAddress Yes Yes YesgetCallingTerminal Yes Yes YesgetCalledAddress Yes Yes YesgetLastRedirectedAddress Yes Yes YesaddParty No No No No NooffHook No No No No Noconference Yes Yes Yestransfer Yestransfer YessetConferenceController No No No No NogetConferenceController YessetTransferController NogetTransferController YessetConferenceEnable NogetConferenceEnable YessetTransferEnable NogetTransferEnable Yesconsult(TerminalConnection) Yesconsult(TerminalConnection,String) Yes

accept YesgetCallControlState Yesreject Yesredirect YesaddToAddress Yespark Yes

getType YesgetDestinationAddress YesgetFilter YesgetSpecificCaller Yes

CallControlForwarding

CallControlAddress

CallControlCall

CallControlCallObserver

CallControlConnection

01-25-2005 Page D - 32


CAP V3.0

JTAPI Feature Set


Sie

men

s H

iPat

h 4

000

V 1

.0

Sie

men

s H

iPat

h 4

000

V 2

.0

Sie

men

s H

ico

m 3

00 H

V 1

.0

Sie

men

s H

iPat

h 3

000/

5000

V 4

.0 /

V 5

.0

HiP

ath

DX

/ R

ealit

is D

Xvi

a C

allB

rid

ge

DX

8.0

getDoNotDisturb YessetDoNotDisturb Yespickup(Address) Yespickup(Address,Address) Yespickup(Connection,Address) YespickupFromGroup(Address) YespickupFromGroup(String,Address) Yes

join YesgetCallControlState Yeshold Yesunhold Yesleave Yes

CallControlAddressCapabilities YesCallControlCallCapabilities YesCallControlConnectionCapabilities YesCallControlTerminalCapabilities YesCallControlTerminalConnectionCapabilities Yes

Call Control Capabilities package;

Supported classes in package javax.telephony.callcontrol.capabilities

Class name

CallControlTerminal

CallControlTerminalConnection

CallControlTerminalObserver

01-25-2005 Page D - 33


CAP V3.0

JTAPI Feature Set


getNamegetProvidergetCapabilitiesgetConnectionsgetObserversremoveObserveraddCallListenergetCallListenersremoveCallListenergetTerminalsaddCallObservergetCallObserversremoveCallObservergetAddressCapabilitiesaddAddressListenergetAddressListenersremoveAddressListener

addressChangedEvent

connectgetProvidergetStategetCapabilitiesgetConnectionsaddObservergetObserversremoveObservergetCallCapabilitiesaddCallListenergetCallListenersremoveCallListener

callChangedEvent

disconnectgetStategetAddressgetCapabilitiesgetTerminalConnectionsgetCallgetConnectionCapabilities

CallObserver

Connection

Address

AddressObserver

Call

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P 3

.0 S

tep

1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

No Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes Yes

No Yes Yes

No Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes YesNo Yes Yes

No Yes Yes

No YesNo YesNo YesNo YesNo YesNo YesNo Yes

01-25-2005 Page D - 34


CAP V3.0

JTAPI Feature Set


getNamegetProvidergetServices

getJtapiPeergetDefaultJtapiPeerName

shutdowngetNamegetStategetAddressgetTerminalgetCapabilitiesgetTerminalConnectionCapabilities(Terminal)getTerminalConnectionCapabilities()addObservergetObserversremoveObservergetCallCapabilities(Address)getCallCapabilities()getTerminalsgetAddressCapabilities()getAddressCapabilities(Terminal)getAddressesgetTerminalCapabilities(Terminal)getTerminalCapabilities()getConnectionCapabilities()getConnectionCapabilities(Terminal,Address)getCallscreateCallgetProviderCapabilities()getProviderCapabilities(Terminal)addProviderListenergetProviderListenersremoveProviderListener

Provider

JtapiPeer

JtapiPeerFactory

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P 3

.0 S

tep

1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

Yes Yes YesNo Yes YesYes Yes Yes

Yes Yes YesYes Yes Yes

No YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo Yes

01-25-2005 Page D - 35


CAP V3.0

JTAPI Feature Set


providerChangedEvent

getNamegetProvidergetCapabilitiesaddObservergetObserversremoveObserveraddCallListenergetCallListenersremoveCallListeneraddCallObservergetCallObserversremoveCallObservergetAddressesgetTerminalConnectionsgetTerminalCapabilitiesaddTerminalListenergetTerminalListenersremoveTerminalListener

getConnectiongetStategetTerminalanswergetCapabilitiesgetTerminalConnectionCapabilities

terminalChangedEvent

TerminalObserver

Call Control package

Supported methods for package javax.telephony.ca

Class name

ProviderObserver

Terminal

TerminalConnection

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P 3

.0 S

tep

1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

No Yes

No YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo YesNo Yes

No YesNo YesNo YesNo YesNo YesNo Yes

No Yes

01-25-2005 Page D - 36


CAP V3.0

JTAPI Feature Set


setForwardinggetForwardingcancelForwardinggetDoNotDisturbsetDoNotDisturbgetMessageWaitingsetMessageWaiting

dropgetCallingAddressgetCallingTerminalgetCalledAddressgetLastRedirectedAddressaddPartyoffHookconferencetransfertransfersetConferenceControllergetConferenceControllersetTransferControllergetTransferControllersetConferenceEnablegetConferenceEnablesetTransferEnablegetTransferEnableconsult(TerminalConnection)consult(TerminalConnection,String)

acceptgetCallControlStaterejectredirectaddToAddresspark

getTypegetDestinationAddressgetFiltergetSpecificCaller

CallControlForwarding

CallControlAddress

CallControlCall

CallControlCallObserver

CallControlConnection

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P 3

.0 S

tep

1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

No No NoNo No NoNo No NoNo No NoNo No NoNo No NoNo No No

No YesNo YesNo YesNo YesNo YesNo No NoNo No NoNo Yes

No No No

01-25-2005 Page D - 37


CAP V3.0

JTAPI Feature Set


getDoNotDisturbsetDoNotDisturbpickup(Address)pickup(Address,Address)pickup(Connection,Address)pickupFromGroup(Address)pickupFromGroup(String,Address)

joingetCallControlStateholdunholdleave

CallControlAddressCapabilitiesCallControlCallCapabilitiesCallControlConnectionCapabilitiesCallControlTerminalCapabilitiesCallControlTerminalConnectionCapabilities

Call Control Capabilities package;

Supported classes in package javax.telephony.callc

Class name

CallControlTerminal

CallControlTerminalConnection

CallControlTerminalObserver

Med

ia E

xten

sio

n B

rid

ge

(ME

B)

CA

P 3

.0 S

tep

1

Alc

atel

440

0(O

mn

iPC

X E

nte

rpri

se)

Rel

. 5.1

No

rtel

M

erid

ian

1 S

yste

m S

oft

war

e R

el. 2

5S

ymp

osi

um

Cal

l Cen

ter

Ser

ver

Rel

. 3.0

01-25-2005 Page D - 38

hipath common application platform hipath cap v3.0 … management features, ... part of the siemens...

Documents