New Voice XML Phone Configuration for Cisco Unified CallManager (UCM)

Table of Contents

• 1. Configuring the Cisco UCM
  
• 2. Configuring the New Voice XML Phone Application
  
• 3. Testing the New Voice XML Phone Application
• 4. Supported UCM Versions and Cisco IP Phones

1 Configuring the Cisco UCM

The New Voice XML phone application requires access to:

• All Cisco IP phones that are to display alarm information
• The Cisco UCM for translating the alarm phone number into the IP address of the corresponding Cisco IP phone(s)

IMPORTANT: The "Cisco AXL Web Service" must be active on the Cisco UCM!

1.1 Accessing the Cisco UCM

Log-in to "Cisco Unified CM Administration".

1.2 Creating the Application User and Assigning to IP Phones

Creating the application user (with login and password) ensures that the Cisco environment is able to identify the user and grant access. Assigning the user to the individual Cisco IP phones allows the New Voice XML phone application to directly control the phones and e.g. show alarm messages on the display.

Select "Application User" from the drop down menu.

Click on "Add New".

Complete the form and enter the following information:

• User ID (user name):
  newvoice
• Password/Confirm Password (same value for both fields):
  mobicall

Next, assign all Cisco IP phones that are to be controlled by the New Voice XML phone application to the list of "Controlled Devices".

Complete the user configuration by clicking on "Save".

1.3 Creating the User Group and Assigning to Application User

At this stage, the previously created application user is not allowed to access phone number and IP address information on the Cisco UCM. This may be changed by creating a user group with all the required roles (i.e. permissions) and assigning it to the application user.

REMARK: As of UCM 9, the name of the "User Group" is changed into "Access Control Group" and is found in the submenu "User Settings".

Select the "User Group" from the drop down menu.

Click on "Add New".

Enter the new group name NewVoiceAccess and click on "Save".

From the drop-down menu "Related link" select "Assign Role to User Group" and click on "Go".

There are currently no roles assigned. Continue by clicking on "Assign Role to Group".

The list of roles appears. If this is not the case, click on "Find" to display the list.

Activate the following roles in the list:

• Standard AXL API Access
• Standard CCM Admin Users
• Standard RealtimeAndTraceCollection

Click on "Add Selected".

Click "Save" to ensure the assigned roles are stored. Select "User Group" from the drop-down menu "Related Link" and click on "Go".

Click on "Add App Users to Group".

Enter "newvoice", the ID of the previously created application use, and click on "Find". In the shown list, activate the found entry and click on "Add Selected".

Click on "Save" to store all changes to the user group.

The application user is now allowed to access the Cisco UCM and to retrieve all required information.

1.4 Creating the New Voice Alarm Service

Select "Phone Services" from the drop down menu.

click on "Add new".

Complete the form and enter the following information:

• Service Name / ASCII Service Name (same value for both fields):
  New Voice Alarm
• Service Description:
  New Voice Alarm Processing Application
• Service URL / Secure-Service URL (same value for both fields):
  http://<MobiCall Server>/nvxmlphone/dev/start?dev=#DEVICENAME#
• Service Category:
  XML Service
• Service Type:
  Standard IP Phone Service
• Service Vendor:
  New Voice

Make sure to enable the service and activate "Enterprise Subscription" if the service is to be available on all (company-wide) IP phones. If the service should only be available on some distinct phones, disable "Enterprise Subscription" and assign the service individually to the corresponding IP phones.

Click on "Save".

In case company-wide service availability is activated, make sure to click on "Update Subscriptions". It may also be necessary to reset and/or restart the IP phones to make the "New Voice Alarm" service appear on the telephone screen.

On a 9971 model, the alarm service will look as follows:

On a 7970 model, the alarm service will look as follows:

2. Configuring the New Voice XML phone application

2.1 First Initialisation

Whenever the New Voice web is installed or the XML phone application has been updated, a (re-)initialisation must be carried by entering the following commands in the command line:

> cd /D d:\nv_web\nvapps\nvxmlphone
> app\console nvxmlphone:init

This operation will (re-)initialise the XML phone database and generate/update the file nvwxmlphone.ini .

2.2 XML Phone Application Settings

The configuration of the XML phone application is stored in the file nvwxmlphone.ini. To open the file, enter the following command in the command line:

> npi nvwxmlphone

Ensure that in the section "Cisco" the settings "CiscoUser" and "CiscoPassword" match with the previously created application user (on the Cisco UCM). Ensure also that the "CiscoUcmAddress" and the "MobiCallAddress" are correctly set.

IMPORTANT: Do NOT set the "CiscoUcmAddress" on MobiCall systems that are not connected to a Cisco environment.Leave empty or maintain the the default value.

2.3 Manual Registration of Cisco IP Phones

The registration of Cisco IP phones is usually done periodically (every hour) by the XML phone application. It may nevertheless become useful to do this manually, especially if there is no time to wait for the automatic update (e.g. during first time installation or Cisco environment changes).

Enter following commands in the command line:

> cd /D d:\nv_web\nvapps\nvxmlphone
> app\console nvxmlphone:cisco:register

3. Testing the New Voice XML Phone Application

3.1 Accessing the Phone Alarm List

3.2 Executing an XML Phone Text Alarm

3.3 Executing an XML Phone Image Alarm

3.4 Executing an XML Phone Camera Alarm

3.4 Executing an XML Phone Application Alarm

This alarm type is currently not supported

4. Supported Cisco UCM Versions and Cisco IP Phones

4.1 Cisco UCM Versions

4.2 Display Image Sizes and Color Depths

IMPORTANT: All phone models in the table below where "no" is indicated in the column "PNG-File" will only support alarms in plain text!