.. _new-bap-user-interface:
Administrator User Interface
----------------------------
.. _19.1.1|VOSS-514:
.. _19.2.1|VOSS-539|EKB-2622:
.. _19.2.1|VOSS-539|EKB-2826:
The Business Administration Portal (BAP) interface menus and functionality
is defined as an interface type in VOSS-4-UC, along with the required role-based
access.
.. note::
The menus, features, and functionality described in this topic is based on the default interface type shipped
with the VOSS-4-UC product. Your system administrator may have customized a Business Admin Portal Custom Interface
for your organization. The look and feel, and the availability of features and dashboards is
defined via the interface type selected for your access role, and field display policies.
Refer to the Core Feature Guide for details.
The main interface is divided into three functional areas:
1. Toolbar
2. Menus
3. Dashboards (either the home page, service dashboard, menu landing page, or lists)
|new-bap-default-admin-gui|
.. rubric:: Related topics
* :ref:`new-bap-user-interface-controls`
* :ref:`concepts-bap-lists` (working in the lists)
*
.. raw:: latex
Feature Detail Dashboards in the Core Feature Guide
.. raw:: html
<a href="../feature-detail-dashboard.html">Feature Detail Dashboards</a>
.. _bap-toolbar:
Toolbar
.......
The table describes options on the Business Admin Portal toolbar:
.. tabularcolumns:: |p{3cm}|p{12cm}|
====================================== =======================================================
Company brand and menu labels toggle Displays your company brand as well as a toggle
switch to show (**<**) or hide (**>**)the side menu
labels.
Organization (hierarchy) selection Triggers a pop-up that allows you to navigate to a
specific level in the organization, for example, to provider,
customer, or site level, so that you can view and
manage resources at that hierarchy.
The hierarchy level
you're at remains visible at all times. For
details, see :ref:`new-gui-hierarchy-navigation`.
Search icon Opens the search dialog, where you can specify criteria
to run a search. See :ref:`new-bap-carry_out_search`.
Transaction log icon Opens the **Transaction Log** page, which lists the most
recent transactions in your system.
See: :ref:`transactions_panel`.
Messages icon Opens **Messages**, which lists recent notification
messages and transactions, including last login
details, and a link to the transaction log.
Application mode icon Allows you to toggle between the VOSS-4-UC
Admin Portal and the Business Admin
Portal (provided you have access to both
interfaces).
Settings A drop-down menu providing access to the following:
* Profile name: links to your account, to
view and/or edit the following:
* Account Settings (view username, email address,
role, last login, last password change)
* Preferences (define whether the default
application mode is Business Admin Portal or
Admin Portal, provided you have access to
both interfaces)
* About: opens the About page, displaying
release and version information
* Sign out
Home icon Home button to go to the Business Admin
Portal home page for your current hierarchy level.
Navigation breadcrumb A navigation path adjacent to the Home button allows
you to move to other areas of the system, based on
your current location. For example, to go from an
instance view (such as view subscriber) to a list of
those instances (such as the subscriber list).
Help Opens the system online help.
====================================== =======================================================
.. _bap-menus:
Menus
......
A left navigation menu in the Business Admin Portal provides access to resource and
service landing pages.
This topic describes the default menu layout that ships with the system. The custom interface
defined for your role determines the menu layout you will see in the Business Admin Portal.
Selecting a menu item opens the landing page for the option you choose. The default
menus are as follows:
* Site Management (sites and site defaults)
* Number Inventory (lines, and internal and external numbers, including number associations)
* Subscribers
* Phones
* Voicemail
* Extension Mobility
* Webex Teams (Webex Teams, users and licenses)
* Contact Center Management (Contact Center agents, teams, skills and resource groups)
* Hunt Groups (Hunt group members and groups)
* Call Pickup Groups (Call pickup group members and groups)
.. rubric:: Landing Pages
Selecting a menu in the left navigation opens the related menu landing page, with
options for viewing and managing the service or feature.
The default landing pages provide the following types of features:
.. tabularcolumns:: |p{3cm}|p{12cm}|
=================== =================================================================
Counters Cards providing item counts relevant to the menu, for example,
the number of sites, internal inventory, external inventory,
lines, or subscribers.
Clicking on a counter opens the list view for the item.
|new-bap-phones-counter-card|
Quick Actions Links to the screens for viewing and managing a feature or
service.
Some quick action links, such as Delete, launch just a pop-up.
If available, the *View* links (for example, view sites,
view internal inventory) open the list views, allowing you to
view and manage these items from the lists.
Graphs and charts Visual display of data (if available), providing a quick
view of metrics for the feature or service, for example,
license usage information for the Webex teams feature,
at the current hierarchy.
|new-bap-webex-license-usage-graph|
Usage charts that illustrate time periods, for example
**Usage Growth**, allow you to configure the chart to
display in either weeks or months, using a drop-down
located in the top right-hand corner of the chart.
|bapv2-usage-growth_b|
=================== =================================================================
.. _bap-home-page:
Home page
..........
When logging in to the Business Admin Portal, the Home page is the first page you see. The Home page
provides a summary view of your entire system, and includes:
.. tabularcolumns:: |p{3cm}|p{12cm}|
=============== ===========================================================================
Counters Cards displaying the total number of sites, subscribers, and phones,
at the current hierarchy level (for example, at customer or site level).
Click on a counter to go to the relevant menu landing page.
Quick Actions Links to common tasks, including:
* View Subscribers
* View Phones
* Reset Pin / Password
* Logout Phone
* Add Subscriber
* Add Phone
* Login User / Phone
Saved Searches Links to saved searches.
MACDs Per Day A graph indicating the number of move, add, and delete transactions
performed at the specified hierarchy, in the past week.
Graphs display only when data is available.
Notifications The following notification types display on the home page:
* Session expiry notification:
Displays alert message ("Your session will expire in <n> seconds.")
when the **Idle Session Timeout (minutes)** value in the
credential policy associated with your user role is reached.
Click **Stay Logged In** to continue your session. For details, see
topics on credential policies and session timeouts in the Core
Feature Guide.
* Missing required fields:
The system alerts you if you're attempting to submit a form with missing
required data.
=============== ===========================================================================
.. |bapv2-usage-growth_b| image:: /src/images/bapv2-usage-growth_b.png
.. |bapv2-sub-feature-detail-dash| image:: /src/images/bapv2-sub-feature-detail-dash.png
.. |new-bap-add-icon| image:: /src/images/new-bap-add-icon.png
.. |new-bap-save-icon| image:: /src/images/new-bap-save-icon.png
.. |new-bap-delete-icon| image:: /src/images/new-bap-delete-icon.png
.. |new-bap-export-icon| image:: /src/images/new-bap-export-icon.png
.. |new-bap-move-icon| image:: /src/images/new-bap-move-icon.png
.. |new-bap-phones-counter-card| image:: /src/images/new-bap-phones-counter-card.png
.. |new-bap-webex-license-usage-graph| image:: /src/images/new-bap-webex-license-usage-graph.png
.. |new-bap-help-icon| image:: /src/images/new-bap-help-icon.png
.. |new-bap-detail-card-table-layout| image:: /src/images/new-bap-detail-card-table-layout.png
.. |new-bap-settings-detail-hyperlink| image:: /src/images/new-bap-settings-detail-hyperlink.png
.. |new-bap-default-admin-gui| image:: /src/images/new-bap-default-admin-gui.png