.. _concepts-view-subscribers: View and Manage Subscribers ------------------------------- .. _19.1.1|EKB-1111: .. _19.2.1|VOSS-636: .. _21.1|VOSS-795: .. _21.3|EKB-11807: .. _21.3-PB1|EKB-12904: .. _21.3-PB2|EKB-13265: Overview ............ This section describes how to: * View a list of all subscribers * Add a subscriber * Update a subscriber * Delete a subscriber .. rubric:: Related Topics * .. raw:: latex Multi Vendor Subscribers in the Core Feature Guide .. raw:: html Multi Vendor Subscribers View Subscribers ................... In the Admin Portal, you can view a summary list of all subscribers (at the current hierarchy and down), which includes details of each subscriber's currently provisioned services, grouped by vendor. To view subscribers in the Admin Portal, go to (default menus): * **Subscriber Management > Subscribers** (single vendor environment) * **User Management > User Services > Multi Vendor Subscribers** (multi vendor environment) The table describes columns in the Subscribers summary list: .. tabularcolumns:: |p{4cm}|p{11cm}| +----------------+------------------------------------------------------------------------------------------------------------------+ | Column Heading | Description | +================+==================================================================================================================+ | Role | Subscriber role, typically a self-service user role. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Sync Source | The source application of user data, for example: | | | | | | **LOCAL** indicates that the user has been manually created in VOSS Automate and has not been synced from LDAP | | | or from Cisco Unified CM. | | | | | | **CUCM** indicates that the user exists on both VOSS Automate and Cisco Unified CM, and is not synced from LDAP. | | | The user may have been created first on VOSS Automate (top-down) or created on Cisco Unified CM and synced | | | into VOSS Automate (bottom-up). | | | | | | As for User [#]_ | +----------------+------------------------------------------------------------------------------------------------------------------+ | User Type | "Admin", "End User" or "End User + Admin" - associated with the user role | +----------------+------------------------------------------------------------------------------------------------------------------+ | Auth Method | As for User [#]_ | +----------------+------------------------------------------------------------------------------------------------------------------+ | Entitlement | The Entitlement Profile associated with the Subscriber. | | Profile | | +----------------+------------------------------------------------------------------------------------------------------------------+ | | Displays an abbreviated version of the hierarchy showing the lowest | | Located At | point in the hierarchy. The hierarchy type is shown in brackets. | | | When you filter on this column, do not use text included inside | | | the brackets in the filtering criteria. For example: | | | "SiteName (Site)", where (Site)= the hierarchy node type, only | | | search using the "SiteName" portion of the field. | +----------------+------------------------------------------------------------------------------------------------------------------+ | PrimaryLine | The subscriber's primary extension number, as selected from the | | | Pattern drop-down list when adding the subscriber. | | | | | | For Multi Vendor only, the line extension used as the primary line (a pre-allocated administrator line, and | | | associated E164 number). | +----------------+------------------------------------------------------------------------------------------------------------------+ | ExtMobility | If a Subscriber is associated with more than one extension | | | mobility profile on the Unified CM, and you sync with VOSS Automate, | | | only the first extension mobility profile is displayed in this | | | list view. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Single Number | The remote destination number configured for the subscriber. Only | | Reach | if supported. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Voice | Multi vendor subscribers only. The subscriber's provisioned phones, listed by vendor. | | | | +----------------+------------------------------------------------------------------------------------------------------------------+ | Voicemail | The Voicemail number allocated to the subscriber. | | | | | | In a multi vendor environment, the subscriber's provisioned voicemail services are listed by vendor. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Conferencing | Enabled or disabled. | | | | | | In a multi vendor environment, the subscriber's conferencing services are listed by vendor, for example, | | | Webex App, MS Teams, Pexip, Zoom. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Collaboration | Multi vendor subscribers only. The subscriber's messaging services, listed by vendor, for example, WebEx, | | | MS Teams, Zoom. | +----------------+------------------------------------------------------------------------------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11cm}| +----------------+------------------------------------------------------------------------------------------------------------------+ | Column Heading | Description | +================+==================================================================================================================+ | Webex App | Defines whether a subscriber is enabled for Webex App. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Contact Center | Enabled or blank. Indicates the contact center agent's Team and | | | extension if the subscriber is an agent. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Phone | The phone associated with the subscriber. When you filter on this | | | column, the results include all phones at the hierarchy level and | | | below, regardless of the Phone column in which they reside. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Phone 2 | The second phone associated to the subscriber. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Phone n | The number of phone columns displayed in the list view will be the | | | same as the maximum number of associated to a particular | | | subscriber. For example, if a subscriber is associated to 10 | | | phones, the list view will show 10 Phone columns. | +----------------+------------------------------------------------------------------------------------------------------------------+ | Device | IP Address or Host Name. | +----------------+------------------------------------------------------------------------------------------------------------------+ .. [#] **Sync Source**: see: :ref:`user-sync-source`. .. [#] **Auth Method**: see: :ref:`user-authentication-methods`. .. _add_subscribers: Add a Subscriber ................. .. _20.1.1|EKB-4471: .. _20.1.1|VOSS-687|EKB-4500: .. _19.3.3|VOSS-687|EKB-4500: .. _19.1.1|EKB-143: .. _19.1.1|EKB-792: .. _18.1-Patch-Bundle-2|EKB-143: .. _18.1-Patch-Bundle-3|EKB-426: .. _18.1.2|VOSSSOL-12465: .. _18.1-Patch-Bundle-3|VOSSSOL-9527: .. _21.1|VOSS-790: .. _21.1|EKB-9816: This procedure adds a subscriber in VOSS Automate. .. note:: If *Enable CSS filtering* is enabled at the customer dial plan, available calling search spaces includes only those marked as a Class of Service in (default menus) **Dial Plan Management > Site > Class of Service** at the particular site. If another CSS is required, you can add custom CSSs in a CSS field if you know the exact syntax. If *Enable CSS filtering* is disabled, the list of available calling search spaces includes all CSSs that are configured on VOSS Automate. [#]_ **To add a subscriber**: 1. Log in to the Admin Portal as Customer admin or Site admin. .. note:: Only a subset of the fields described in this procedure are visible for Site admins. 2. Go to (default menus) **Subscriber Management > Subscribers**. #. On the **Subscribers** page, click **Add**. #. If you're logged in as Customer admin, choose the site where you want to add the subscriber. #. Configure subscriber details on the tabs of the form: * User tab * Phones tab * Extension Mobility tab * Single Number Reach tab * Voicemail tab * Webex tab * Webex App tab * Pexip Conference tab * Contact Center tab #. Click **Save**. Repeat this procedure to add another subscriber. User Tab '''''''''' The **User** tab defines the user details of a VOSS Automate subscriber you're adding or updating. Note the following: * Only alphanumeric characters are allowed. * For Cisco users, available entitlement profiles are imported from Unified CM. * When choosing an existing device (phone) to associate with a user and then saving the form, the **Phones** tab is populated with the phone details. * When adding a LDAP user as a subscriber, **Password** fields are hidden, and **Enable Mobility** is enabled by default, when any of the following is included or added: * A remote destination phone * Mobile identity for a phone * Remote destination profile (RDP) If subscriber self-provisioning is set up (allowing subscribers to add their own smart devices, such as company or personal phones), and **Enable Mobility** is disabled (checkbox cleared), then the setting is enabled when subscribers add a company or personal phone via the Self-service interface. To enable Extend and Connect in VOSS Automate: 1. On the **Users** tab, select the **Enable Mobility** checkbox. 2. Add the following three groups of users: a. Standard CCM End Users b. Standard CTI Enabled c. Standard CCM Admin User * For subscribers entitled to Webex App, you can add a standalone Webex Apps user by completing the following minimum fields on the User tab, then go directly to the Webex App tab: **Userid**, **Last Name**, **Email Address** * To provide access to EMCC (only customers configured for EMCC), select **Enable EMCC**. * The group you choose in **BLF Presence Group** (configured in Cisco Unified Administration), specifies destinations the subscriber can monitor. .. note:: BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups. The **Busy Lamp Field** default is set according to the selected number and specifies the Standard Presence Group that is configured with installation. * For Primary Extension, the pattern you choose specifies the lines available to the subscriber. Your choice displays in the **Primary Line** column on the **Subscribers** list view. * Subscriber Language and Role is set up in the Site Defaults of the subscriber's site hierarchy. If this is not specified, hierarchy defaults apply. .. _add-subscribers-phones-tab: Phones Tab '''''''''''' .. _21.2|EKB-10481: On the **Phones** tab you can add or update a subscriber's phone. **To add a phone**: 1. On the **Phones** tab, click **Add**. 2. Provide a device name, description, product type, device protocol, phone button template, and device security profile. .. note:: Values for the following fields are dynamic, and change based on options selected in associated fields. * Product Type * Device Protocol * Phone Button Template * Device Security Profile For example, when adding a device name with the product prefix and MAC address, a 79XX-type phone has device name 'SEP' prefixed, while ATA-type phones have 'ATA' prefixed to the MAC address. Field validation and tooltips provide guidance when you select the product type. Note that the device names for hard phones have prefix SEP or BAP, depending on device type. The phone type must support the protocol, or it defaults to the protocol option set up in the site defaults. Some phone types support multiple protocols (for example, Cisco 7960 with SCCP and SIP), and some phone types support only one protocol (for example, Cisco 9971 with only SIP). See :ref:`modify_site_defaults` 3. Click **Save**. Consider the following when adding a phone: * You can override the **Phone Button Template** value. Either choose another option, or type in a custom value. The value is applied on Unified CM if the Unified CM allows it for the phone type. * Modify phone-specific settings, such as **DND Option**, **Do Not Disturb**, and **Hot Line Device**. .. note:: Available phone settings depend on the selected product type (phone type), the device protocol (for example, SIP or SCCP), and the Field Display Policy (FDP) applied by the administrator. * You can choose a Mobile User ID Name from the drop-down list when a Dual-Mode Phone for Android or iPhones is selected. This associates the selected user to the Mobile Identity feature on this phone and must match the Userid added on the **User** tab. * Advanced settings fields are updated automatically for the phone based on the phone type. The phone is automatically associated to the user and is then displayed as an associated device for the subscriber after you save. When associating a phone that is also associated with another user, the Owner User ID defaults to the first user. * Line assignments are added in the **Line** section: * The **Pattern** field only shows lines with status *Available* or *Used*. * Pattern options in **Route Partition Name** are based on the selected partition selected. You can type in a custom pattern value. * **Enduser** - identifies the user for Presence; you can add a new User ID .. note:: VOSS Automate adds the user first and then adds the User ID. * Speed dial information is added in the **Speeddial** section. Available options depend on the selected Phone Button Template. * Busy lamp field information is added to the **Busy Lamp Field** section. Options include: * Position * Label * Blf Destination * Add busy lamp field directed details in the **Blf Directed Call Park** section. Values depend on the values on a valid Directed Call Park on Unified CM. * Specify add on modules (if any) in **Add On Module**. The phone type must support the model you choose. Leave **Load Name** blank, unless you want to overwrite the default. * Add a valid IP phone service subscription to the phone, in the **Services** section: * Choose the IP phone service from the **Service Name** field. .. note:: Subscribing a phone or a device profile to a service auto-populates the **URL** field in **Services**. To populate this field, when a service is added or updated the system retrieves the URL and a custom parameter (if any) from ``device/cucm/IpPhoneService``. * To add the service to the device, add a number as the Uri button index to the **Url Button Index** field. If you don't add a number, only the service is added. * In the **Mobile Identity** section, configure mobile identity details when selecting a Dual-Mode Phone. * These fields are auto-populated from the **Device Name** field: **Name**, and **Dual-Mode Device**. * Choose a mobility profile. * Mandatory. Specify a value for **Destination Number**. This option determines the destination number that is dialed when a call is made to the dual-mode phone. * In the **Remote Destination** section, to configure your remote destinations when a Dual Mode Phone or Cisco Spark Remote Device is selected as the **Product**. .. note:: * Remote destinations represent the mobile (or other) phones that are able to accept transfer from the desktop phone and can be used to initiate calls. Set the Pattern for the Line Association to the Route Partition name. If you enter more than one Pattern and the new Pattern is not on the system, enter the Route Partition Name manually. The **Owner User Id** and **Dual Mode Device Name** fields are auto populated. * When a CTI Remote Device is selected as the **Product**, a **CTI Remote Destination** section replaces **Remote Destination**. This allows you to configure your remote destinations specifically for a CTI Remote Device. The **Owner User Id** and **CTI Remote Device** fields are auto populated. * In the **Vendor Config** section, view and edit the configuration settings for each device. Available configuration settings depend on each product type chosen. Update the settings as required. .. note:: * The administrator password from the ``AdminLoginDetails`` in Unified CM is not stored in VOSS Automate. Data in VOSS-4UC is obtained from Unified CM. * VOSS Automate cannot disable the ``Override Enterprise/Common Phone Profile Settings`` setting once this check box has been enabled in the Unified CM GUI. This setting may be disabled on Unified CM (if required). .. rubric:: Related Topics * :ref:`modify_site_defaults` * .. raw:: latex Global Settings in the Core Feature Guide .. raw:: html Global Settings (Phones tab) Extension Mobility Tab '''''''''''''''''''''''' The **Extension Mobility** tab configures a subscriber's extension mobility settings. Consider the following: * Only one EM Profile can be added for extension mobility in VOSS Automate. If a subscriber is associated with more than one EM profile on the Unified CM, and you sync with VOSS Automate, both will be displayed: * on the subscriber's EM tab (this tab) * on the **Extension Mobility** list view (see :ref:`standalone-extension-mobility`). * Values for the following fields are dynamic, based on selections in associated fields: * Product * Protocol * Phone Button Template .. note:: For details of configuration options on this tab, see the descriptions for the **Phones** tab. The exception is remote destination information, which is not relevant for extension mobility. * Ensure that you associate the extension mobility profile and target phone for login with the extension mobility service. * If the Enable Extension Mobility Cross Cluster (EMCC) feature is enabled on the **User** tab, you must choose a CSS for this device from the **Extension Mobility Cross Cluster CSS** drop-down. The selected CSS is used as the device CSS that gets assigned to the phone when the user logs in to this remote phone. New CSS's or existing CSS's can be added or modified in Unified CM. Refer to the Cisco Unified Communications Manager Features and Services Guide for more details if required. See also :ref:`standalone-extension-mobility` to add or edit an extension mobility profile, and associate it to one or more subscriber. Single Number Reach Tab '''''''''''''''''''''''' On the **Single Number Reach** tab, note that you cannot add more than one Remote Destination Profile for Single Number Reach. However, you can add more than one Remote Destination Rdp. To enable Extend and Connect in VOSS Automate, first complete the following task: 1. Select the **Enable Extend and Connect** check box. #. Select the CTI remote device that you created from the **CTI Remote Device Name** drop-down list. Voicemail Tab '''''''''''''' The **Voicemail** tab configures the subscriber's voice mail service, provided a valid Cisco Unity Connection server is available. When configuring voicemail: * PIN and Password can be left blank. In this case, the default credential policy on the Cisco Unity Connection is used. * If the user on Cisco Unity Connection is LDAP integrated, the **Password** field is visible but should be ignored. * The **Voicemail Line** drop-down list only shows lines with status 'Available' or 'Used' that are not already configured for Voicemail. .. note:: The Cisco Unity Connection (CUC) server uses this line as a caller ID, so you should set it to the subscriber's default line. * When adding Voicemail for a subscriber, all **Call Forward To Voicemail** check boxes, except **Call Forward All**, are enabled on the chosen Line, and the Voicemail Profile setting will be set based on the Site Default Doc setting "Default CUCM Line Voicemail Profile" (**Site Management > Defaults > Line Defaults**). WebEx Tab '''''''''' The **WebEx** tab configures the subscriber's Webex details, if a valid server is available. The mandatory fields on this tab are populated with the values entered on the **User** tab. .. Note:: Any updates on the **User** tab do not update these values; values are populated only during the Add workflow. Webex App Tab '''''''''''''''' The **Webex App** tab adds a Webex App User and enables a subscriber's services and roles. Consider the following: * Webex App is only available when: * A Webex App Service has been created at the required customer level (see :ref:`webex-app-service`) * Webex App is enabled in the Entitlement Profile associated with the Subscriber. * The following fields are read only and cannot be edited: **Login Enabled** and **Invite Pending** * Once you have successfully added the subscriber as a Webex App user, the Webex App column displays status *Enabled* for this subscriber. * The Subscriber e-mail address is required to enable Webex App for the Subscriber. Pexip Conference Tab '''''''''''''''''''''' The **Pexip Conference** tab adds and configures the subscriber's Pexip services. Consider the following: * The **Pexip Conference** tab is only available if a Pexip Conference service has been configured at the required hierarchy (via the Quick Add Subscriber Group). * Conferencing must be enabled in the entitlement profile associated with the subscriber. * Once a subscriber is successfully added as a conferencing user, you can view the service as an enabled service in the **Conferencing** column on the **Subscribers** list. Contact Center Tab '''''''''''''''''''' On the **Contact Center** tab you can add, remove, or update CCX agent capabilities for a subscriber. See also: :ref:`UCCX-Feature-Reference` The **Contact Center** tab displays only if these conditions are met: * CCX device has been added and is available to the hierarchy. * Contact Center Service is configured and available to the hierarchy. * Contact Center is enabled in the entitlement profile associated with the subscriber. For the agent: * Since CCX restricts the use of special characters, these are restricted in the **Alias**. * **Team**, **Resource Group** and **Skill** names need to be set up or synced from the CCX device before they can be assigned. * **Automatic Available** is enabled by default. * An IPCC extension is automatically managed for the Unified CM user associated with the Contact Center Agent. * You may change the agent’s **Controlled Device** to one that is already associated with the subscriber. .. [#] This only applies to the VOSS Automate *Provider* deployment. .. _modify_subscribers: Update a Subscriber ......................... This procedure modifies settings for one or more subscribers. **Perform these steps**: 1. Log in as a Customer or Site administrator. .. note:: Only a subset of fields described in this procedure are visible to Site admins. 2. Choose the relevant site. 3. Open the Subscriber summary list page: * In a single vendor environment, go to (default menus) **Subscriber Management > Subscribers**. * In a multi vendor environment, go to (default menus), **User Management > User Services > Multi Vendor Subscribers** 4. Click on the relevant subscriber to open the Subscriber settings. 5. Make the changes you require. For details, see :ref:`add_subscribers`. .. note:: * You can add one or more phones. * If Extension Mobility is associated with more than one subscriber, it will not be removed when removing it from one subscriber. * Phone line settings can be edited directly on the Subscriber page. Expanding the Line section of a Phone or Extension Mobility Profile displays a link directly to the line editing form. Once you've saved your changes, the Subscriber edit page re-opens. If your menu layout has more than one entry for ``relation/LineRelation`` and associated Field Display Policy, the link for the line edit applies to the first one found (searching from top to bottom) in your menu layout (if available). 6. Save your changes. .. note:: Filtering on the following columns on the Subscribers list view is described in more detail below: * Located At Displays an abbreviated version of the hierarchy showing the lowest point in the hierarchy. The hierarchy type is shown in brackets. When filtering on this column, do not use text included inside the brackets in the filtering criteria. For example: "SiteName (Site)", where (Site) = the hierarchy node type, only search using the "SiteName" portion of the field. * Device Allows you to filter on IP Address or Host Name. * Phone When filtering on this column, results include all phones at the current hierarchy, and below, regardless of the Phone column in which they reside. .. _delete_subscribers: Deleting Subscribers ...................... Overview '''''''''' Subscribers are deleted via (default menus) **Subscriber Management > Subscribers**. The system performs various actions when deleting a subscriber via Subscriber Management. These actions depend on the user type and the subscriber's device associations. .. rubric:: Subscriber types ========================================= ================================================= User types Description ========================================= ================================================= Non-LDAP synced users * Users created in VOSS Automate and pushed to CUCM * Users provisioned in CUCM and synced in to VOSS Automate LDAP Integrated at VOSS Automate Users * Users that are LDAP integrated at CUCM and synced in to VOSS Automate LDAP synchronized users * Users directly synced from an LDAP server to VOSS Automate. ========================================= ================================================= .. rubric:: Subscriber associations Subscribers can have no device associations, or they can be associated with devices such as the following: * Phones * Extension mobility * Single Number Reach (SNR) * Voicemail * WebEx .. rubric:: VOSS Automate actions when deleting a subscriber The system performs these tasks when deleting a subscriber via **Subscriber Management > Subscribers**, depending on the user type and whether the subscriber has associated devices: .. tabularcolumns:: |p{4cm}|p{7cm}|p{4cm}| +---------------+-------------------------------------------+------------------+ | User Type | With Devices | Without Devices | +===============+===========================================+==================+ | | Deletes all devices: | | | | | | | | * Phones: device/cucm/Phone | | | Non-LDAP | * Single Number Reach: | | | Synchronized | device/cucm/RemoteDestinationProfile | | | Users | | Deletes the | | | * Extension Mobility: | Provisioning | | LDAP | device/cucm/DeviceProfile | Status. | | Integrated at | | | | Cisco Unified | * Voicemail: device/cuc/User | | | CM Users | | | | | * WebEx: device/WebEx/User | | | | | | | | Deletes the Provisioning Status. | | +---------------+-------------------------------------------+------------------+ | | Deletes all devices: | | | | | | | | * Phones: device/cucm/Phone | | | | * Single Number Reach: | | | | device/cucm/RemoteDestinationProfile | Deletes the user | | | | from Cisco | | | * Extension Mobility: | Unified CM: | | LDAP | device/cucm/DeviceProfile | device/cucm/User | | Synchronized | | | | Users | * Voicemail: device/cuc/User | Removes the | | | | Cisco Unity Call | | | * WebEx: device/webex/User | Manager from the | | | | Provisioning | | | Deletes the user from Cisco Unified CM: | Status. | | | device/cucm/User | | | | | | | | Removes the Cisco Unity Call Manager from | | | | the Provisioning Status. | | +---------------+-------------------------------------------+------------------+ .. important:: You can configure VOSS Automate to retain desk phones (hard phones, prefixed SEP or BAP) associated with a subscriber you're deleting, and to update these phones via a configuration template (CFT) once the subscriber is deleted. To do this, go to (default menus) **Customizations > Global Settings**, and on the **Phones** tab, set **Retain Desk Phones when Subscriber is deleted** to **Yes**, then select an option for applying a CFT to update the retained phone/s. You can also configure that Webex accounts and Voicemail accounts associated with deleted CUCM subscribers will be retained (or removed) in the LDAP user sync that handles deleted CUCM subscribers. This is done via **Customizations > Global Settings > Webex App** tab or **Voicemail** tab, as applicable). .. rubric:: Related Topics * .. raw:: latex Global Settings in the Core Feature Guide .. raw:: html Global Settings (Phones tab) * .. raw:: latex Subscriber, Phones tab in the Core Feature Guide .. raw:: html Subscriber (Phones tab) .. _deleting-a-subscriber: Delete a Subscriber '''''''''''''''''''''' This procedure deletes and unprovisions a subscriber. 1. Log in to the Admin Portal as a Customer admin or Site admin. .. note:: Only a subset of fields described in this procedure are visible to Site admins. 2. Choose the relevant site. 3. Go to (default menus) **Subscriber Management > Subscribers**. 4. Select the checkbox for each subscriber you want to remove; then click **Delete**. 5. Click **Yes** to confirm. The deleted subscriber is removed from the list. All elements associated with the subscriber are removed, except lines. .. note:: * If you have the global setting for phones configured to retain the subscriber's hard phones, then only the soft phones are removed. See *Global Settings* in the Core Feature Guides (Phones tab). * For scenarios that include an LDAP-integrated CUCM, users are deleted from the LDAP directory and not from the VOSS Automate system. Set up a data sync to synchronize the removal of the user.