Forward - Home - Cisco Community



ForwardThis guide will walk you through the quickest path to installing, integrating, configuring, and deploying Cisco Unified Communications in any environment.The objective of this paper is to document a method that will empower Cisco Partners and Customers to provide a repeatable, low-risk, method of deploying a sizable Cisco Unified Communications pilot at any site quickly and smoothly.While this guide will go into the details of deploying the solution. You may also wish to review the “Jabber for Everyone Solution Overview” document on here for further explanation and details around the deployment: of Contents TOC \o "1-2" Forward PAGEREF _Toc199573766 \h 1Introduction PAGEREF _Toc199573767 \h 4Review Documentation (prerequisite) PAGEREF _Toc199573768 \h 5CUP Integration Guides for Microsoft Exchange – 69 pages PAGEREF _Toc199573769 \h 5Instant Message Compliance Guide – 16 pages PAGEREF _Toc199573770 \h 5(External) Database Setup Guide – 21 pages PAGEREF _Toc199573771 \h 5CUP Installation Guide – 48 pages PAGEREF _Toc199573772 \h 5Cisco Jabber for Windows Administration Guide – 110 pages PAGEREF _Toc199573773 \h 5Cisco Jabber for Android Installation Guide – 36 pages PAGEREF _Toc199573774 \h 5CUP Deployment Guide – 288 pages PAGEREF _Toc199573775 \h 6CUP Release Notes – 36 pages PAGEREF _Toc199573776 \h 6Gather Licenses, Software, and Hardware (1 hour) PAGEREF _Toc199573777 \h 6Licenses PAGEREF _Toc199573778 \h 6Software PAGEREF _Toc199573779 \h 7Hardware PAGEREF _Toc199573780 \h 7Scripts PAGEREF _Toc199573781 \h 8Prepare Environment (< 5 hours) PAGEREF _Toc199573782 \h 9LDAP Directory (< 0.5 hours) PAGEREF _Toc199573783 \h 9Network Services (< 0.5 hours) PAGEREF _Toc199573784 \h 10Cisco Unified Communications Manager (CUCM) (< 1.5 hours) PAGEREF _Toc199573785 \h 11Cisco WebEx SaaS Meeting Center (< 0.5 hours) PAGEREF _Toc199573786 \h 18External Database for Instant Messaging Compliance (< 1 hour) PAGEREF _Toc199573787 \h 18Web Server (< 0.5 hour) PAGEREF _Toc199573788 \h 19Microsoft Office (< 0.5 hour) PAGEREF _Toc199573789 \h 19Microsoft Exchange (< 1 hour) PAGEREF _Toc199573790 \h 20Server Installation (< 1.5 hours) PAGEREF _Toc199573791 \h 21Generate an Answer File PAGEREF _Toc199573792 \h 21Install Software PAGEREF _Toc199573793 \h 21Configure with the Answer File PAGEREF _Toc199573794 \h 21Remove Answer File and DVD image PAGEREF _Toc199573795 \h 21Post-install guide PAGEREF _Toc199573796 \h 21Server Configuration (< 1 hour) PAGEREF _Toc199573797 \h 21Certificate Store PAGEREF _Toc199573798 \h 21Presence Settings PAGEREF _Toc199573799 \h 21Messaging Settings PAGEREF _Toc199573800 \h 22Application > Cisco Unified Personal Communicator PAGEREF _Toc199573801 \h 22Activate CUP Services PAGEREF _Toc199573802 \h 24BAT assign end-user Profiles PAGEREF _Toc199573803 \h 25Reboot PAGEREF _Toc199573804 \h 25Client Installation and Configuration (< 0.5 hours) PAGEREF _Toc199573805 \h 26Software Delivery PAGEREF _Toc199573806 \h 26Cisco VT Camera Driver PAGEREF _Toc199573807 \h 26Cisco Jabber for Windows PAGEREF _Toc199573808 \h 26Cisco Jabber for Mobile PAGEREF _Toc199573809 \h 26Validation Testing (< 0.5 hours) PAGEREF _Toc199573810 \h 26LDAP Authentication PAGEREF _Toc199573811 \h 26User Preferences PAGEREF _Toc199573812 \h 27Instant Message between Jabber clients PAGEREF _Toc199573813 \h 27Escalation to group chat PAGEREF _Toc199573814 \h 27Escalation to audio call PAGEREF _Toc199573815 \h 27Telephony Presence PAGEREF _Toc199573816 \h 27Escalation to video call PAGEREF _Toc199573817 \h 27Escalation to WebEx conference PAGEREF _Toc199573818 \h 27Exchange Presence PAGEREF _Toc199573819 \h 27IntroductionThe scope of this document is to empower Cisco Partners and Customers to quickly and easily integrate a 200 end-user pilot of Cisco Unified Communications (UC) into an existing Cisco Telephony customer site. For purposes of this paper, we are going to assume the following is already installed, deployed, and functional in the environment:Cisco Unified Communications Manager 8.5.1.10000-26Any supported Cisco IP PhoneMicrosoft Active Directory 2008Microsoft Exchange 2010Microsoft Windows XP or 7Google Android 2.2Co-located on same LAN, no firewalls, VPN, or other special network considerationsWith the above pre-requisites already in place, we are going to enable the following basic Cisco UC features to the environment to give the pilot end-users a taste of Cisco UC:Messaging (Chat / IM)Desktop (softphone) Audio and Video CommunicationMedia Escalation (IM-audio-video-conference)Telephony, Messaging, and Calendaring PresenceMobilityTo achieve the above features, needed to install, integrate, configure, and deploy the following software:Cisco Unified Presence 8.5.3.10000-59Cisco Jabber for Windows 9.0.1Cisco Jabber for Android 8.6.1Cisco WebEx SaaS Meeting Center 27.25.0.10481 (T27L10NSP25)It is worth mentioning that for the pilot, we are leaving out some of the more complicated features available in Cisco UC, as the intent is to focus on simply getting the basic features up and functional for a pilot. As such, this paper will not explore the following features. If your pilot wants to explore implementing these features, please refer to the documentation on :High-availability Redundancy Federation Review Documentation (prerequisite)Unified Communications (UC) is the integration of real-time communication services, where collections of products provide a consistent unified end-user interface across multiple devices, and is not a single product. As such, there are a lot of technologies and components involved to deliver UC. Cisco Unified Presence (CUP) provides documentation on how each of these technologies and components integrate with each other, and it’s worth reviewing if you have no prior experience. The combined documentation reaches near 600 pages of content, so it may take awhile to review and comprehend everything.Alternatively, you could skip over the documentation and simply follow the steps outlined in this paper to install, integrate, configure, and deploy Cisco UC. Solution Reference Network Design – 1356 pages (optional) – 44 pages Directory – 28 pages Integration Guides for Microsoft Exchange – 69 pages Message Compliance Guide – 16 pages(External) Database Setup Guide – 21 pages Installation Guide – 48 pages Jabber for Windows Administration Guide – 110 pages Jabber for Android Installation Guide – 36 pages Deployment Guide – 288 pages Release Notes – 36 pages Licenses, Software, and Hardware (1 hour)LicensesCisco Unified Presence Software FeatureCUP provides a 90-day evaluation software feature license after the date of installation. For a pilot running under 90-days, you do not need to procure a software feature license for CUP, as all features are enabled after installation in evaluation mode.After the 90-day evaluation license expires, the CUP features will be disabled and you must purchase and upload a valid CUP Software Feature license.Cisco Device User License (DUL)You can use the License Calculator and License Report that is integrated into CUCM to calculate the amount of additional DUL that the site may need. If you’re participating in the Jabber for Everyone Solution, you only need to consider the DUL count if you are enabling softphone features on the clients; as the Jabber for Everyone COP file provides the CUP/CUPC license for IM & Presence for you.As a general rule, you will need at a minimum of 4 DUL per end-user you wish to UC-enable, or as high as 9 DUL per end-user if you cannot use Adjunct licensing. Adjunct licensing allows you to associate 2 softphone devices with 1 physical deskphone device; and only consumes 1 DUL when the Primary Device is associated in CUCM. If you have more than 2 softphones associated to the same deskphone, it will consume the full DUL specified in the License Calculator without Adjunct licensing.For our pilot of 200 end-users, this means we need between 800 to 1800 DUL available on the associated CUCM server to use the core basic features of Cisco UC. However, you could get away with only 3-6 DUL per end-user if you only enable one softphone device per end-user; although this may subtract from the overall Cisco UC experience.Cisco Unified Personal Client End User Feature License (1 DUL)This is needed to allow an end-user to be able to be a “watcher” and observe/subscribe to presence events on presence entities. This is provided to you “free” if you install the Jabber for Everyone COP file on your CUCM server.Cisco Unified Presence Server End User Feature License (1 DUL)This is needed to allow an end-user to be able to publish any presence event on to any “watchers”. This is provided to you “free” if you install the Jabber for Everyone COP file on your CUCM server.Cisco Unified Client Services Framework or Cisco Unified Personal Communicator (1-3 DUL)This is needed to allow an end-user to use a desktop softphone within CUPCCisco Dual Mode for iPhone or Cisco Dual Mode for Android (1-4 DUL)This is needed to allow an end-user to use a mobile softphone SoftwareCisco Unified Presence 8.5 or laterYou can download the install ISO from , in the Software Download section. If you do not have the appropriate permissions to download this file, or need a Bootable ISO, you may need to obtain the software from your Account Team, or purchase the physical media.Cisco VT Camera DriverThe camera drivers are available on , in the Software Download section. You can download the Executable Installer (exe), which includes all the pre-requisite software, or the Windows Installer (msi), which can be easily deployed through various software deployment tools. The file extensions may appear as a file collection (zip), which you can download and extract locally to launch your installer of choice.Cisco Jabber for Windows 9.0.1 or laterThe Jabber client is available on , in the Software Download section. It’s recommended for this guide to download the CiscoJabber-Admin-ffr and CiscoJabber-Install-ffr files, as this includes all the additional COP files we’ll need to install on CUCM.Cisco Jabber for Android 8.5 of laterIf you have CUCM 8.5 or earlier, you will need to obtain the Android device COP file from your Account Team. Later we will install this COP file onto the CUCM server(s) to make the Cisco Jabber for Android device available.The Cisco Jabber client is available in the Android Market Place. You can access this directly from the mobile device.Cisco Mobile for iPhone 8.5 or laterThe Cisco Mobile for iPhone client is available in the Apple App Store. You can access this directly from the mobile device.Obtain Jabber for Everyone COP fileIn order to take advantage of the free IM and Presence offering of Jabber for Everyone, you will need to obtain the license COP file (ciscocm-free_im_v1.0.cop.sgn). This file can be obtained directly from , in the Utilities folder of your specified Cisco Unified Communications Manager product. For example, version 8.5.1 is at this link: Linux distribution with PostgreSQL 8.3 or laterFor this paper, I’m using Ubuntu Linux 11.04 (free), which includes the install for PostgreSQL version 8.4. You can obtain Ubuntu here: Or if you prefer to setup PostgreSQL on an existing server, you can obtain the PostgreSQL software here: HardwareCisco Unified PresenceSupported hardware for CUP can be found in the Compatibility Matrix at this site. For the pilot, we’re focusing on under 1000 end-users: you wish to deploy using VMware, you may download the VMware OVA template file from following the instructions on this site:(including_OVA/OVF_Templates)#Cisco_Unified_PresenceExternal Database for Instant Messaging ComplianceIf you do not already have a PostgreSQL release 8.3.x or 8.4.x server in the environment, and are in a jurisdiction that requires Instant Messaging Compliance you will need to install a new server along with CUP.For the external PostgreSQL database that is required for Instant Messaging Compliance, it is recommended that you have identical hardware to that of the CUP server that will be using it. So follow the same hardware procurement procedure as documented for Cisco Unified Presence above.ScriptsTo make the basic installation process simpler and reproducible, I’ve created a handful of scripts that we can use. These are not officially Cisco supported, but if you encounter any issues with them, I will offer assistance in recovering and finding a solution to the problem. You can download the script files from the Cisco Support Community site:CUCM/CUPS Provisioning script – cup_user.py - HYPERLINK "https%3A%2F%2Fsupportforums.%2Fdocs%2FDOC-24108" external database script - cup_postgresql.sh - Exchange permissions script - cup_exchange.ps1 - Config File Generator – j4wconfig.html - Log Server Example – prt_post.zip - Environment (< 5 hours)LDAP Directory (< 0.5 hours)Cisco Unified Presence (CUP) relies on Cisco Unified Communications Manager (CUCM) to retrieve end-users and devices. Then Cisco Unified Personal Communicator (CUPC) uses the LDAP Directory to perform various client functions. To provide a truly unified experience, it is highly recommended that you configure the associated CUCM server and CUPC clients to integrate with the same LDAP Directory.CUCM LDAP Directory integration is a one-way pull of a small collection of attributes for end users in the specified Search Base. To do this, CUCM requires a Service Account in the LDAP Directory with “read” permissions allowed for all user objects in the specified Search Base. To simplify configuration, we can re-use this same account with the CUPC clients; which also need “read” access for a given Search Base.Create Service AccountsIn your LDAP Directory administration, create a Service Account for CUCM/CUP/CUPC to use to read use objects and attributes. If the site security allows, you can specify to “never expire” the password. Otherwise, whenever you change the Service Account password, you will need to update this password in CUCM/CUP/CUPC for it to continue to function.For the basic installation we will need three service accounts created in the LDAP environment, you can name them whatever you wish, and we will refer to them later in this guide:CUCM DirSync (used to sync end-users into CUCM)CUP DirSync (used for CUPC to communicate with LDAP)CUP ExchangeSync (used for CUP to communicate with Exchange)LDAP Attribute MappingsCUCM, CUP, and CUPC are capable of reading various LDAP Attributes from the LDAP Directory. To maintain a consistent end-user experience, it’s highly recommended that you re-use the same attribute mappings between the products. These can be viewed in the respective LDAP Attribute configuration pages for each product. We mention this here to bring to your attention that this is configured in multiple locations, and you should verify that they are all consistent.Indexing attributesTo enhance LDAP Directory performance, CUP relies on the following attributes to be indexed and unique. Your LDAP Directory documentation should cover how to index various attributes:telephoneNumbersAMAccountNameuidIdentifying the Search BaseA Search Base is the highest level, or starting point, in the LDAP Directory where you wish CUCM/CUP/CUPC to search. For small directories, you can typically get away with using the “root” OU as the Search Base. However, in complex environments you may need to further refine the Search Filter in CUCM, select multiple sub-OU Search Bases, or improve the performance of the LDAP server to handle the number of objects within each OU.Assign PermissionsAfter you have the Service Account created, you will want to assign “read” permissions on each of the LDAP Attributes that were identified in the mapping above. Typically this can be set at a high-level OU, or the Search Base, which will then propagate down to all sub-OU and objects contained. You will only be able to import users that allow the Service Account to read its attributes. If you wish to omit certain OU, or sub-OU from CUCM/CUP, you can “deny” the “read” permission for the Service Account on those OUs or Objects, and CUCM/CUP will not be able to sync with it.End-User PhotographsIf you wish to have end-users photographs appear in the client while viewing a contact, you will need to have an LDAP Attribute that is capable of holding a binary JPEG image for each end-user; however this could lead to undesirable performance on your LDAP server. A recommended solution is to use a web server that hosts JPEG images of each end-user named on the globally unique identifier specified in the CUCM/CUP/CUPC LDAP configuration. For example , where “szelenka” matches the UID of an end-user in the LDAP work Services (< 0.5 hours)DNS ServersFor CUP to install you must have a DNS record in the forward and reverse lookup zones for the DNS name and IP address you will be configuring CUP to use. If you do not have this information in the DNS server, the installation will fail.We need to verify each of these servers is configured with a lookup and reverse-lookup on your DNS server:CUP ServerCUCM Publisher and Subscriber Server(s)LDAP Directory Server(s)Microsoft Exchange Server(s)External PostgreSQL Database Server(s)Optional: End-User Photograph Web Server(s)In addition to the server names, you will also need a DNS SVR record for the CUP service for the Jabber clients to locate the configuration server (_cuplogin) which is different from the XMPP login server (_xmpp-client), adjusting each parameter to match your environment:_cuplogin._priority = 0weight = 0port = 8443svr hostname = internet address = 10.10.10.10NTP ServersFor CUP to install, you must have a valid NTP server in the network. The CUP system will automatically use the CUCM as the NTP source, so it’s a good idea to verify that your CUCM server is setup properly for NTP. ssh adminuser@cucmfqdnutils ntp statusThis site offers some common help for verification: Server Environment (< 0.5 hours)Jabber for Windows takes advantage of multiple web technologies to make your life as an Administrator easier. This includes upgrade servers, PRT Repository, forgotten passwords, etc.:UpdateURLIt is possible to tell all of your deployed Jabber clients when a new upgrade is available, and notify them when this upgrade is ready to install. This makes managing a large deployment easier. All we need to do is have an XML file hosted on a webserver that’s accessible without authentication. An example file would look like: is possible to have each client automatically upload a PRT report to a web server, so you don’t need to ask your end-users to collect and email you any log files for a problem they may have encountered. If you’re comfortable with developing your own web page to handle this, the PRT Report will be sent via a file POST under the “zipFileName” variable.Or if you want to get a jump-start, I have a PHP file which handles these posts for you and stores the data in a MySQL database. This handles the POSTing of data, you’ll still need to write your own web page to pull data from the database and view it; hopefully I’ll have a more complete sample to download on the Community in the near future. Anyway, feel free to download, read, and/or modify the source as you see fit for your organization: is possible to redirect your end-users to a web page that is capable of resetting their password, when/if they click on the forgot password link in the client. Since each environment is drastically different with how they manage passwords, it doesn’t make sense to include an example here. But if your environment has a URL where end-users go to reset their password, it may be helpful to remember this for when we configure the jabber-config.xml file in a few minutes. Cisco Unified Communications Manager (CUCM) (< 1.5 hours) In order to fully integrate audio and video communications, we need to verify the CUCM server is ready to be integrated with CUP/CUPC. We will review the necessary information needed in CUCM to allow for a clean and smooth install of CUP.Upload DUL licensesAs mentioned before, to take advantage of Cisco UC we will need to assign DUL to licensed features in CUCM. Using the License Report and License Calculator in CUCM Admin pages we can determine if we have enough DUL to deploy the pilot of 200 end-users.If we do not have enough DUL available, we will need to upload additional license files that give us the desired DUL in order to deploy the pilot. After uploading, we should be able to go to the License Report and License Calculator in CUCM Admin to verify that we have enough DUL to deploy the pilot.Activate CUCM ServicesIn order for CUP to communicate with the CUCM server, we need to verify that these services are active and in a started state on the CUCM Publisher. If they are not activated or started, activate and start them in CUCM Serviceability. Cisco CallManagerCisco TFTPCisco CTIManagerCisco AXL Web ServiceCisco Bulk Provisioning ServiceCisco DirSyncIntegrate CUCM with LDAP DirectoryUsing the information from preparing the LDAP Directory in the last section, follow the installation procedures as documented in each of these documents. You will need to configure an LDAP Server, LDAP Directory, and LDAP Authentication; LDAP Search Filter is optional. the services are started and the integration is saved, you need to perform an initial sync. To do this go to the “System > LDAP > LDAP Directory” for the one you created, and select the “Perform Full Sync Now” button to initiate a sync. Depending on the size of your directory, it may take awhile for the sync to complete. You can refresh the page to view the status of the button you clicked to initiate the sync. While the sync is still in progress, the text will be “Cancel Sync Process”; when it transitions to “Perform Full Sync Now” that indicates the sync is complete.After the sync, you should be able to go into “User Management > End-User” Administration in CUCM Admin to verify that the end-users from the LDAP Directory now show up in CUCM Admin.Create AXL Application User to use with CUP First we need to create a “User Management > User Group” for this AXL user. When creating the User Group, select the Related Links on the top-right for “Assign Role to User Group” and select the “Standard AXL API Access” Role.After that group is created, we need to go to “User Management > Application User” to create a new application user that will be used for CUP AXL. Be sure to add this user to the User Group we just created and save. We will need this username/password during the post-install of CUP. Configure SIP Trunk to CUP server CUCM will communicate with CUP through a SIP Trunk. For this to be successful, we need to verify the SIP Security Profile on CUCM, as well as creating a SIP Trunk to the CUP server. We can create this now even though we haven’t installed CUP yet by following this documentation: Modify CUCM Service Parameters CUCM needs a few Service Parameters to be modified for it to work successfully with CUP. To do this, follow this documentation: Inter-Presence Group Subscription: Allow SubscriptionCUP PUBLISH Trunk: select the SIP Trunk we just createdInstalling COP filesSince this process requires that you place the COP files on an FTP server for the CUCM to access, if you do not already have a FTP/SFTP server in your network, there are many options to download on the Internet. For example, you can try Core FTP out for this exercise: Jabber for Everyone promotion allows a license free version of Jabber to be deployed. To get enable the IM and Presence features without using a license, you will need to install the ciscocm-free_im COP file on each CUCM server in your cluster. Follow the steps outlined here to install it on each CUCM server in the cluster: you will be deploying Cisco Jabber for Android for your end-users, and only if your CUCM server is 8.5 or earlier; if you are not using Android or are running CUCM 8.6 or later you don’t need to follow the steps in this URL to install the Android COP file: the CiscoJabber-Admin-ffr zip file we downloaded from , there will be a folder called CUCM. In this folder there will be multiple COP files we’ll install on the CUCM server, so place these files on your FTP server. To install these COP files, we’ll follow the same procedure as outlined in the above “Installing Android COP file”:ciscocm.addcsfsupportfieldOptional, this is used to enable an alternate configuration file for the clients. This file is needed to add the Cisco Support Field on the CSF device in the CUCM Administration pages. This is covered in the Jabber Admin guide, but is not covered in this document.ciscocm.installcsfdevicetypeOnly required if your are running a CUCM version before 7.1(4). This file adds the CSF device type to the CUCM Administration pages.cmterm-bfcp-e.8-6-2Only required if you are running a CUCM version after 8.6(2) and you wish to use video desktop share in the clients.cmterm-csf-dialrule-wizardOptional, this is required if using Application dial rules or directory lookup rules on CUCM. This file is needed to perform a copy of the CUCM dialrules into an XML file hosted on its TFTP service, so the Jabber client can download the dialrules. NOTE: depending on when you downloaded this file, you may run into defect CSCtz81164; if so apply the workaround in the RNE.Create a global configuration file for Jabber WindowsThe global configuration file hosts a majority of the configuration used by the Jabber Windows client. You can review all the available parameters you can configure by downloading the Jabber Config File Generator at this site: XML configuration files and restart TFTP serviceOnce you have saved the jabber-config.xml file locally, you will need to follow the instructions to upload it to the CUCM server and restart the TFTP service for the changes to take effect. and Device ProvisioningCreate Phone TemplatesIn order to use BAT to create CUPC/Mobile softphone devices, we will need to specify the phone template for each device. We do this in “Bulk Administration > Phones > Phone Templates” by clicking the “Add New” button for:Cisco Dual Mode for iPhoneCisco Dual Mode for AndroidCisco Unified Client Services FrameworkWhen creating the template for each device, be sure to create a “Line 1” appearance for that device, this is to allow BAT to automatically assign a line appearance to the device when we import the CSV file.Enable Video Desktop Sharing Script and BAT Provisioning At this point, we need to verify each end-user is associated with their deskphone and line appearance properly, as well as other tasks. This can become tedious to perform on multiple end-users one at a time. We’re going to assume this has not already been configured, and that we need to do this now.Download the file cup_user.py (). Using that script we can automate a lot of the associations, then simply upload CSV files to the CUCM BAT service and it will configure it for us.If you do not want to use BAT and the provided Python Script to automate the end-user and device provisioning, then you will need to do each step manually by following the steps outlined in the Deployment Guide.Obtaining Configuration BAT filesTo use the Python script, we only need two files from CUCM. These are a list of end-users to enable for the pilot, and a list of the existing deskphones. Each item is done through “Bulk Administration” in the CUCM Admin pages.--userFile: "Users > Export Users" with "All User Format" selected and “Run Immediately”This is the list of users you wish to configure for CUP and CUPC the script will create a softphone for each user and defaults the SUBSCRIBE CSS to the associated line CSS as well as the various other configuration to the device the line is associated with and use Adjunct Licensing when available also defines the user PIN to "12345" if the PIN is not already set.If you cannot define your query within CUCM Admin, you’ll need to export ALL users, then use a spreadsheet program to delete the users that you do not want to use for this pilot.--phoneFile: "Phones > Export Phones > All Details" with “Run Immediately”This is the list of phones you wish to associate users with to use CUP and CUPC the script will find and associate users in "userFile" with the Directory Number Line Appearance in "phoneFile" match is determined by the users right-most "Telephone Number" attribute which matches a Directory Number the script can also update the Directory Number CID with the newly associated user display name.After you have started both export processes, you can check the status through “Bulk Administration > Job Scheduler”. When they are listed as “Complete” open the job to verify there were zero errors. After you have verified the export is complete, you’ll need to download the files in “Bulk Administration > Upload/Download Files” and search for the filenames you gave the exports.Generating new BAT files Once you have downloaded the userFile and phoneFile from CUCM, you will need to place them on a system with Python 2.5.1 or later installed. If you do not have Python, it’s fairly easy to install following their website: to generate the CSV files you simply need to call:python cup_user.py --userFile=/path/filename.ext --phoneFile=/path/filename.extOnce this completes, you will have 12 files created in the same directory where you executed the script. These files are listed below; where <guid> is a unique identifier that is generated each time the script runs:cup_user_LOGFILE_<guid>.txtThis is a log file of the script execution. You should review this file for any ERROR or WARN messages. There will also be instructions on what to do with each file if it was generated successfully.cup_user_CUPUserProfile_<guid>.csvThis is a CSV file to import into CUP Admin to provision all the users with the appropriate Profiles.cup_user_iPhoneSoftphoneStandalone_<guid>.csvThis is a CSV file to import into CUCM Admin to create an iPhone Dual Mode softphone for each user using Standalone licensing.cup_user_iPhoneSoftphoneAdjunct_<guid>.csvThis is a CSV file to import into CUCM Admin to create an iPhone Dual Mode softphone for each user using Adjunct licensing.cup_user_AndroidSoftphoneStandalone_<guid>.csv This is a CSV file to import into CUCM Admin to create an Android Dual Mode softphone for each user using Standalone licensing.cup_user_AndroidSoftphoneAdjunct_<guid>.csvThis is a CSV file to import into CUCM Admin to create an Android Dual Mode softphone for each user using Adjunct licensing.cup_user_CUPCSoftphoneStandalone_<guid>.csvThis is a CSV file to import into CUCM Admin to create an CSF/CUPC softphone for each user using Standalone licensing.cup_user_CUPCSoftphoneAdjunct_<guid>.csvThis is a CSV file to import into CUCM Admin to create an CSF/CUPC Dual Mode softphone for each user using Adjunct licensing.cup_user_Deskphone_<guid>.csvThis is a CSV file to import into CUCM Admin to update existing deskphones associated to the users.cup_user_CUPCUPC_<guid>.csvThis is a CSV file to import into CUCM Admin to allocate CUP and CUPC feature license to the users.cup_user_Users_<guid>.csvThis is a CSV file to import into CUCM Admin to update the end-users information and associations.cup_user_LineAppearance_<guid>.csvThis is a CSV file to import into CUCM Admin to update the end-user line appearance associations.Each file can be altered using any spreadsheet program. You should verify the data generated in each CSV file before uploading it to BAT to alter the CUCM/CUP configuration.Associate end-users with associated devices and line appearancesThese instructions will appear in the LOGFILE, but copied here for reference: Filename: /cup_user_LineAppearance_<guid>.csv Upload this file to your Cisco Unified Communications Manager using the Bulk Administration tool as: Target: "User Line Appearance" Transaction Type: "Update Line Appearance - Custom File" Then once it is uploaded to CUCM, navigate to: Bulk Administration > Users > Line Appearance > Update Line Appearance Select "Run Immediately" and "Submit"Associate end-users with User Groups and SUBSCRIBE CSSThese instructions will appear in the LOGFILE, but copied here for reference: Filename: /cup_user_Users_<guid>.csv Upload this file to your Cisco Unified Communications Manager using the Bulk Administration tool as: Target: "Users" Transaction Type: "Update Users - Custom File" Then once it is uploaded to CUCM, navigate to: Bulk Administration > Users > Update Users Select "Run Immediately" and "Submit"Create CUPC, Android, and iPhone softphone devicesThere will be multiple files created for softphone creation. You can select the “Adjunct” version to create the device being associated to a Primary Device, or the “Standalone” version to create the device as standalone. You may need to manually alter the mobile device creation, if all of the end-users are not using the same device. You may need to create a “Bulk Administation > Phone > Phone Template” for the CUPC/CSF, Android, or iPhone devices with at least one DN defined in the template before you can use the CSV file to bulk import them.These instructions will appear in the LOGFILE, but copied here for reference: Filename: /cup_user_CUPCSoftphoneAdjunct_<guid>.csv Upload this file to your Cisco Unified Communications Manager using the Bulk Administration tool as: Target: "Phones" Transaction Type: "Insert Phones - Specific Details" Then once it is uploaded to CUCM, navigate to: Bulk Administration > Phones > Insert Phones (using the appropriate Phone Template) Select "Run Immediately" and "Submit"Enabling Allow CTI Control, PC Port, and Video CapabilitiesThese instructions will appear in the LOGFILE, but copied here for reference: Filename: /cup_user_DeskPhone_<guid>.csv Upload this file to your Cisco Unified Communications Manager using the Bulk Administration tool as: Target: "Phones" Transaction Type: "Update Phones - Custom File" Then once it is uploaded to CUCM, navigate to: Bulk Administration > Phones > Update Phones > Custom File > (set "Allow Control of Device from CTI=checked", "PC Port=Enabled", "Video Capabilities=Enabled") Select "Run Immediately" and "Submit"Assign CUP/CUPC license to end-usersThese instructions will appear in the LOGFILE, but copied here for reference: Filename: /cup_user_CUPCUPC_<guid>.csv Upload this file to your Cisco Unified Communications Manager using the Bulk Administration tool as: Target: "CUP Users" Transaction Type: "Update CUP Users - Custom File" Then once it is uploaded to CUCM, navigate to: Bulk Administration > CUPS > Update CUPS/CUPC Users Select "Run Immediately" and "Submit"Verify Job Scheduler has zero errorsIn “Bulk Administration > Job Scheduler” you can view the status of each of the BAT jobs to verify they have “Completed” and encountered zero errors during the import. If you encountered errors, you can use the webpage to troubleshoot what went wrong.If a job is stuck in “Hold” you need to select that row then “Activate Selected” for it to process.Application Dial RuleNOTE: This is a legacy field used with CUPC, Jabber relies on the configuration specified in the jabber-config.xml file on the CUCM server for this. If you used the Python and BAT route, the LOGFILE will tell you if you need to alter any Route Patterns for CUPC to be able to dial other end-users. Typically this is in the form of an Application Dial Rule, which the LOGFILE spells out exactly what configuration you need for this to work. Verify that the LDAP attribute being used for the telephoneNumber matches the route patterns configured in the CUCM for the users in the pilot to dial each other. Then alter the CUCM route configuration accordingly.You may also need to manually verify the Route Partition and Calling Search Space for the users in the pilot, although it’s generally assumed that this configuration is already in place prior to this pilot.Directory Lookup Dial RuleNOTE: This is a legacy field used with CUPC, Jabber relies on the configuration specified in the jabber-config.xml file on the CUCM server for this.Configure as/if needed.Cisco WebEx SaaS Meeting Center (< 0.5 hours)Since WebEx is being provided as a Service, there is not much preparation we need to do.Obtain a WebEx Meeting Center siteThe only information you will need from WebEx is the URL to the Meeting Center for this site. We will enter this information in later during the CUP Configuration.Single Sign On (SSO)Work with your WebEx Administrator to identify a method to allow the LDAP Directory authentication to behave as a SSO for the WebEx credentials of the end-users.External Database for Instant Messaging Compliance (< 1 hour) If the install will be in a jurisdiction that requires Instant Messaging Compliance, you will need to setup a PostgreSQL server on it’s own server; separate from the server CUP will run on.You can install PostgreSQL on a Windows server, however many Linux distributions provide PostgreSQL installation and it makes installing the server much easier.Install Linux with PostgreSQLDuring the Linux installation, if there’s an active internet connection, there will be an option to install additional services. For this paper, we only need to concern ourselves with OpenSSH and PostgreSQL libraries. The Linux install will handle the rest. Or if you prefer to do this manually, follow the steps outlined on PostgreSQL site here: Update Network InterfaceDepending on your DHCP/DNS you may need to alter the IP settings of the newly installed linux. For the Ubuntu server we installed, we can do this by altering:sudo vi /etc/network/interfacessudo vi /etc/resolv.confsudo apt-get remove dhcp3-clientsudo /etc/init.d/networking restartModify PostgreSQLDownload and copy the cup_postgresql.sh file () to the linux server we just installed with PostgreSQL. If you added the OpenSSH library as suggested, you should be able to SFTP the file with:sftp user@hostnamecd ~put cup_postgresql.shbyeThen ssh to the server to execute the script. You can call the script with the “--h” argument and it will display a help file which you can review to customize the experience. For simplicity, if you installed PostgreSQL on linux and have a linux user “postgres” then you can accept the default values and simply execute:ssh user@hostnamebash ~/cup_postgresql.shYou will need to enter in the linux user password, as the script performs some administrative level functions. But since we just installed linux, we should have that password readily available. This script will create the SQL user, database, functions, access tables, iptables, and listening port for the PostgreSQL installation. The user, password, and database will be printed to the screen that we will need when configuring CUP. If you accepted the defaults, these will be:username: cupuserpassword: C1sco123database: cupdblisten port: 5432If the script fails, or you prefer to do these steps manually, you will need to follow the steps as outlined in this document: Microsoft Office (< 0.5 hour)For this we just need to follow the documentation at this link: Exchange (< 1 hour)NOTE: This is a legacy field used for CUPC. Cisco Jabber talks to Microsoft Outlook to obtain Exchange Presence information. Leaving this in this document for reference, and when/if Jabber talks to CUPS to get the Exchange information again.Create Service Account in ExchangeDownload and copy the cup_exchange.ps1 file () to the Exchange server. To run this, we will need to use the LDAP Service Account created when we prepared the LDAP Directory. When in the Exchange Management Shell (EMS):C:\path\cup_exchange.ps1 usernameThe “username” is the Service account created to handle the CUP-Exchange interaction; and is the only required argument to execute the script. You can override the defaults if you wish with the following flags:C:\path\cup_exchange.ps1 –user:username –policy:policy_name –server:exchange_hostname –role:management_role_assignment_name –scope:management_scope_nameIf you accept the defaults, the script will attempt to use the following values, which are listed here for your reference:policy: Cisco Unified Presence ThrottlingPolicyserver: (hostname of the server the script was executed on)role: CUP_ImpersonateRoleAsgscope: CUP_ImpersonateScopeIf you prefer to do this manually, review the steps as outlined in this guide: Certificate AuthorityIf the Exchange server does not have a signed certificate associated with it already, we will need to install a standalone CA server in the network and generate a certificate for Exchange. To install a new CA, follow the documentation here: Create signed SSL certificateIn order to have secure communication between CUP and Exchange, the Exchange server must have a valid certificate. If the environment doesn’t already have one, you can set one up by following the steps on this guide: you have this certificate, save it for later step when we upload it to the CUP server.Virtual Directory PermissionsFor the service account and CUP to access end-users calendars on Exchange, you need to configure the Virtual Directories to allow this by following this guide: Server Installation (< 1.5 hours)Generate an Answer FileUsing Microsoft Internet Explorer, or Mozilla Firefox, navigate to this URL and fill out the form to generate an Answer File, which we will use to perform an unattended installation of CUP, while using CUCM as the NTP server: Software If you are installing on a VMware image, be sure to review the Deployment Guide for instructions on how to setup a serial-port to obtain the Installation Logs should the install fail.Insert the install media to the optical drive on the server, and boot up the system. You should be able to follow the on-screen prompts. When you get to the prompt for “Platform Installation Wizard” select “Skip” to skip the configuration until later. This will allow the system to install, and it will reboot before it asks for the Answer File.Configure with the Answer File After the install and reboots when it prompts you with “Pre-existing Configuration Information”, insert the USB/floppy disk into the drive and press “Continue”. If you are using a VMware install, please review this KB on how to get a valid floppy image: Answer File and DVD imageAfter the install has completed, remove the Answer File from the floppy drive and remove the DVD from the DVD drive. This will ensure future reboots boot the OS from the disk.Post-install guide Using the information entered during the Preparing CUCM section, enter the AXL user name and CUCM Publisher information. Server Configuration (< 1 hour) Certificate StoreCUP has a concept of a Keystore, where it keeps a repository of known trusted certificates with which it can communicate. Since we’re setting up Exchange Calendaring, and WebEx SaaS, we’ll need to upload their entire certificate chain to the CUP Keystore. Additionally, if you have a signed certificate on the CUCM or other servers, you will need to upload them as well.This guide walks through how to upload the root certificate from Exchange that we created during the Preparing Exchange section of this guide: Presence Settings If CUP Admin, for Presence > Settings we want to enable:Enable availability sharingAllow users to view the availability of other users without being promptedEnable ad-hoc presence subscriptionsEnable SIP Publish on CUCM select the SIP Trunk we created while preparing the CUCM serverCUCM GatewayIn CUP Admin, in Presence > Gateways click on the “Add New” button to create a new gateway with:Presence Gateway Type = CUCMPresence Gateway = FQDN of the CUCM Publisher ServerExchange GatewayIn CUP Admin, in Presence > Gateways click on the “Add New” button to create a new gateway with:Presence Gateway Type = Exchange EWS ServerPresence Gateway = FQDN of the Exchange Server where we ran the script atAccount Name: The email URI address of the account which we used when running the script on the Exchange server during preparationAccount Password: The LDAP Directory password for the above accountPresence Gateway Port: 443Messaging SettingsIn CUP Admin, Messaging > Settings verify the following are enabled:Enable instant messagingAllow clients to log instant message history (on supported clients only)External DatabaseIn CUP Admin, Messaging > External Server Setup > External Databases click on the “Add New” button with the information retrieved while preparing the External Database earlier in this document. For reference, I’m providing the default values here again:Database Name: cupdbUser Name: cupuserPassword: C1sco123Hostname: FQDN of the linux server hosting PostgreSQLPort Number: 5432ComplianceIn CUP Admin, Messaging > Compliance verify we have “Message Archiver” selected and the external database selected from aboveGroup Chat and Persistent Chat SettingsIn CUP Admin, Messaging > Group Chat and Persistent Chat Settings verify the following is configured:System Automatically Manages Primary Group Chat Server AliasesEnable Persistent ChatArchive all room messagesPersistent Chat Database AssignmentSelect the External Database configured in the last few stepsApplication > Cisco Unified Personal CommunicatorSettingsIn CUP Admin, Application > Cisco Unified Personal Communicator > Settings verify the following is configured:CUPC Security Settings:Default Cisco SIP Proxy TCP ListenerPrimary TFTP Server FQDN (which is the CUCM Publisher in our case)Credentials source for voicemail service: CUPCredentials source for web conferencing service: CUPOnly set to “CUP” if you have SSO with WebEx, otherwise leave it as “Not set” to force each end-user to update CUPC with their WebEx login and password.Allow cut & paste in instant messagesLDAP Attribute MappingNOTE: This is a legacy field used with CUPC, Jabber relies on the configuration specified in the jabber-config.xml file on the CUCM server for this.In CUP Admin, Application > Cisco Unified Personal Communicator > Settings verify the LDAP Attributes match the mapping we verified during the LDAP Directory preparation configuredPhoto: LDAP binary attribute or URL with tags as identified earlierCreate End-User Application ProfilesVoicemailIn CUP Admin, Application > Cisco Unified Personal Communicator > Voicemail Server, configure your voicemail system by clicking “Add New”.In CUP Admin, Application > Cisco Unified Personal Communicator > Mailstore, configure your mailstore repository system by clicking “Add New”. The Mailstore is typically the partner email system which can host Unified Messaging messages.In CUP Admin, Application > Cisco Unified Personal Communicator > Voicemail Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default Unity Profile” and configure it accordingly.Be sure to select “Make this the default Voicemail Profile for the system.”ConferencingIn CUP Admin, Application > Cisco Unified Personal Communicator > Conferencing Server, configure your voicemail system by clicking “Add New”.In CUP Admin, Application > Cisco Unified Personal Communicator > Conferencing Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default Meeting Place Profile”.Server Certificate VerificationIf you uploaded the WebEx certificate chain to the CUP Trust on CUP, then you can select “Self Signed or Keystore”If you did not upload the WebEx certificate, you must select “Any Certificate”Be sure to select “Make this the default Conferencing Profile for the system.”CTI In CUP Admin, Application > Cisco Unified Personal Communicator > CTI Server, configure your voicemail system by clicking “Add New”; pointing to a CUCM server which has the CTIManager service running. In this guide, this is the CUCM Publisher system.In CUP Admin, Application > Cisco Unified Personal Communicator > CTI Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default CTI Gateway Profile”.Be sure to select “Make this the default CTI Profile for the system.”LDAPNOTE: This is a legacy field used with CUPC, Jabber relies on the configuration specified in the jabber-config.xml file on the CUCM server for this.In CUP Admin, Application > Cisco Unified Personal Communicator > LDAP Server, configure your voicemail system by clicking “Add New”.In CUP Admin, Application > Cisco Unified Personal Communicator > LDAP Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default LDAP Profile”. The DN should be the Service Account we created while preparing the LDAP Directory, and could be the same account as the CUCM system. It’s a good idea to copy/paste the LDAP Directory configuration from CUCM into this screen.Be sure to select “Make this the default LDAP Profile for the system.”AudioIn CUP Admin, Application > Cisco Unified Personal Communicator > Audio Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default Audio Profile”.Be sure to select “Make this the default Audio Profile for the system.”CCMCIPIn CUP Admin, Application > Cisco Unified Personal Communicator > CCMCIP Profile, create a default profile. When we ran the Python and BAT script during the CUCM pre-creation, it also created a CSV file that we can use to automate this process in CUP. To take advantage of this, we should name the Profile “Default CCMCIP Profile”.Be sure to select “Make this the default CCMCIP Profile for the system.”Activate CUP Services In CUP Serviceability, under Tools > Service Activation, we need to verify we have all the core services activated to be able to use basic Cisco UC. We need to verify the following are activated, don’t worry if some of them don’t start right now, we will reboot later to start them in the proper sequence:Cisco Bulk Provisioning ServiceCisco UP SIP ProxyCisco UP Presence EngineCisco UP Sync AgentCisco UP XCP Text Conference ManagerCisco UP XCP Connection ManagerCisco UP XCP Message ArchiverCisco UP XCP Authentication ServiceCisco UP XCP RouterBAT assign end-user ProfilesBefore we can use BAT, we need to verify that the BAT service started and that we have end-users on the CUP system now. In CUP Admin, User Management > End-Users, do a generic search. You should find all of the CUCM end-users now within the CUP Admin pages. This means the sync between CUCM and CUP is functional and we can now use BAT in CUP Admin to assign the users in our pilot to the appropriate profiles. Filename: /path/cup_users_CUPUserProfile_<uid>.csv Upload this file to your Cisco Unified Presence using the Bulk Administration tool as: Target: "CUP Users" Transaction Type: "Update CUP Users - Custom File" Then once it is uploaded to CUCM, navigate to: Bulk Administration > CUPC/Deskphone > Update (You must have already configured the "Default Profile" for each CUPC setting) Select "Run Immediately" and "Submit"After the BAT job completes successfully, you should be able to navigate to each Profile to view the associated users. Once this shows up, we’re finished with the CUP installation! All that’s left is deploying the clients to the end-users now.Reboot After everything is configured, we should reboot the system to ensure it comes up clean before we start to configure the clients. SSH to the CUP server then issue the command:utils system restartWhen the system is back up, verify these servers are in a “running” or “started” state in the CUP Admin pages, Tools > Control Center:Cisco UP SIP ProxyCisco UP Presence EngineCisco UP Sync AgentCisco UP XCP Text Conference ManagerCisco UP XCP Connection ManagerCisco UP XCP Message ArchiverCisco UP XCP Authentication ServiceCisco UP XCP RouterClient Installation and Configuration (< 0.5 hours)Software DeliveryDeploy the client software package to the client machine using the available software delivery mechanism at this site. This guide walks through some of the more complex configurations: Cisco VT Camera DriverOn the client desktop, launch the installer for the Cisco VT Camera Driver if this client machine will be using a Cisco branded webcamera with Jabber; follow the on-screen prompts and reboot if prompted.Cisco Jabber for WindowsJabber for Windows allows you to configure a single Global Configuration file and store this on a TFTP server that is downloaded each time a client authenticates. For more information on customizing this to your environment, see the documentation here: can also customize the .msi file to include default values. This is detailed at this page: Jabber for MobileThe client must download Cisco Jabber or Cisco Mobile from their respective App Store. Then you will need to provide the end-user with the basic information they’ll need to enter when configuring the client:AndroidBOT<userid> or the device name as configured in CUCM for this userTFTP server FQDNiPhoneTCT<userid> or the device name as configured in CUCM for this userTFTP server FQDNValidation Testing (< 0.5 hours)For validation, you should have at least 2 end-user clients installed and ready to use.LDAP AuthenticationUsing the users LDAP Directory user ID, which should be mapped appropriately in CUCM Administration and CUP Administration, enter the end-users password and verify that the authentication was successful and no error messages show up.User PreferencesIn CUPC/Jabber, go to File > Options and verify the end-user preferences for each setting. We will need to set the Exchange Calendaring option in Status > When I’m in a meeting, to enable Exchange Calendaring for the end-user.Also, if you configured CUPC/Jabber to have different authentication for Voicemail or Conferencing, you will need to have the end-user enter in their credentials in the Accounts section.Instant Message between Jabber clientsSearch for a contact in the search bar, then add the contact to the Contact List. Double-click the contact to initiate an IM chat.Escalation to group chatIn the IM window, press the “+” icon to search and add a new participant to the chat window. Alternatively, from your Contact List, highlight multiple contacts to start a chat. Or create a new persistent chat room and invite contacts through there.Escalation to audio call In the IM window, or in the contact list, press the handset icon to initiate a telephone call to that contact. The call routing requires the CUCM server being configured to route the calls appropriately according to it’s dialing rules.Telephony PresenceWhen on the audio call, the end-users presence should change to “On the Phone” and show a busy icon, indicating that they are on the phone.Escalation to video call During the audio call, press the video camera icon to initiate a video call. Or click “add video to call” to escalate to video dynamically.Escalation to WebEx conferenceWhile in the IM window, click the screen icon to initiate a WebEx Conference and send the URL link to all parties in the IM chat.Exchange PresenceWhen an end-user enables the Exchange Presence setting, CUP will monitor that users exchange calendar and update the presence status to “In a meeting” whenever that user is scheduled as “busy” in outlook. ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download