IP Phone Services#

Automate supports the ability to add CUCM IP phone services in a multi cluster environment.

Go to IP Phone Services (from the CUCM Resources & Services dashboard).
At UC and Phone Services, click on IP Phone Services.
View the list of currently configured IP phone services at your current hierarchy level.
To add an IP phone service, click the toolbar Plus (+) icon.
If you’re at a customer or higher hierarchy level, select a network device list (NDL).

Note

You won’t need to choose a NDL if you’re at a site.
On the IP Phone Services > New Record page, fill out configuration details on the two tabs/panels that display - Details and Parameters.

Note

The page displays as tabs or panels. You can toggle the layout via the Switch to Tab/Panel Layout button.
- On the Details tab/panel, configure IP phone service details.
- On the Parameters tab/panel, add IP phone service parameters, one or more.

The table describes the configuration required on the Details tab/panel:

Field	Description
Service Name	Mandatory. The name of the service, maximum 128 characters. This service name displays wherever you can subscribe to a service, provided the service is not marked as an Enterprise subscription. For Java MIDlet services, the service name must exactly match the name that is defined in the Java Application Descriptor (JAD) file. Cisco Unified Communications Manager (CUCM) allows you to create two or more IP phone services with identical names. Cisco recommends that you don’t do so unless most or all phone users are advanced, or unless an admin always configures the IP phone services. If AXL or any third-party tool accesses the list of IP phone services for configuration, you must use unique names for IP phone services. When the service URL points to an external customized URL, you can’t localize the service name as per the device locale of the phone.
ASCII Service Name	Mandatory. The name of the service to display if the phone can’t display unicode.
Service Description	Description of the content the service provides. Maximum 50 characters in any language. Double or single quotes are not allowed.
Service URL	Mandatory. The URL of the server where the IP phone service application is located. Ensure that this server remains independent of the servers in your CUCM cluster. Don’t specify a CUCM server or any server that is associated with CUCM (such as a TFTP server or directory database publisher server). For the services to be available, the phones in the CUCM cluster must have network connectivity to the server. For Cisco-signed Java MIDlets, enter the location where the JAD file can be downloaded; for example, a web server or the backend application server to which the Java MIDlet communicates. For Cisco-provided default services, the service URL displays, by default, as `Application:Cisco/<name of service>`; for example, `Application:Cisco/CorporateDirectory`. If you modify the service URL for Cisco-provided default services, verify that you configured Both for the Service Provisioning setting, which displays in the Phone, Enterprise Parameter, and Common Phone Profile Configuration windows. For example, you use a custom corporate directory, so you change `Application:Cisco/CorporateDirectory` to the external service URL for your custom directory. In this case, change the Service Provisioning setting to Both.

Field	Description
Secure-Service URL	The secure URL of the server where the CUCM IP phone services application is located. Ensure that this server remains independent of the servers in your CUCM cluster. Don’t specify a CUCM server or any server that is associated with CUCM (such as a TFTP server or publisher database server). For the services to be available, the phones in the CUCM cluster must have network connectivity to the server. If you don’t provide a Secure-Service URL, the device uses the non-secure URL. If you provide both a secure URL and a non-secure URL, the device chooses the appropriate URL, based on its capabilities.
Service Category	Mandatory. Select a service application type (XML or Java MIDlet). If you choose Java MIDlet, when the phone receives the updated configuration file, the phone retrieves the Cisco-signed MIDlet application (JAD and JAR) from the specified Service URL and installs the application. The default is XML Service Options are: XML Service (default) Java MIDlet Web Widget Web Link Android APK
Service Type	Mandatory. Defines whether the service is provisioned to the services, directories, or messages button/option on the phone; that is, if the phone has these buttons/options. To determine whether your phone these buttons/options, see the Cisco Unified IP Phone Administration Guide that supports your phone model. Options are: Standard IP Phone Service (default) Directories Messages
Service Vendor	The vendor/manufacturer for the service. Optional for XML applications. Mandatory for Cisco-signed Java MIDlets. For Cisco-signed Java MIDlets, the value you provide for this field must exactly match the vendor that is defined in the MIDlet JAD file. This field displays as blank for Cisco-provided default services. Maximum 64 characters.

Field	Description
Service Version	The version number for the application. Optional for XML applications (used for informational purposes only). For Cisco-signed Java MIDlets, consider the following: if you fill out a version, the service version must exactly match the version that is defined in the JAD file. If you fill out a version, the phone attempts to upgrade or downgrade the MIDlet if the version is different than what is installed on the phone. If the field is blank, the version gets retrieved from the Service URL. Leaving the field blank ensures that the phone attempts to download the JAD file every time that the phone re-registers to CUCM, as well as every time that the Cisco-signed Java MIDlet is launched. This ensures that the phone always runs the latest version of the Cisco-signed Java MIDlet without you having to manually update the Service Version field. This field displays as blank for Cisco-provided default services. You can enter numbers and periods in this field (up to 16 ASCII characters).
Enable	Defines whether to enable or disable the service without removing the configuration from CUCM administration (and without removing the service from the database). Clearing the checkbox removes the service from the phone configuration file and the phone. The default is True.
Enterprise Subscription	Defines whether to automatically provision the service to all devices in the cluster that can support the service. When enabled (checkbox selected), it’s not possible to subscribe to the service. When disabled, you’ll need to manually subscribe to the service for it to display on the phone (either in the Phone Configuration window, in BAT, or in the CUCM Self Care Portal). This setting displays only when you configure a service for the first time. After you save the service, the checkbox does not display in the window. To identify whether the service is provisioned to all devices in the cluster that can support the service, go to the Find and List IP Phone Services window and display the services. If true displays in the Enterprise Subscription column, you can’t manually subscribe to the service. When False, you can manually subscribe to the service; for example, an end user can subscribe to the service through the CUCM Self Care Portal.

Field

Description

Service Version

The version number for the application. Optional for XML applications (used for informational purposes only).

For Cisco-signed Java MIDlets, consider the following: if you fill out a version, the service version must exactly match the version that is defined in the JAD file. If you fill out a version, the phone attempts to upgrade or downgrade the MIDlet if the version is different than what is installed on the phone. If the field is blank, the version gets retrieved from the Service URL. Leaving the field blank ensures that the phone attempts to download the JAD file every time that the phone re-registers to CUCM, as well as every time that the Cisco-signed Java MIDlet is launched. This ensures that the phone always runs the latest version of the Cisco-signed Java MIDlet without you having to manually update the Service Version field. This field displays as blank for Cisco-provided default services. You can enter numbers and periods in this field (up to 16 ASCII characters).

Enable

Defines whether to enable or disable the service without removing the configuration from CUCM administration (and without removing the service from the database).

Clearing the checkbox removes the service from the phone configuration file and the phone.

The default is True.

Enterprise Subscription

Defines whether to automatically provision the service to all devices in the cluster that can support the service.

When enabled (checkbox selected), it’s not possible to subscribe to the service. When disabled, you’ll need to manually subscribe to the service for it to display on the phone (either in the Phone Configuration window, in BAT, or in the CUCM Self Care Portal).

This setting displays only when you configure a service for the first time. After you save the service, the checkbox does not display in the window. To identify whether the service is provisioned to all devices in the cluster that can support the service, go to the Find and List IP Phone Services window and display the services. If true displays in the Enterprise Subscription column, you can’t manually subscribe to the service. When False, you can manually subscribe to the service; for example, an end user can subscribe to the service through the CUCM Self Care Portal.