Cisco Prime Collaboration Provisioning Guide - Standard and Advanced, 10.0
Using Prime Collaboration Self-Care
Downloads: This chapterpdf (PDF - 1.29 MB) The complete bookPDF (PDF - 6.23 MB) | Feedback

Using Prime Collaboration Self-Care

Using Prime Collaboration Self-Care

Prime Collaboration Self-Care Overview

Prime Collaboration provides a Self-Care portal, which allows you to control preference settings such as user name, password and so on. You can update your own account and services by using the Self-Care portal. The Self-Care feature enables you to modify line settings, manage services, and configure phone options.

A new Self-Care feature is introduced in Cisco Unified Communications Manager 10.0 and above versions. This Self-Care can be accessed from Cisco Unified CM only. You can enable Prime Collaboration Self-Care, that is, Self-Care from Prime Collaboration Provisioning for Cisco Unified CM 10.x and lower versions.


Prime Collaboration Self-Care is also available for Cisco Unified CM 10.0 (and above versions) and Cisco Unity Connection 10.0 (and above versions) along with CM based Self-Care. The administrator must turn-off the "Enable Prime Collaboration Self-Care" check box in the User Provisioning page if Prime Collaboration Self-Care is not used.

Cisco Unified Communications Manager Self-Care is recommended when the environment is Cisco Unified CM 10.0 (and above versions) only with Cisco Unity Connection 10.0 (and above versions) only, or Users with services on only one Cisco Unified CM 10.x cluster.


When Cisco Unified Communications Manager is shared between two or more users, and if one or more users are using LDAP, Prime Self-Care will be used regardless of the version of Cisco Unified Communications Manager.

To enable Prime Collaboration Self-Care, see Creating a Self-Care Account.

To enable CM based Self-Care, see Cisco Unified Communications Self Care Portal User Guide.

Creating a Self-Care Account

You can create a Self-Care account in standalone or converged Prime Collaboration Provisioning. You can choose to enable or disable Self-Care for each user you create.


  • To assign Self-Care roles, you must enable the CreateSelfCareAccounts rule while creating a new domain. The CreateSelfCareAccounts rule is disabled by default.
  • You can also assign Self-Care roles in an already existing domain by running the Self-Care Migration Utility. This will enable Self-Care role for already existing users. See Self-Care User Migration Script for details.
  • The SelfCareUser check box is available only if the CreateSelfCareAccounts rule is enabled.
  • After creating users, the users can login to Self-Care only after the globaladmin or domain-admin changes their account password. By default, the user password is empty. You must specify a default password in the DefaultCUPMPassword Data field and set Enabled to true to set the default password.

To create a Self-Care account for a user:

    Step 1   Choose Deploy > User Provisioning.
    Step 2   Click Add User and check the Enable Prime Collaboration Self-Care check box.
    Step 3   Enter the necessary user information and save.

    Enabling or Disabling Self-Care Using Batch Provisioning

    You can enable Self-Care while creating new users using Batch Provisioning. To enable Self-Care for a user, provide the authorization role as SelfCareUser in the batch action file.

    Batch Provisioning can also be used to enable or disable Self-Care role for an existing user. To enable provide the authorization role as SelfCareUser, and to disable provide none in the batch action file.


    The CreateSelfCareAccounts rule must be enabled for the domain to create a Self-Care account.

    For information on Batch Provisioning see Managing Batch Projects.

    Launching Prime Collaboration Self-care

    Based on your user role, you can launch Self-Care.


    If you are using IE 10, you must select the Standards mode for the Self-Care portal to work properly.

    A user with only Self-Care role will be directed to the self-care portal after login:

      Step 1   In a browser enter, http://<provisioning-ip>/cupm/selfcareuser/Login.
      Step 2   Use Self-Care credentials to log in.

      Since the user has only Self-Care role, he will be able to access only the Self-Care menu. Provisioning menus will not be available for such a user.

      Launching Prime Collaboration Self-care from Personal Settings

      If a user has a Self-Care role along with other authorization roles (Maintenance, Ordering, Activity Roles and so on), then the user can launch Self-Care from the Personal Settings menu.

      To launch Personal Settings:

        Step 1   Login to Provisioning using your credentials.
        Step 2   Choose Deploy > User Provisioning.
        Step 3   Select a user, and click Provision Services.
        Step 4   Select Personal Settings to update self-care options for the selected user

        You can click Launch Self-Care from the User's Quick View.

        Customizing Your Personal Settings

        Self-Care enables you to set individual attributes and personal preferences for the following aspects of phone use:
        • Phone options include configuring speed dial numbers, do not disturb options, and music when a call is placed on hold.
        • Profile options allow you to configure options for extension mobility and single number reach.
        • Line options for a specific line on the phone, such as call forwarding, caller identification, and notifications.
        • User options for the phone user, such as passwords and personal identification numbers (PINs).

        You can update the /opt/cupm/sep/ file to hide or display the features displayed in the Phone Settings, Line Settings, and User Settings page of Self-Care portal. For example, if you want to configure the features in the Phone settings, your entries would be:

        enabled features for Phone Settings should be provided as follows: General,SpeedDials,DoNotDisturb,Locale,MusicOnHold,Others,SpeedDials,DoNotDisturb,Locale,MusicOnHold,Others#


        You must log in as root user to update the file. You must restart the cupm services for the changes to take effect.

        To configure Self-Care options:

          Step 1   In a browser, enter http://<provisioning-ip>/cupm/selfcareuser/Login.
          Step 2   Enter your username and password.
          The Self-Care portal screen appears. The Self-Care portal screen contains the following elements:
          • Phone carousel—The phone carousel (positioned in the lower left side of the screen) contains icons for the phones and service profiles that you can configure. Click the icons at either side of the visible icons to view the additional phones or profiles.
          • Main menu—The main menu options (to the right of the phone carousel) are Phone Settings, Line Settings, and User Settings. Depending on your selection in the phone carousel, the Phone Settings option might be replaced by Extension Mobility Settings or Single Number Reach Settings.
          • Configuration area—The configurable categories for the selected main menu option appear next. When you click a category, such as Speed Dials, the right side of the screen displays the configurable options.
          Step 3   In the phone carousel, select the phone or profile you want to configure.
          Step 4   In the Line Settings menu, make sure that you select the correct line for the options you are configuring.

          The following options are available for you to configure in the Self-Care portal:

          • Configuring Phone / Extension Mobility Settings
          • Configuring Single Number Reach Settings
          • Configuring Line Settings
          • Configuring User Settings

          Configuring Phone / Extension Mobility Setting

          The following table lists the Phone and Extension Mobility settings you can perform using Self-Care.

          Table 1 Configuring Phone / Extension Mobility Setting
          Settings Description Procedure


          Update your phone MAC address.

          Choose Phone Settings > MAC Address, enter a valid MAC address for your phone, then click Save.

          Speed Dials

          Add phone numbers for speed dialing.

          Add a comma between the numbers to pause speed dialing. You can add any number of commas. Default delay for a comma is two seconds.

          Choose Phone Settings > Speed Dials , then click Add. Enter the necessary information and click Save.

          Do Not Disturb

          Enable or disable the Do Not Disturb feature.

          Select the action to be taken if an incoming call arrives while the Do No Disturb feature is enabled.

          Choose Phone Settings > Do Not Disturb, then check the Enable Do Not Disturb check box.


          Select your work and network locales for time and language support.

          Choose Phone Settings > Locale, then choose your location from the User Locale drop-down list, and click Save.

          Music On Hold

          Select the source of the music to be played when you place a user on hold.

          Choose Phone Settings > Music On Hold, then choose the audio source to play when you place a call on hold from the User Hold Audio Source drop-down list, and click Save.


          Enable or disable the following options:
          • Speakerphone
          • Speakerphone and headset
          • Video
          • PC Port use
          • Extension Mobility

          Choose Phone Settings > Others, then check or uncheck the check box as required for each option, then click Save .

          Line Settings

          The following table lists the available line settings for each line of the selected phone or profile:

          Table 2 Line Settings
          Settings Description Procedure

          Call Forward

          Set default call-forwarding options.

          Customize call-forwarding for external or internal incoming calls.

          Choose Line Settings then select Call Forward, Caller ID, Notification, or Music On Hold to update and click Save.

          Caller ID

          Configure caller ID options.


          Set audio and visual options for incoming calls and notification of messages.

          Music On Hold

          Select the source of the music to be played when a call is placed on hold.

          User Settings

          The following table lists the available User Settings:

          Table 3 User Settings
          Settings Description Procedure


          Update your name.

          Enter your email address.

          Select your primary phone.

          Choose User Settings, then select Information, Password or PIN to update and click Save.


          Update your password.


          Update your personal identification number.

          Common Self-Care Tasks

          The following table lists all the common self-care tasks a user can perform:

          Table 4 Common self-care Tasks
          Task Procedure

          Change a password

          Choose User Settings > Passwords.

          Change a PIN

          Choose User Settings > PIN.


          You can change your phone and voice mail PINs. Phone PIN is to reset the Cisco Unified Communications Manager (or Extension Mobility) PIN, and voice mail is to reset the Unity Connection PIN.

          Disable use of a speakerphone

          Choose Phone Settings > Others, then check the Disable Speakerphone check box.

          Enable extension mobility

          Choose Phone Settings > Others, then check the Cisco Extension Mobility check box.

          Enable video calls

          Choose Phone Settings > Others, then check the Enable Video check box.

          Forward calls

          Choose Line Settings > Call Forward, then set the options for forwarding incoming calls.

          Provide e-mail information

          Choose User Settings > Information, and enter your email address.

          Select a different phone as your primary device.

          Choose User Settings > Information, and choose the preferred device from the Primary Device drop-down list.

          Select call and message notifications

          Choose Line Settings > Notification, then choose the notification options for incoming calls and messages.

          Select the source for music for calls on hold

          Choose Phone Settings > Music On Hold, then choose the audio source to use when you or the network places a call on hold.

          Configuring Single Number Reach

          The Single Number Reach feature enables you to associate a another phone number with your business IP phone number. When a call is received on the business phone number, Cisco Prime Collaboration Provisioning automatically directs the call to ring on the phone you specify as well as the business phone. In this way, the Single Number Reach feature enables callers to reach you by dialing a single number, regardless of your location.

          To configure an alternate number for Single Number Reach:

            Step 1   In the phone carousel, select the icon associated with the remote destination profile.
            Step 2   Choose Single Number Reach Settings > Alternate Numbers.
            Step 3   Provide the information as described in the Field Description for Single Number Reach table, then click Save.
            Step 4   If needed, click Add New to add an additional alternate number.

            Table 5 Field Description for Single Number Reach



            Alternate Number

            Enter the alternate number that Cisco Prime Collaboration Provisioning is to direct calls to when calls are received on your primary phone.


            (Optional) Enter a description of the alternate number.

            Enable Reach Me Anywhere

            Check the check box to enable incoming calls to ring on multiple phones at the same time.

            This is a mobile device

            Check the check box if the alternate number is for a mobile device.

            Allow me … seconds to answer

            Enter the length of time (in tenths of seconds) that Cisco Prime Collaboration Provisioning should wait for you to answer the call on the primary phone before directing the call to the alternate number.

            Continue ringing the alternate number for … seconds

            Enter the length of time (in tenths of seconds) that Cisco Prime Collaboration Provisioning should ring at the alternate number.

            If the alternate number answers within … seconds

            Enter the length of time (in tenths of seconds) that Cisco Prime Collaboration Provisioning should wait after directing a call to the alternate device before connecting a call on the device. This delay prevents calls from being picked up by automated greetings, such as voice mail, on the device.

            Line Association Information

            Check the check box for the line to associate with this alternate number.

            Self-Care User Migration Script

            The SelfCareMigrationUtility can be invoked during the migration, or from the CLI, after migration. The tool processes all the users in the domains that have CreateSelfCareAccounts rule and DefaultCUPMPassword rule set.

            This tool can be run through CLI from /opt/cupm/sep/ipt/bin. It can be run either globally (means for all domains) or for a single domain.

            To run script:

              Step 1   Go to /opt/cupm/sep/ipt/bin.
              Step 2   Run:./ ALL ENABLE
              • ALL—Indicates all domains.
              • ENABLE—Enables selfcare for all users in the domain specified. Tto disable selfcare option, run:
                ./ ALL DISABLE
                The script can be run at the domain level also. To do this, run: ./ DOMAIN NAME [ENABLE | DISABLE]

              For more information on migration, see the Cisco Prime Collaboration Upgrade and Migration Guide.