Akixi Installation Requirements (Broadsoft M6)

Introduction

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

Read this document.
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 Broadsoft M6 telephone platform:

Call Control Agent (For Voiss API):
UDP Port (For Voiss API): / 29051
Web & Administration Portal (For Admin API):
TCP Port (For Admin API): / 80 (HTTP)

Provide Administration API User

Please specify a Broadsoft M6 administration user with the required read & modify privileges for use with the Akixi service’s automatic configuration synchronisation logic:

User Name: / akixi
Password:

Signature

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

Signed (Reseller):
Print Name: / Dated:

Broadsoft M6 Integration Overview

The diagram below shows a typical Akixi service configuration hosted at public IP address 46.x.x.x monitoring a Broadsoft M6 platform with public IP addresses20.20.20.20 & 20.20.20.21 for the Broadsoft Voiss & Admin API interfaces respectively.

Voiss API Integration

In order to provide contact centre reporting functionality for customer environments configured on the Broadsoft M6 platform, the Akixi hosted service uses the Broadsoft Call Control (Voiss) API in order to monitor devices that reside within customer’s corresponding partition.

To achieve this, the Akixi hosted service must be configured with the following information:

The public IP address of the Broadsoft M6’s call control agent.
The partition for each customer environment that the Akixi reporting service is going to be provided for, additionally including its device configuration specified below with the full public telephone number of each corresponding device and also its security password if required:

Table 1: Required Device Configuration Details

Entity / Device Type / Required Information / Password Expiry Information / Can Be Obtained Automatically?
Partition /

Partition name.

/ Not applicable. / No. Note that the Akixi service’s Administration API integration logic requires that the partition name be specified exactly in order to work correctly.
Phone Users (Extensions) /

Public telephonenumber.
Device Name.
Security password.

/ User passwords should be left to expire normally.
The Administration API integration is used to temporarily “un-expire” passwords in order to monitor users where their password has already expired. / Yes via the Administration API integration, although you specifically need to choose to automatically add all phone users in the Akixi application.
Hunt Groups /

Public telephone number.
Device Name.

/ Not applicable. / Yes, occurs automatically via the Administration API integration.
ACD Queues /

Public telephone number.
Device Name.
Security password.

/ Passwords should be set to never expire in the Broadsoft configuration, although the Akixi service’sAdministration API integration logic is still used to temporarily “un-expire” passwords. / Yes, occurs automatically via the Administration API integration.
ACD Queue Members /

Public telephone number.
Device Name.

/ Not applicable. / Yes via the Administration API integration, although you specifically need to choose to automatically add ACD agents in the Akixi application.
Route Points /

Public telephone number.
Device Name.
Security password.

/ Passwords should be set to never expire in the Broadsoft configuration. / No. Route Points must be entered manually into the Akixi application configuration.
Voice Mail Retrieval /

Internal Dialling Address (Usually “555”).

/ Not applicable. / No, must be manually specified.
Voice Mail Leave /

Internal Dialling Address (Usually “577”).

/ Not applicable. / No, must be manually specified.

Administration API Integration

To make the device configuration management of the Akixi service as easy as possible, the service can be set to use the Broadsoft M6 Administration API in order to perform automatic configuration synchronisation with the Broadsoft platform.

By default, the synchronisation logic runs automatically about every 2 days for each partition specified in the Akixi application, but can be specifically requested to run almost immediately from within the partition administration web pages of the Akixi service (refer to the online Akixi documentation for more information on this).

For this functionality to be enabled, the Akixi hosted service must be configured with the following information:

The public IP address of the Broadsoft M6 server running the web administration portal.
The authentication details (user name & password) of a dedicated Broadsoft administration user with the following permissions:

Table 2: Administration API User Permissions

Broadsoft Component / Required Permissions
Partitions / Read
ACD Queue / Full Modify (Create Permissions Not Required Though)
Hunt Group / Full Modify (Create Permissions Not Required Though)
Users / Full Modify (Create Permissions Not Required Though)
Phones / Read

When the Akixi service is set to do configuration synchronisation via the Broadsoft M6 Administration API, the following operations are automatically performed:

Table 3: Automatic Configuration Synchronisation Actions

Operation / Description
Device Name & Password Synchronisation / The descriptions & monitor passwordsfor all types of devices that have previously been specified in the Akixi service configuration are automatically updated to reflect their configuration on the Broadsoft M6 platform.
Route points are excluded from this logic, and their description & monitor password must be specified manually in the Akixi service’s configuration.
Adding Hunt Groups / Hunt group devices are automatically added to the Akixi service configuration.
Hunt Group Membership / The phone membership of hunt groups in the Akixi service is automatically made to match the Broadsoft platform’s configuration, for all phone extensions that have previously been added to the Akixi configuration.
Adding ACD Queues / ACD queue devices are automatically added to the Akixi service configuration.
ACD Queue Membership / The phone membership of ACD queues in the Akixi service is automatically made to match the Broadsoft platform’s configuration, for all ACD agents that have previously been added to the Akixi configuration.
Password Expiry Management / When a phone extension or ACD device’s password has expired and that device cannot therefore be monitored via the Voiss API, the password value is set to temporarily “un-expire” for about 2 hours in order to allow the Akixi service enough time to attempt to re-monitor these devices.
Route points are excluded from this logic, and their monitor passwords should instead be set to never expire.

The following operations can also be performed by specifically requesting them from within the Akixi service’s administration web pages on a specific partition. Since the phone extension & ACD agent configuration of the Akixi service affects monthly billing charges for the corresponding customer telephony environment, these following operations have to be manually set to be performed by an Akixi administration user.

Table 4: Manual Configuration Synchronisation Actions

Operation / Description
Adding Phone User Extensions / All phone extension devices defined within the corresponding partition on the Broadsoft platform are automatically added to the Akixi service configuration.
Adding ACD Queue Phone Users (ACD Agents) / All phone users defined as being ACD queue members within the corresponding partition on the Broadsoft platform are automatically added to the Akixi service configuration.

Document Version: 1.0.0.3, Page 1 Of 4