.. _concepts-view-subscribers-bap:
View and Manage Subscribers
----------------------------
.. _21.1|VOSS-795:
.. _21.2|VOSS-873|EKB-10590:
.. _21.2|VOSS-873|EKB-10405:
.. _21.3|VOSS-891:
.. _21.3-PB1|VOSS-1072|EKB-12802:
Overview
..........
In the Business Admin Portal you can view and manage subscribers and services in the Subscriber lists
and on the Subscriber dashboards.
.. note::
* To view multi vendor subscribers, your user role must be assigned a
Business Admin Portal profile enabled for multi vendor, and multi vendor must be appropriately
configured for your system.
See Business Admin Portal Profiles in the Core Feature Guide.
View All Subscribers
.....................
The Subscribers list in the Business Admin Portal provides a summary view of subscriber
services from a MACD perspective, and displays:
* All users from a given hierarchy and down (Reseller, Provider, Customer, or Site)
* A **Services** column, with icons representing the user's currently provisioned services (tooltips
describe the service types and provisioning vendors).
Multi-vendor subscriber functionality, such as the list view **Services** column icons and
the user's dashboard **Hybrid Status** service card, displays only for users with
Microsoft services already provisioned, and is configured via the Business Admin Portal profile-related
field display policy for multi-vendor subscribers. If a Subscriber does not have Microsoft services,
the Hybrid Service card will not be displayed.
**To view all subscribers at a selected hierarchy**:
#. Log in to the Business Admin Portal.
#. Choose the hierarchy.
#. Click (default menus) **Subscribers** in the left menu.
#. On the **Subscribers** landing page, either click the **Subscribers** counter on the page,
or in the **Quick Actions**, click **View All Subscribers**.
#. View the list of subscribers, noting values in the columns:
* Username
* First name, last name, and email address
* Entitlement profile
* User type
* Services (showing icons for services where the subscriber has the service enabled)
* Location (in the hierarchy)
The table describes the **Services** column icons:
.. tabularcolumns:: |p{2cm}|p{13cm}|
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| Icon | Description |
+===================================================+==================================================================================================================================+
| |bap-multi-vendor-phone-icon| | Phones icon. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| |bap-multi-vendor-voicemail-icon| | Voicemail icon. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| |bap-multi-vendor-conferencing-icon| | Conferencing icon. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| |bap-multi-vendor-collaboration-icon| | Collaboration icon. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| |bap-multi-vendor-contact-center-icon| | Contact Center Express icon. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| |bap-exchange-icon| | Indicates a subscriber enabled for Microsoft Exchange mail. You can click on the icon to manage Exchange mailbox |
| | settings, such as permissions and calendar permissions. |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
.. Removing this till hybrid is released |bap-multi-vendor-hybrid-status-icon| The hybrid status.
View and Edit a Single Subscriber
..................................
Each subscriber can be viewed and updated via a dashboard that displays their
user and service details. A subscriber's dashboard in the Business Admin Portal
displays displays user details, quick actions,
and service cards that provide a detailed view of services provisioned to the subscriber,
including vendor information.
#. Click **Subscribers** in the left menu (default menu) to open the **Subscribers** landing page.
#. Click the **Subscribers** count card to view the list of all subscribers.
#. Click on a subscriber in the list to open that subscriber's dashboard.
From the dashboard, provided your role has appropriate permissions at the hierarchy, you can:
* View and edit subscriber details
* View and edit subscriber services, which display in a card layout (one card per service)
* Access quick actions for the subscriber (based on settings enabled at the hierarchy, installed
devices/services, and specific to the vendor services available to the user)
* Initiate MACDs, per service
* Define the extension to use as primary line
The table describes components on a subscriber's dashboard in the Business Admin Portal:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+---------------+----------------------------------------------------------------------+
| Panel | Description |
+===============+======================================================================+
| User Details | * User Name |
| | * First Name |
| | * Last Name |
| | * Email Address |
| | * Entitlement Profile |
| | * Enable IM & Presence (Cisco user) |
| | |
| | Gives a subscriber access to IM and Presence (provided |
| | the customer is configured for IM and Presence, and the |
| | `BusinessAdminUserDetailsFDP` field display policy, |
| | which defines the fields available on the page, is |
| | configured to show the checkbox). |
| | |
| | Regardless of the setup of |
| | `BusinessAdminUserDetailsFDP`, the ``previous_username`` |
| | and ``cucm_bkey fields`` don't display since these are |
| | used only by the workflows. |
| | |
| | * IPCC Extension (Cisco user) |
| | |
| | Displays all lines the subscriber has for IPCC |
| | extension, and may be enabled via the |
| | `BusinessAdminUserDetailsFDP` field display policy |
| | (when ``ipccExtension`` and ``ipccRoutePartition`` is |
| | enabled). |
| | |
| | For the drop-down to display: |
| | |
| | * A CCX device must exist and be available for the |
| | hierarchy. |
| | * Contact Center service must be configured and |
| | available for the hierarchy. |
| | * The subscriber entitlement profile must allow |
| | support for Contact Center |
| | |
| | The IPCC Route Partition drop-down displays once you |
| | choose a line (Cisco). |
+---------------+----------------------------------------------------------------------+
| Quick Actions | Links to frequently used action, which may include one or |
| | more of the following, as defined by an administrator: |
| | |
| | * Reset Pin / Password |
| | * Delete All Services |
| | * Add Cisco User (Profile) |
| | * Refresh |
| | * Add Cisco User (QAS) |
+---------------+----------------------------------------------------------------------+
| Service Cards | A service card displays for each service assigned and |
| | available to the subscriber. For example, there may be |
| | service cards for one or more of the following: |
| | |
| | * Cisco Voicemail |
| | * Cisco WebEx |
| | * Cisco Webex App |
| | * Cisco Contact Center |
| | * Microsoft Teams |
| | * Microsoft 0365 |
| | * Microsoft Exchange - if enabled, click Edit to open the |
| | User Mailbox settings. (See also, Microsoft Exchange |
| | in the Core User Guide) |
| | * Hybrid Status - displays status or option to update or add, |
| | which redirects to the **Hybrid Subscriber Management** form. |
+---------------+----------------------------------------------------------------------+
If a Subscriber *does* have Microsoft Services, the Hybrid Service card will be displayed
with Hybrid Services detail if already set up with an Edit Action for updating. This will
route the user to the Quick Add Subscriber Hybrid Services Form for configuration.
Otherwise, it will be displayed as an empty card with a + icon for adding/configuring
Hybrid Services which would route the user to the Quick Add Subscriber form for configuration.
Service Cards on a Subscriber's Dashboard
''''''''''''''''''''''''''''''''''''''''''''
Service cards on a subscriber's dashboard represent the services assigned or available to a
subscriber. Edit actions in the service cards provide access to MACD functions allowed by
the Business Admin Profile, and are defined via field display policies.
Service availability may depend on whether the appropriate devices and services are installed or
enabled. For example, only Cisco-related quick actions and service cards display if the
user only has Cisco services or if your system is set up only for Cisco (that is, a single vendor installation,
in this example).
In some instances, the service card displays the service provisioning status, that is, whether the
service is enabled. For example, Microsoft Teams and Microsoft Exchange must be explicitly enabled
for the subscriber to have these services available.
For multi vendor users with services from two or more vendors (for example, Microsoft and Cisco),
the service cards specify vendor information, and a specific **Hybrid Status** card shows details
of hybrid subscribers with an option to update or add, which redirects to the
**Hybrid Subscriber Management** form. Refer to the Hybrid Service Definitions topic in the Core Feature Guide.
Fields are pre-populated for some services, based on the selected Quick Add Group (QAG),
and on configuration templates chosen when adding the subscriber.
Subscriber Services
.....................
The **Services** column on the Subscribers list view in the Business Admin Portal displays icons that
indicate the service type assigned to a subscriber.
**To view or edit a subscriber's services from the Business Admin Portal**:
1. Log in to the Business Admin Portal, and choose the relevant hierarchy.
#. From the Home page (or via the **Subscribers** menu), click **View All Subscribers** (or the
**Subscribers** counter) to open the **Subscribers** summary list view.
#. Click on an icon in the **Services** column.
.. note::
The presence of any icon in this column indicates that the subscriber has services assigned.
#. On the subscriber's services dashboard, view their user details, available quick actions, and
a service card for each service assigned or available to this subscriber.
The table describes the types of vendor services that may be available to VOSS Automate subscribers:
.. note::
VOSS Automate supports multi vendor scenarios, allowing subscribers to be assigned services
from different vendors, if this is configured for your system.
================================= =============================
Microsoft subscriber services Cisco subscriber services
================================= =============================
Voice (a phone and line) Cisco Phones
Voicemail Cisco Extension Mobility
Microsoft Teams Cisco voicemail
Microsoft Exchange mailboxes Cisco Single Number Reach
Cisco Jabber
Cisco WebEx
Cisco Contact Center
Cisco Webex App
================================= =============================
View and Update Microsoft Subscriber Services
..............................................
To view and edit the details and services of a Microsoft subscriber in the Business Admin Portal:
1. Log in to the Business Admin Portal, and choose the relevant hierarchy.
2. Click the Subscribers menu.
3. On the **Subscribers** landing page, click the **Subscribers** counter, or click
**View All Subscribers** to open the **Subscribers** summary list view.
4. Locate the relevant subscriber, and click on an icon in the **Services** column of the **Subscribers**
list view to open the subscriber's services dashboard.
5. View or update the relevant account details or service. One or more of the following may be
available:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+---------------+-----------------------------------------------------------------+
| Components | Description |
+===============+=================================================================+
| MS 365 | Microsoft user details. You can update the **Usage Location** |
| | field, and view license details. |
+---------------+-----------------------------------------------------------------+
| MS Teams | MS Teams user details, including MS Teams provisioning status, |
| | feature type, Line URI (with line type). |
+---------------+-----------------------------------------------------------------+
| Local user | View the subscriber's local user details, such as user name, |
| | title, and email address. |
+---------------+-----------------------------------------------------------------+
| Exchange | Assign access permissions for this subscriber's mailbox, and |
| | assign permissions for the calendar associated with this |
| | mailbox. See also, Microsoft Exchange in the Core User Guide. |
| | This service is editable only when Microsoft Exchange is |
| | enabled for your system. |
| | |
| | Microsoft Exchange mailboxes cannot be added or deleted from |
| | the Business Admin Portal. |
+---------------+-----------------------------------------------------------------+
Add a Subscriber
..................
To add a subscriber in the Business Admin Portal:
1. Log in to the Business Admin Portal.
#. Choose the hierarchy, for example, provider or site.
#. Click **Subscribers** in the left menu to open the **Subscribers** landing page.
#. In the **Quick Actions**, click **Add Subscriber**.
#. On the **Add Subscribers** page, fill out the new subscriber's details:
* Choose a user.
* Fill out the subscriber's first name and last name.
* Fill out the subscriber's email address and mobile number.
* Add a password and pin.
* Define whether to assign the next available line.
* Choose a **Subscriber Profile**.
The subscriber profile defines the services that may be assigned to this subscriber. You won't
be able to add this subscriber if the profile you choose has no services enabled.
If the Global Setting **Enable Cisco / Microsoft Hybrid** is enabled, the list of profiles
will include the profiles associated with the **Hybrid Service Definitions**. This will allow
for Cisco-Microsoft hybrid subscriber management and if the **Use next available line** option
is disabled, then the selected **Line** also automatically determines service functionality
if for example the "Cisco-MS-Hybrid" profile is selected.
For details on the services and devices associated with these profiles,
refer to the Hybrid Service Definitions topic in the Core Feature Guide.
.. note::
Only a system-level administrator can delete the default subscriber profile (if available).
* Click **Save**.
.. note::
The **Services** panel displays services assigned to the subscriber via the profile.
* By default, service names are auto-generated (based on the username).
To override the phone name and line details, clear the relevant checkboxes,
and manually update the details.
* When editing a subscriber, **New Services** does not display already
assigned services, or services where the necessary servers aren't set up.
.. rubric:: Related Topics
*
.. raw:: latex
Administrator User Interface in the Business Admin Portal Guide
.. raw:: html
Administrator User Interface
* Multi Vendor Subscribers in the Core Feature Guide
* Hybrid Cisco-Microsoft Management in the Core Feature Guide
*
.. raw:: latex
Subscribers in the Business Admin Portal Guide
.. raw:: html
Subscribers (Landing Page)
*
.. raw:: latex
Business Admin Portal Profiles
.. raw:: html
Business Admin Portal Profiles
* Microsoft Exchange in the Core Feature Guide
* Move Subscriber in the Core Feature Guide
* Add and Edit Roles in the Core Feature Guide
.. |bap-multi-vendor-phone-icon| image:: /src/images/bap-multi-vendor-phone-icon.png
:align: middle
.. |bap-multi-vendor-voicemail-icon| image:: /src/images/bap-multi-vendor-voicemail-icon.png
:align: middle
.. |bap-multi-vendor-conferencing-icon| image:: /src/images/bap-multi-vendor-conferencing-icon.png
:align: middle
.. |bap-multi-vendor-collaboration-icon| image:: /src/images/bap-multi-vendor-collaboration-icon.png
:align: middle
.. |bap-multi-vendor-contact-center-icon| image:: /src/images/bap-multi-vendor-contact-center-icon.png
:align: middle
.. |bap-multi-vendor-hybrid-status-icon| image:: /src/images/bap-multi-vendor-hybrid-status-icon.png
:align: middle
.. |bap-exchange-icon| image:: /src/images/bap-exchange-icon.png
:align: middle