New Voice XML Phone Configuration for Cisco Unified CallManager (UCM){#top} ====================================================================== > Table of Contents > ----------------- > * [1. Configuring the Cisco UCM](#toc1) > * [2. Configuring the New Voice XML Phone Application](#toc2) > * [3. Testing the New Voice XML Phone Application](#toc3) > * [4. Supported UCM Versions and Cisco IP Phones](#toc4) 1 Configuring the Cisco UCM{#toc1} --------------------------------- 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". ![Cisco Main](images/cisco.png "Cisco Main") ### 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. ![Select Application User](images/cisco_user_01.png "Select Application User") Click on "Add New". ![Add New Application User](images/cisco_user_02.png "Add New Application User") 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". ![Save Application User](images/cisco_user_03.png "Save Application User") ### 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. ![Select User Group](images/cisco_group_01.png "Select User Group") Click on "Add New". ![Add New User Group](images/cisco_group_02.png "Add New User Group") Enter the new group name **NewVoiceAccess** and click on "Save". ![Save User Group](images/cisco_group_03.png "Save User Group") From the drop-down menu "Related link" select "Assign Role to User Group" and click on "Go". ![Assign Roles to User Group](images/cisco_group_04.png "Assign Roles to User Group") There are currently no roles assigned. Continue by clicking on "Assign Role to Group". ![Open Role Selection](images/cisco_group_05.png "Open Role Selection") 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". ![Select Roles](images/cisco_group_06.png "Select Roles") Click "Save" to ensure the assigned roles are stored. Select "User Group" from the drop-down menu "Related Link" and click on "Go". ![Back to User Group](images/cisco_group_07.png "Back to User Group") Click on "Add App Users to Group". ![Open User Assignment](images/cisco_group_08.png "Open User Assignment") 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". ![Select User](images/cisco_group_09.png "Select User") Click on "Save" to store all changes to the user group. ![User Group completed](images/cisco_group_10.png "User Group completed") 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. ![Select Phone Services](images/cisco_service_01.png "Select Phone Services") click on "Add new". ![IP Phone Service](images/cisco_service_02.png "Select Phone Services") 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://\/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". ![IP Phone Services Configuration](images/cisco_service_03.png "IP Phone Services Configuration") 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. ![IP Phone Services Configuration](images/cisco_service_04.png "IP Phone Services Configuration") On a 9971 model, the alarm service will look as follows: ![Service Example 9971](images/cisco_service_05.png "Service Example 9971") On a 7970 model, the alarm service will look as follows: ![Service Example 7970](images/cisco_service_06.png "Service Example 7970") 2. Configuring the New Voice XML phone application {#toc2} ------------------------------------------------------- ### 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{#toc3} ------------------------------------------- ### 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{#toc4} --------------------------------------------------- ### 4.1 Cisco UCM Versions | Version | Supported | |---------------|--------------------------------------------------------------| | 6.x and older | no | | 7.x | unsure (registration should work, alarm processing untested) | | 8.x | yes | | 9.x | yes | ### 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! | Phone Model | Normal (W x H) | Wide (W x H) | Type | PNG-File | |----------------|:--------------:|:------------:|:---------------:|:--------:| | 7905G | N/A | N/A | Gray (1bit) | no | | 7906G | N/A | N/A | Gray (1bit) | no | | 7911G | N/A | N/A | Gray (1bit) | no | | 7912G | N/A | N/A | Gray (1bit) | no | | 7931G | N/A | N/A | Gray (1bit) | no | | | | | | | | 7920 | 128 x 59 | N/A | Gray (1bit) | no | | | | | | | | 7921G | 176 x 140 | N/A | Color (16bit) | yes | | 7925G | 176 x 140 | N/A | Color (16bit) | yes | | 7925G-EX | 176 x 140 | N/A | Color (16bit) | yes | | 7926G | 176 x 140 | N/A | Color (16bit) | yes | | 7940G | 176 x 140 | N/A | Color (16bit) | yes | | 7960G | 176 x 140 | N/A | Color (16bit) | yes | | | | | | | | 7937G | 255 x 128 | N/A | Gray (2bit) | no | | | | | | | | 7941G | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | 7941G-GE | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | 7942G | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | 7961G | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | 7961G-GE | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | 7962G | 298 x 144 | 320 x 144 | Gray (4bit) | yes | | | | | | | | 7945G | 298 x 156 | 320 x 156 | Color (16bit) | yes | | 7965G | 298 x 156 | 320 x 156 | Color (16bit) | yes | | | | | | | | 7970G | 298 x 168 | 320 x 168 | Color (12bit) | yes | | 7971G-GE | 298 x 168 | 320 x 168 | Color (12bit) | yes | | | | | | | | 7975G | 298 x 168 | 320 x 168 | Color (16bit) | yes | | | | | | | | Communicator | 298 x 168 | N/A | Color (24bit) | yes | | | | | | | | 6921 | 396 x 81 | N/A | Monochrome | no | | 6961 | 396 x 81 | N/A | Monochrome | no | | | | | | | | 6941 | 396 x 162 | N/A | Monochrome | no | | 6945 | 396 x 162 | N/A | Monochrome | no | | | | | | | | 9971 | 498 x 289 | N/A | Color (24bit) | yes | | 9951 | 498 x 289 | N/A | Color (24bit) | yes | | 8941 | 498 x 289 | N/A | Color (24bit) | yes | | 8945 | 498 x 289 | N/A | Color (24bit) | yes | | 8961 | 498 x 289 | N/A | Color (24bit) | yes |