Akixi Installation Requirements (BroadWorks)

ballooncadgeInternet και Εφαρμογές Web

31 Οκτ 2013 (πριν από 3 χρόνια και 11 μήνες)

172 εμφανίσεις



Document Version:
1.0.0.14
,
Page
1

Of
4

Copyright
© 201
3

Aki
xi Limited, All Rights Reserved.

Akixi Installation Requirements (BroadWorks)

Introduction

This document
descr
ibes the
required activities
that should be
completed
by the
hosted telephony provider
or reseller
in order to support
Akixi hosted
reporting
services
for the provider’s c
ustomer
s
.
Please complete
the tasks specified in this document as follows:



Complete all configuration & information collection tasks specified by
this document.



Complete the information required in this page below

(as marked with a


character
)
.



Sign and return this document to Akixi.


Required Public
IP

Addresses

Please specify the following public IP addresses for the
BroadWorks

telephon
y

platform:

XSP Servers
1

(CTI Interface)
:



TCP

Port (
CTI Interface
):

8011

TL
S
/SSL

(

)
:


XSP Servers (OCI
-
P Provisioning Interface)
:



TCP

Port
(OCI
-
P Provisioning Interface):

2208

TL
S
/SSL

(

)
:



Provide XSP Server Application Context
Configuration

If modified, p
lease specify the deployment context paths for the “XSI Events” and “XSI Actions” applications

within the BroadWorks XSP Server’s Servlet container
:

XSI Events
:

/com.broadsoft.xsi
-
events

(Default)

XSI Actions:

/
com.broadsoft.xsi
-
actions

(Default)


Provide
OCI
-
P
Provisioning

User

Please specify
the AdministratorID of the
BroadWorks provisioning
user
, which has been
ideally
2

configured

for “
Provisioning
” (platform
-
wide)
read
-
access
privilege
s

for use with the Akixi service’s automatic
configuration synchronisation logic
. The user name with its fully qualified domain name should be specified:

User Name:

akixi
user
@[
d
omain
]


(Please
S
pecify
D
omain
N
ame)

Password:


BroadWorks Access Level:



Provide Service
Provider

/ Enterprise & Group IDs

Please specify as a comma
-
separated list the non
-
qualified ServiceProvi derID / EnterpriseID, and/or
GroupIDs of the customer telephony environments that the Akixi Service will monitor initially (please p
rovide
at least one ServiceProviderID / EnterpriseID even if it is the same for each separate GroupID):

EnterpriseID / ServiceProvi derID (s)
:


GroupID(s)
:



Signature

I have read this document in its entirety and I have completed the checklist as
marked above.

Signed (
Provider
):








1

If possible, specif
y
the IP address
es

of both XSP Server
s
if they exist as a
pair.

2

Refer to heading “
Akixi Integration Scope
” on page
3

for more information on choosing an appropriate BroadWorks user access level.













Document Version:
1.0.0.14
,
Page
2

Of
4

Copyright
© 201
3

Aki
xi Limited, All Rights Reserved.





Print Name:



Dated:


BroadWorks
Integration

Overview

The diagram below shows a typical
Akix
i

S
ervice
configuration hosted at public IP address 46.
46
.
46
.
46

monitoring a Broad
S
oft
BroadWorks
platform with
an XSP (
Xtended Services Platform
) server
public IP
address
of
2
0.
2
0.
2
0.
2
0.



BroadWorks Version Requirement

BroadWorks platform version Release 17 or above is required in order to support Akixi Service connectivity.

CTI Interface
Integration

In order to provide reporting functionality for customer environments configured on the
BroadWorks
platform,
the Akixi hosted service uses the
CTI Interface

in order to monitor devices that reside within
each c
ustomer’s
corresponding
telephony environment
.

Note that
the Akixi Service supports customer environments being
scoped as
either
an
entire Enterprise
/ Service Provider
or
an
individual Group within the underlying
BroadWorks platform.

CTI Interface Connector Installation

The CTI Interface Connector co
mponent must be correctly installed on
the
XSP Server
(s)
. Refer to
the
BroadWorks XSP Server installation documentation for instructions on how to do this or contact the
BroadSoft technical support team.

Once the CTI Interface Connector component is correctly installed, a Telnet command
made
to the XSP
Server
’s

IP address
specifically using
TCP
p
ort 8011
should
immediately depict
an XML
data
response
showing “
keepAlive
” message content
. An example of this
is shown
below

where
a Telnet command line of


Document Version:
1.0.0.14
,
Page
3

Of
4

Copyright
© 201
3

Aki
xi Limited, All Rights Reserved.


open 199.19.193.56 8011

was run
to an
XSP Server within
BroadSoft’s own public
development
Sandbox environment:



Required Application Server ACL Configuration

The following BroadWorks Access Control List (A
CL) configuration must be set in order to enable the XSP
Server’s CTI Interface connectivity:



Ensure that valid
network
ACL
entr
ies

are
present
at

AS_CLI/System/NetworkAccessLists

/OCI/CallControl/>


depicting the
internal address(es) of the
telephony pla
tform’s
XSP Server(s)
.



Ensure that both the “
com.broadsoft.xsi
-
events
” and “
com.broadsoft.xsi
-
actions

application

identifie
r
s are both present within the
OCI call control application list

using the following CLI
command:

Note that by default on new
telephony platform installations, only
the

com.broadsoft.xsi
-
actions

applica
tion identifier will be present and you need to manually add the xsi
-
events application, e.g.

AS_CLI/Interface/OCI/CallControl> add com.broadsoft.xsi
-
events true 8 8
"
BroadSoft
XSI Web App
"
”.



Note also that unless there is a specific requirement, one doesn’t need to create application
-
specific
network ACL entries for the above application identifiers, e.g. creating network ACL entries at

AS_CLI/System/NetworkAccessLists/OCI/Call
Control/Application>


for
each
application

w
ould
not

specifically be required on a standard installation
.

Note:

The Telnet response on TCP port 8011 for an XSP Server will always show correct “
keepAlive

message content
regardless

of whether
the above
BroadWorks ACL configuration has been correctly
complete
d

or not.

Therefore, you cannot assume that the platform’s application ACL configuration is
correctly
set
-
up
without specifically checking
via
the BroadWorks CLI.

Akixi CTI Interface Connectivity

T
he
Akixi hosted service
should

be configured with the
following details:



The public IP address
es

of
both
BroadWorks XSP (Xtended Services Platform) server
s
.



The TCP port being used for the CTI Interface communication.



The authentication details (user name wit
h fully qualified domain name
,

password) of a dedicated
BroadWorks provisioning user,
ideally
configured for “
Provisioning
” (platform
-
wide) privileges.



If modified, the
updated
context paths
should be specified
for the "XSI Events" and "XSI Actions"
applications within the BroadWorks XSP Server's Servlet container.

By default on a standard
AS_CLI/Interface/OCI/
CallControl> get


Application Id Enabled System Wide Description Notification Timeout Seconds Max Event Channels Per
Set

=============================================================================================================
===================

com.broadsoft.xsi
-
actions true BroadSoft XSI Web App 8 8

com.broadsoft.xsi
-
events true BroadSoft XSI Web App 30 8



Document Version:
1.0.0.14
,
Page
4

Of
4

Copyright
© 201
3

Aki
xi Limited, All Rights Reserved.

(unmodified) BroadWorks server deployment, these are usually set to “
/com.broadsoft.xsi
-
events

and “
/com.broadsoft.xsi
-
actio
ns
” respectively.


OCI
-
P

Integration

The
Akixi
S
ervice
also uses the OCI
-
P provisioning interface in order
to
automatically download the device
configuration for
telephone environments it is configured for
.

The
following information

is required
in order
fo
r
this
to work correctly
:



The public IP address
of
both
BroadWorks XSP (Xtended Services Platform) server
s
.



The TCP port being used for the OCI
-
P communication.



The authentication details (user name
with fully qualified domain name
,
password) of a
dedicate
d
BroadWorks provisioning user,
preferably
configured for “
Provisioning
” (platform
-
wide)
read
-
only
3

privileges.

This should be the same user that is used for the Akixi Service’s CTI Interface connectivity.

Akixi Integration Scope

Ideally, the Akixi

Service instance should be associated with the entire BroadWorks platform where all
Enterprise or Service Provider

entities

within the platform can
potentially
be monitored.

However in certain cases, the telephony provider may not actually be the maintainer of the underlying
BroadWorks platform, and therefore it only makes sense for the Akixi Service to
be associated with
the
provider’s
or even
the
customer’s
appropriate

subd
ivision


within
the
platform. In these instances, the
entire
Akixi Service can
be mapped to one of the BroadWorks platform access
/scope

levels specified
underneath
the “Provisioning” level
item
within the following table:

Table
1
:
A
kixi Integration Scope Options

Broad
S
oft
Access Level

Used For

Description

System

[Not Used]

Not used
-

Use “
Provisioning
” level instead.

Provisioning

Dedicated BroadWorks
Platforms


Use
d

when
the
telephony provider own
s

& maintains the
entire BroadWorks

platform.

Enterprise /

Service Provider

Platforms With Multiple Service
Providers Configured

Use
d

when the telephony provider doesn’t own the
BroadWorks platform, but maintains a subdivision within it as
a Service Provider.

Enterprise

Standalone
Customer
Environments

Used for standalone customer environments monitored using
the general multi
-
reseller/customer Akixi Service instance
(e.g. http://cirrus.akixi.com).

Group

Standalone Customer
Environments

Used for standalone customer environments monitored using
the general multi
-
reseller/customer Akixi Service instance
(e.g. http://cirrus.akixi.com).








3

No access is required f or BroadWorks network policies & web branding
,

but read
-
only access should be
permitted
on all other
BroadWorks components.