The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This section provides task-based information to guide you through the server setup process.
Note |
Providing information on every task involved in installing and configuring Cisco Unified Communications Manager is beyond the scope of this document. The purpose of this chapter is to provide a high-level workflow of the tasks you should complete to set up your environment. See the appropriate documentation for Cisco Unified Communications Manager to review detailed information and ensure you complete the installation and configuration tasks specific to your deployment. |
You must install and configure Cisco Unified Communications Manager before you begin any tasks in this section.
This topic provides a high-level overview of the process to set up your environment with Cisco Unified Communications Manager.
Step 1 |
Add a directory to your environment.
|
Step 2 | Set up unified communications. |
Step 3 | (Optional)Set up voicemail. |
Adding a directory to your environment populates the Cisco Unified Communications Manager database with user data that resides on your directory server. Completing this task provides Cisco Unified Communications Manager with users in your environment who you can add to profiles and to whom you can provision capabilities.
Verify that users from your directory are available on Cisco Unified Communications Manager and Cisco Unified Presence.
If users from your directory are returned in the list of available users, you have successfully added a directory to your environment.
You create a service profile that contains the configuration settings for the services you add on Cisco Unified Communications Manager. You add the service profile to the end user configuration for your Cisco UC Integration for Microsoft Lync users. Cisco UC Integration for Microsoft Lync can then retrieve settings for available services from the service profile.
Review the following prerequisites before completing this task:
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Service Profiles window opens. |
Step 3 |
Select Add New. The Service Profile Configuration window opens. |
Step 4 | Enter settings on the Service Profile Configuration window as follows: |
Step 5 | Select Save. |
Software phones provide capabilities for Cisco UC Integration for Microsoft Lync to send and receive audio and video through a computer.
The first step in creating a software phone device is to create a SIP profile so that you can enable video desktop sharing. You cannot edit or configure the default SIP profile. You must create a new SIP profile.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List SIP Profiles window opens. |
Step 3 | Do one of the following to create a new SIP profile: |
Binary Floor Control Protocol (BFCP) provides video desktop sharing capabilities for CSF devices. Cisco Unified Communications Manager handles the BFCP packets users transmit when using video desktop sharing capabilities. BFCP presentation sharing is automatically enabled on Cisco Unified Communications Manager version 9.0(1) and higher.
Note |
|
Tip |
Complete this procedure for every CSF device.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select The Find and List Phones window opens. |
Step 3 | Select Add New. |
Step 4 |
Select Cisco Unified Client Services Framework from the Phone Type drop-down list and then select Next. The Phone Configuration window opens. |
Step 5 |
Specify a name for the CSF device in the Device Name field. You should use the CSFusername format for CSF device names. For example, you need to create a device name for Tanya Adams whose username is tadams. Tanya's device name should be CSFtadams. |
Step 6 |
Specify configuration settings on the Phone Configuration window as appropriate. See the Phone Configuration Settings topic in the Cisco Unified Communications Manager documentation for more information about the configuration settings on the Phone Configuration window. |
Step 7 |
Select Allow Presentation Sharing using BFCP in the Protocol Specific Information section to enable video desktop sharing for versions of Cisco Unified Communications Manager older than 9.0.1. Video desktop sharing is enabled by default in Cisco Unified Communications Manager 9.0.1 and later. |
Step 8 |
Select Save. A message is displayed to confirm successful configuration. The Associate Information section becomes available on the Phone Configuration window. |
Add a directory number to the device and save the configuration.
You must add directory numbers to devices in Cisco Unified Communications Manager. This topic provides instructions on adding directory numbers using the menu option after you create your device. Under this menu option, only the configuration settings that apply to the phone model or CTI route point display. See the Cisco Unified Communications Manager documentation for more information about different options to configure directory numbers.
Step 1 | Locate the Association Information section on the Phone Configuration window. |
Step 2 |
Select Add a new DN. The Directory Number Configuration window opens. |
Step 3 | Specify a directory number in the Directory Number field. |
Step 4 | Specify all other required configuration settings as appropriate. |
Step 5 |
Associate end users with the directory number as follows:
|
Step 6 | Select Save. |
Step 7 |
Select Apply Config. The Apply Configuration window opens. |
Step 8 | Follow the prompts on the Apply Configuration window to apply the configuration. |
You can optionally set up secure phone capabilities for CSF devices. Secure phone capabilities provide secure SIP signaling, secure media streams, and encrypted device configuration files.
To use secure phone capabilities, you must configure the Cisco Unified Communications Manager security mode using the Cisco CTL Client. You cannot use secure phone capabilities with the nonsecure security mode. At a minimum, you must use mixed mode security.
See the Cisco Unified Communications Manager Security Guide for instructions on configuring mixed mode with the Cisco CTL Client.
The first step to setting up secure phone capabilities is to create a phone security profile that you can apply to the device.
Configure the Cisco Unified Communications Manager security to use mixed mode.
Step 1 | Select . |
Step 2 | Select Add New. |
Step 3 |
Select Cisco Unified Client Services Framework from the Phone Security Profile Type drop-down list and then select Next. The Phone Security Profile Configuration window opens. |
After you add a phone security profile, you must configure it to suit your requirements.
Step 1 | Specify a name for the phone security profile in the Name field on the Phone Security Profile Configuration window. | ||
Step 2 |
Specify values for the phone security profile as follows:
|
||
Step 3 | Select Save. |
Add the phone security profile to the devices and complete other configuration tasks for secure phone capabilities.
Step 1 |
Open the CSF device configuration window.
|
Step 2 | Select Allow Control of Device from CTI in the Device Information section. |
Step 3 | Select Save. |
Step 4 | Locate the Protocol Specific Information section. |
Step 5 | Select the phone security profile from the Device Security Profile drop-down list. |
Step 6 | Select Save. |
At this point in the secure phone set up, existing users can no longer use their CSF devices. You must complete the secure phone set up for users to be able to access their CSF devices.
What to Do NextSpecify the certificate settings and generate the authentication string for users.
Specify certificate settings in the CSF device configuration and generate the authentication strings that you provide to users.
Step 1 | Locate the Certification Authority Proxy Function (CAPF) Information section on the Phone Configuration window. |
Step 2 |
Specify values as follows:
|
Step 3 | Select Save. |
Step 4 |
Create the authentication string.
|
Provide users with the authentication string.
Users must specify the authentication string in the client interface to access their CSF devices and securely register with Cisco Unified Communications Manager.
Note |
The time it takes for the enrollment process to complete can vary depending on the specifications of the user's computer and the current load for Cisco Unified Communications Manager. It can take up to one minute for the client to complete the CAPF enrollment process. |
If you enable secure phone capabilities for users, their CSF device connections to Cisco Unified Communications Manager are secure. If the other end point also has a secure connection to Cisco Unified Communications Manager, then the call can be secure. However, if the other end point does not have a secure connection to Cisco Unified Communications Manager, then the call is not secure.
Media Stream | Encryption |
---|---|
Main video stream | Can be encrypted |
Main audio stream | Can be encrypted |
Presentation video stream Refers to video desktop sharing using BFCP. |
Not encrypted |
BFCP application stream Refers to BFCP flow control. |
Not encrypted |
Note |
The client displays a lock icon when it can use SRTP for encrypted media streams to other secured clients or conference bridges. However, not all versions of Cisco Unified Communications Manager provide the ability to display the lock icon. If the version of Cisco Unified Communications Manager you are using does not provide this ability, the client cannot display a lock icon even when it sends encrypted media. |
The client downloads and stores certificate trust lists whenever you configure Cisco Unified Communications Manager security as mixed mode. Certificate trust lists enable the client to verify the identity of Cisco Unified Communications Manager servers.
Note |
The client encrypts the private key before saving it to the file system. |
The client stores these files in the following folder: %User_Profile%\AppData\Roaming\Cisco\Unified Communications\Jabber\CSF\Security
Because the client stores the files in the user's Roaming folder, users can log in to any Microsoft Windows account on the Windows domain to register their CSF devices.
On conference, or multi-party, calls, the conferencing bridge must support secure phone capabilities. If the conferencing bridge does not support secure phone capabilities, calls to that bridge are not secure. Likewise, all parties must support a common encryption algorithm for the client to encrypt media on conference calls.
CSF device security reverts to the lowest level available on multi-party calls. For example, user A, user B, and user C join a conference call. User A and user B have CSF devices with secure phone capabilities. User C has a CSF device without secure phone capabilities. In this case, the call is not secure for all users.
Clients that do not support secure phone capabilities cannot register to secure CSF devices.
Multiple users can have unique credentials for the client and share the same Windows account. However, the secure CSF devices are restricted to the Windows account that the users share. Users who share the same Windows account cannot make calls with their secure CSF devices from different Windows accounts.
You should ensure that multiple users who share the same Windows account have CSF devices with unique names. Users cannot register their CSF devices if they share the same Windows account and have CSF devices with identical names, but connect to different Cisco Unified Communications Manager clusters.
For example, user A has a CSF device named CSFcompanyname and connects to cluster 1. User B has a CSF device named CSFcompanyname and connects to cluster 2. In this case, a conflict occurs for both CSF devices. Neither user A or user B can register their CSF devices after both users log in to the same Windows account.
The client caches the certificates for each user's secure CSF device in a location that is unique to each Windows user. When a user logs in to their Windows account on the shared computer, that user can access only the secure CSF device that you provision to them. That user cannot access the cached certificates for other Windows users.
Cisco UC Integration for Microsoft Lync users can use their computers to control desk phone and place audio calls. This topic describes how to create desk phone devices on Cisco Unified Communications Manager.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Phones window opens. |
Step 3 | Select Add New. |
Step 4 |
Select the appropriate device from the Phone Type drop-down list and then select Next. The Phone Configuration window opens. |
Step 5 |
Complete the following steps in the Device Information section:
|
Step 6 |
Complete the following steps to enable desk phone video capabilities:
See Desk Phone Video Configuration for more information about desk phone video. |
Step 7 |
Specify all other configuration settings on the Phone Configuration window as appropriate. See the Cisco Unified Communications Manager documentation for more information about the configuration settings on the Phone Configuration window. |
Step 8 |
Select Save. An message displays to inform you if the device is added successfully. The Association Information section becomes available on the Phone Configuration window. |
Add a directory number to the device and apply the configuration.
Desk phone video capabilities let users receive video transmitted to their desk phone devices on their computers.
Tip |
If users have both wireless and wired connections available, they should configure Microsoft Windows so that wireless connections do not take priority over wired connections. See the following Microsoft documentation for more information: An explanation of the Automatic Metric feature for Internet Protocol routes. |
Note |
Download the Cisco Media Services Interface installation program from Cisco.com. |
You must add directory numbers to devices in Cisco Unified Communications Manager. This topic provides instructions on adding directory numbers using the menu option after you create your device. Under this menu option, only the configuration settings that apply to the phone model or CTI route point display. See the Cisco Unified Communications Manager documentation for more information about different options to configure directory numbers.
Step 1 | Locate the Association Information section on the Phone Configuration window. |
Step 2 |
Select Add a new DN. The Directory Number Configuration window opens. |
Step 3 | Specify a directory number in the Directory Number field. |
Step 4 | Specify all other required configuration settings as appropriate. |
Step 5 |
Associate end users with the directory number as follows:
|
Step 6 | Select Save. |
Step 7 |
Select Apply Config. The Apply Configuration window opens. |
Step 8 | Follow the prompts on the Apply Configuration window to apply the configuration. |
Cisco UC Integration for Microsoft Lync uses video rate adaptation to negotiate optimum video quality. Video rate adaptation dynamically increases or decreases video quality based on network conditions.
Note |
RTCP is enabled on software phone devices by default. However, you must enable RTCP on desk phone devices. |
You can enable RTCP on a common phone profile to enable video rate adaptation on all devices that use the profile.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Common Phone Profiles window opens. |
Step 3 | Specify the appropriate filters in the Find Common Phone Profile where field and then select Find to retrieve a list of profiles. |
Step 4 |
Select the appropriate profile from the list. The Common Phone Profile Configuration window opens. |
Step 5 | Locate the Product Specific Configuration Layout section. |
Step 6 | Select Enabled from the RTCP drop-down list. |
Step 7 | Select Save. |
You can enable RTCP on specific device configurations instead of a common phone profile. The specific device configuration overrides any settings you specify on the common phone profile.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Phones window opens. |
Step 3 | Specify the appropriate filters in the Find Phone where field and then select Find to retrieve a list of phones. |
Step 4 |
Select the appropriate phone from the list. The Phone Configuration window opens. |
Step 5 | Locate the Product Specific Configuration Layout section. |
Step 6 | Select Enabled from the RTCP drop-down list. |
Step 7 | Select Save. |
Remote destinations represent the available CTI controllable devices.
You should add a remote destination through the Cisco Unified CM Administration interface if you plan to provision users with dedicated CTI remote devices. This task ensures that users can automatically control their phones and place calls when they start the application.
If you plan to provision users with CTI remote devices along with software phone devices and desk phone devices, you should not add a remote destination through the Cisco Unified CM Administration interface. Users can enter remote destinations through the client interface.
Note |
|
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Phones window opens. |
Step 3 | Specify the appropriate filters in the Find Phone where field to and then select Find to retrieve a list of phones. |
Step 4 |
Select the CTI remote device from the list. The Phone Configuration window opens. |
Step 5 | Locate the Associated Remote Destinations section. |
Step 6 |
Select Add a New Remote Destination. The Remote Destination Information window opens. |
Step 7 |
Specify JabberRD in the Name field.
You must specify JabberRD in the Name field. The application uses only the JabberRD remote destination. If you specify a name other than JabberRD, users cannot access that remote destination. |
Step 8 | Enter the destination number in the Destination Number field. |
Step 9 |
Specify all other values as appropriate. See the Remote destination configuration settings topic in the Cisco Unified Communications Manager documentation for more information. |
Step 10 | Select Save. |
Note |
The Device Information section on the Phone Configuration window contains a Active Remote Destination field. When users select a remote destination in Cisco UC Integration for Microsoft Lync, it displays as the value of Active Remote Destination. |
The CTI service enables Cisco UC Integration for Microsoft Lync users to control devices.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List UC Services window opens. |
Step 3 |
Select Add New. The UC Service Configuration window opens. |
Step 4 | In the Add a UC Service section, select CTI from the UC Service Type drop-down list. |
Step 5 | Select Next. |
Step 6 |
Provide details for the instant messaging and presence service as follows:
|
Step 7 | Select Save. |
After you add a CTI service on Cisco Unified Communications Manager, you must apply it to a service profile so that Cisco UC Integration for Microsoft Lync can retrieve the settings.
Create a service profile.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Service Profiles window opens. |
Step 3 |
Find and select your service profile. The Service Profile Configuration window opens. |
Step 4 |
In the CTI Profile section, select up to three services from the following drop-down lists:
|
Step 5 | Select Save. |
You must associate users with software phone and desk phone devices on Cisco Unified Communications Manager. Associating users with devices allows the users to access those devices and send or receive audio and video calls.
In addition to associating users with devices, you must also add users to the appropriate user groups.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Users window opens. |
Step 3 | Specify the appropriate filters in the Find User where field and then select Find to retrieve a list of users. |
Step 4 |
Select the appropriate user from the list. The End User Configuration window opens. |
Step 5 | Locate the Device Information section. |
Step 6 |
Select Device Association. The User Device Association window opens. |
Step 7 | Select the devices to which you want to associate the user. |
Step 8 | Select Save Selected/Changes. |
Step 9 | Select Find and List Users window. and return to the |
Step 10 |
Find and select the same user from the list. The End User Configuration window opens. |
Step 11 | Locate the Permissions Information section. |
Step 12 |
Select Add to User Group. The Find and List User Groups dialog box opens. |
Step 13 |
Select the groups to which you want to assign the user.
|
Step 14 |
Select Add Selected. The Find and List User Groups window closes. |
Step 15 | Select Save on the End User Configuration window. |
You should reset devices after you add software phones and desk phones and associate users with those devices.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Phones window opens. |
Step 3 | Specify the appropriate filters in the Find Phone where field and then select Find to retrieve a list of devices. |
Step 4 |
Select the appropriate device from the list. The Phone Configuration window opens. |
Step 5 | Locate the Association Information section. |
Step 6 |
Select the appropriate directory number configuration. The Directory Number Configuration window opens. |
Step 7 |
Select Reset. The Device Reset dialog box opens. |
Step 8 | Select Reset. |
Step 9 | Select Close to close the Device Reset dialog box. |
You configure dial plan mapping on Cisco Unified Communications Manager to ensure that dialing rules on Cisco Unified Communications Manager match dialing rules on your directory.
Review the Dial Rules Overview topic in the Cisco Unified Communications Manager documentation for more information on configuring dial plan mapping.
Application dial rules automatically add or remove digits in phone numbers that users dial. Application dialing rules manipulate numbers that users dial from the application.
For example, you can configure a dial rule that automatically adds the digit 9 to the start of a 7 digit phone number to provide access to outside lines.
Directory lookup dial rules transform caller ID numbers into numbers that Cisco UC Integration for Microsoft Lync can lookup in the directory. Each directory lookup rule you define specifies which numbers to transform based on the initial digits and the length of the number.
For example, you can create a directory lookup rule that automatically removes the area code and two digit prefix digits from 10 digit telephone numbers. An example of this type of rule is to transform 4089023139 into 23139.
Cisco Unified Communications Manager versions 8.5 and lower do not automatically publish dial rules to the client. For this reason, you must deploy a COP file to publish your dial rules.This COP file copies your dial rules from the Cisco Unified Communications Manager database to an XML file on your TFTP server. The client can then download that XML file and access your dial rules.
Step 1 | Open the Cisco Unified OS Administration interface. |
Step 2 | Select . |
Step 3 | Specify the location of cmterm-csf-dialrule-wizard-0.1.cop.sgn in the Software Installation/Upgrade window. |
Step 4 | Select Next. |
Step 5 | Select cmterm-csf-dialrule-wizard-0.1.cop.sgn from the Available Software list. |
Step 6 | Select Next and then select Install. |
Step 7 | Restart the TFTP service. |
Step 8 |
Open the dial rules XML files in a browser to verify that they are available on your TFTP server.
If you can access AppDialRules.xml and DirLookupDialRules.xml with your browser, the client can download your dial rules. |
Step 9 | Repeat the preceding steps for each Cisco Unified Communications Manager instance that runs a TFTP service. |
After you repeat the preceding steps on each Cisco Unified Communications Manager instance, restart Cisco UC Integration for Microsoft Lync.
Setting up voicemail enables users to receive voice mail messages and redirect incoming audio calls to the voicemail service. As part of the task of setting up voicemail, you can also configure a mailstore to enable visual voicemail in the client.
Allow users to receive voice messages.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List UC Services window opens. |
Step 3 |
Select Add New. The UC Service Configuration window opens. |
Step 4 | In the Add a UC Service section, select Voicemail from the UC Service Type drop-down list. |
Step 5 | Select Next. |
Step 6 |
Specify details for the voicemail service as follows:
|
Step 7 | Select Save. |
Add the voicemail service to your service profile.
After you add a voicemail service on Cisco Unified Communications Manager, you must apply it to a service profile so that the client can retrieve the settings.
Create a service profile if none already exist or you require a separate service profile for voicemail.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Service Profiles window opens. |
Step 3 |
Find and select your service profile. The Service Profile Configuration window opens. |
Step 4 |
Configure the Voicemail Profile section as follows:
|
Step 5 | Select Save. |
The mailstore service provides users with visual voicemail capabilities.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List UC Services window opens. |
Step 3 |
Select Add New. The UC Service Configuration window opens. |
Step 4 | In the Add a UC Service section, select MailStore from the UC Service Type drop-down list. |
Step 5 | Select Next. |
Step 6 |
Provide details for the mailstore service as follows:
|
Step 7 | Select Save. |
Add the mailstore service to your service profile.
After you add a mailstore service on Cisco Unified Communications Manager, you must apply it to a service profile so that the client can retrieve the settings.
Create a service profile if none already exist or you require a separate service profile for the mailstore service.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Select . The Find and List Service Profiles window opens. |
Step 3 |
Find and select your service profile. The Service Profile Configuration window opens. |
Step 4 |
Configure the MailStore Profile section as follows:
|
Step 5 | Select Save. |
Configure retrieval so that users can access voice mail messages in the client interface. Configure redirection so that users can send incoming calls to voice mail. You configure retrieval and redirection on Cisco Unified Communications Manager.
Step 1 | Open the Cisco Unified CM Administration interface. |
Step 2 |
Configure the voicemail pilot.
|
Step 3 |
Add the voicemail pilot to the voicemail profile.
|
Step 4 |
Specify the voicemail profile in the directory number configuration.
|