.. _introduction-to-the-admin-gui:
Introduction to the Admin Portal User Interface
------------------------------------------------
.. _21.1|VOSS-693|EKB-1363:
.. _21.2|VOSS-879:
.. _21.3-PB2|EKB-2620:
.. _21.4|EKB-13551:
.. _21.4-PB1|EKB-14699:
.. _21.4-PB1|EKB-15076:
.. _21.4-PB1|EKB-14707:
.. _21.4-PB2|EKB-12532:
.. _21.4-PB2|EKB-13169:
.. _21.4-PB3|EKB-16879:
Overview
..........
This topic is a guide to the VOSS Automate Admin Portal user interface.
.. note::
VOSS Automate v21.2 ships with a new logo and an updated look and feel,
including additional options for customized themes. Additionally,
VOSS-4-UC is now VOSS Automate. As at v21.4, you may still see some references to
VOSS-4-UC. These will be replaced in future versions.
.. tip::
To easily copy data from a drop-down list or in a list view (provided you're using a mouse),
highlight the value while keeping the mouse button pressed down and use
the keyboard shortcut **CTRL-C** to copy, then release the mouse and paste the data where required.
.. image:: /src/images/admin-portal-gui-rebranded.png
.. rubric:: Related Topics
*
.. raw:: latex
Introduction to Themes in the Core Feature Guide
.. raw:: html
Introduction to ThemesTheme Customization
*
.. raw:: latex
Search in VOSS Automate in the Core Feature Guide
.. raw:: html
Search in VOSS Automate
Admin Portal Toolbars
...................................
In the VOSS Automate Admin Portal, icons on the main toolbar are always available, regardless
of the form or list you're viewing.
A form/list-based toolbar displays additional icons, depending
on the model you're working with (which defines the content on the form or list you're viewing),
and on your access profile and permissions. For example, if it's not
possible or allowed that you move certain items, the **Move** icon won't display.
Main Toolbar
''''''''''''''
The table describes the graphical controls and icons on the main Admin Portal toolbar:
.. image:: /src/images/admin-menubar-new.png
The table describes the icons on the main toolbar in the Admin Portal:
=============================== =====================================================================
1. Hierarchy tree view A hierarchy tree view and pop-up displays a tree
or list of available nodes.
See :ref:`navigating-the-hierarchy`
2. Hierarchy element A hierarchy element displaying the highest
hierarchy level. The associated child hierarchy
element display in a similar field display
box adjacent to the main hierarchy element.
If there is more than one level or node at a
specific hierarchy, you can search and
navigate the hierarchy.
See :ref:`navigating-the-hierarchy`.
3. Search Search bar. Fill out search criteria to use the default search
(Action search), or click the down arrow at the filter icon
to choose an alternative search mode:
* Action search - perform a fuzzy, free text, actions search,
for example, *Modify Voicemail* or *Create subscriber*.
* Filter search - choose from a predefined list of entities
* Global search - available only to users with appropriate
permissions; allows querying of the API for models and
search criteria
4. Transactions list Opens the transactions list, where you can view a list
of recent transactions and drill-down to view transaction
details.
5. Notifications indicator A notification indicator and menu for accessing
the Transaction log and Alerts (if alerts are
enabled). A pop-up notification displays when a
transaction is done. You can click on the message
to inspect transactions. Alert notifications
display until all alerts are removed from the list.
6. Help button Opens the system online Help in a new browser tab.
=============================== =====================================================================
=============================== =====================================================================
7. User profile (Cog icon) Provides a menu with items for:
* The logged in user's **Account Settings** (read-only),
**Quick Actions** to sign out or change password,
and **Preferences** where you can set the **Browser Console Log Level**.
If the **Browser Console Log Level** is set to ``Debug``,
your browser console (**Inspect** menu) provides
additional details when selecting menu items and instances
on the GUI, for example:
::
Model Type: relation/User, Field Display Policy: default,
Configuration Template: undefined, Fixed Filters: undefined
This setting reverts to ``None`` (default) when you sign out.
When set to ``None``, the browser console **Inspect** menu
does not show these details. See the note below this table for
more information about this setting.
* **About** form with version details - see: :ref:`about`.
* **Sign out** button to log out the user.
8. Landing page A customizable landing page and a Home
navigation button to return to the Home
page. See "Create a Landing Page" for
details.
* The system displays a welcome message the
first time a user logs in with a new
account.
* When a non-SSO or non-LDAP user logs in,
a system message alerts the user to any
failed login attempts.
* When SSO or LDAP users log in, the
system displays the last successful login
time.
10. Search field A search field to perform a fuzzy, free text,
actions search, for example, *Modify Voicemail* or
*Create subscriber*.
=============================== =====================================================================
.. note::
To view details for:
* the model
* field display policy
* configuration template
* fixed filters
applied to any page in the GUI, in **Account > Preferences** set **Browser Console Log Level** to ``Debug``, and
save your changes. Then open the page where you want to view these details, right click, and choose **Inspect** to open
the browser console.
.. image:: /src/images/browser-console-inspect.png
.. _button-bar:
Forms and Lists Toolbar
''''''''''''''''''''''''''''''''
For certain models, such as Roles or Credential Policy, the list view or detail
view of the record in the Admin Portal displays an additional toolbar with a number of controls.
The icons that display
on this secondary toolbar depend on your access profile and based on the functionality available for data on the
form or list (the model you're working with).
.. rubric:: Standard Icons
The table describes standard icons that typically display on all forms and lists.
.. tabularcolumns:: |p{4cm}|p{11cm}|
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Icon | Description |
+===================+===========================================================================================================================================================================================================+
| Filter | Allows you to filter items on a list. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plus icon (+) | Creates a new record from a list view. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Delete | From a list, remove an entry or the selected entries. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Move | You can move some model instances (by default, device models) from the current hierarchy to another hierarchy. When moving device models, the system won't allow you to move a device model instance to a |
| | hierarchy node with a different device. For data models, move is allowed if you edit the data model's definition in the Operations section. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Clone | Make a copy of the current item, and rename it to create a new instance. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Export | From search results or any list view in the system, it is possible to select the entities required and export them with all attributes. The selected data can be exported to: |
| | |
| | * A JSON file that is archived into .json.zip format for external use. |
| | * Excel - an export containing data and Excel columns for all fields as shown in the JSON export format. |
| | * Excel(formatted) - an export containing data and Excel columns as arranged by any Field Display Policies that apply. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Save | Saves a new or updated record. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Cancel | Cancels triggered events such as transactions or bulk loads. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Back | On forms, this icon returns to the original list page position. The browser's back button also carries out this action. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Help | Open the on-line help page for the current model. |
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rubric:: Overflow Actions Menu
On forms and lists that allow multiple actions, icons for key actions (for example, Filter, Add, Create, Update, Delete), are always visible on the toolbar,
whereas other available actions are accessible via a vertical ellipsis toolbar icon (|image53|), which displays a drop-down menu of the additional (overflow)
actions available for data on the form or list.
The image shows non-key actions available in the overflow menu when viewing or updating a user, for example:
.. image:: /src/images/gui-toolbar-vertical-ellipsis-action.png
.. note::
Accessibility support is provided for the overflow actions menu so that you can tab through the actions and
press **Enter** or space bar to select an action in the menu.
The table lists actions that may be available in an overflow actions menu on a form or list, if relevant for the
record and allowed for your access profile:
.. tabularcolumns:: |p{4cm}|p{11cm}|
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Action | Description |
+===========================+==============================================================================================================================================================================================================+
| Bulk Load File | Only used in **Administration Tools > Bulk Load**, when bulk loading a preselected file. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Bulk Modify | On the list view of certain items, the button displays a form to enter modifications to any selected list items and carries out a Bulk Modify. This is only available if your administrator has given you. |
| | the required permissions. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Configuration Template | For a form, create a Configuration Template for a model or carry out a task such as an advanced search. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{4cm}|p{11cm}|
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Action | Description |
+===========================+==============================================================================================================================================================================================================+
| Export Bulk Load Template | Export a model structure to a MS Excel bulk load file format. The file can be used as a template to bulk load instances of the model. Refer to the Bulk Load topic help. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field Display Policy | Add a Field Display policy to a selected model. The detail view of a Transaction displays this button to show sub-transactions. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Execute | For an executable model such as a Provisioning Workflow, Macro, Wizard or for a script, run the execution. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Import | For supported Network Devices, carry out an import of data from the device. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Package | Create a package containing selected search results. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Refresh | Click this button on the Transaction list to refresh the list of transactions. This would for example update the Progress of the transaction. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Replay | Transactions that have failed can, under certain circumstances, be replayed. This means that the transaction is re-submitted with the original request parameters. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Edit and Replay | Available for completed transactions. Similar to the **Replay** button, but allows you to first make changes to the previously submitted form before the transaction is resubmitted. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Reset Phone | Reset a phone. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Return | Return - From the detail display of a selected instance of a model, select this button to return to the list display of the model instances. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Tag | For a selected model instance, add a tag to it. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Tag Version | For a selected model instance, add a version tag to it. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Test Connection | For instances of models representing connection parameters such as connections to devices, click the button to test the connection. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Visualize | Deprecated. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Purge | Removes a record entirely. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| JSON Editor | Update a JSON file. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Apply | Saves and updates the record. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Lock | Disables editing. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Reset | Clears the record. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Restart | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Vendor Config | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Wipe | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Forms and Lists
...................
The Admin Portal displays information in forms and lists.
* Detail forms: during input, mandatory fields are highlighted in a red frame.
* List views of details. If the text in a column exceeds the defined column width,
it is truncated with an ellipsis (...), except for any column showing the row
entry hierarchy.
.. _form-controls:
Form Controls
''''''''''''''''
.. _21.2|VOSS-879|EKB-9717:
The following controls are typically available on forms.
.. tabularcolumns:: |p{5cm}|p{10cm}|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Icon | Description |
+======================+========================================================================================================================================================================================================+
| |image41| | Open another instance of the current form field or open a pop-up screen to add an item. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image42| | Delete the current instance of a field from a form or open a pop-up screen to confirm. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image43| | Move the selected instance on a form down in the order of field entries. In the case where a Position field is available, for example for Lines, the entered value determines the order in the object. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image44| | Move the selected instance on a form up in the order of field entries. In the case where a Position field is available, for example for Lines, the entered value determines the order in the object. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image51| | Collapse or expand all array items, for form arrays with multiple items. Arrays are collapsed by default. You can expand or collapse selected array items in a form array, or expand/collapse all |
| | from the form array header. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{5cm}|p{10cm}|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Icon | Description |
+======================+========================================================================================================================================================================================================+
| |image45| |image46| | On multi-tabbed forms, navigate to the previous or next tab. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image50| | A warning icon, for example if a mandatory field is not filled in. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| \* | Next to an input control on a form, the asterisk indicates that the field is mandatory. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| [Browse] | Next to an input control on a form, a button to open a file selection dialog. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| [ V] | Drop-down input box. Typing into the box filters the drop-down list choices. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note::
On some parts of the user interface, when adding or deleting items via pop-up screens,
clicking the **OK** button typically completes the update; that is, you won't need to
also click **Save** on the main form.
Switching Form Layouts
.........................
The layout of forms in VOSS Automate is defined via a number of field display policies (FDPs). For groups of
fields, the default layout for the field display policies setting, **Display Groups As**, is *Panels*, except for the forms associated with the following models, which
have their default layout as *Tabs*:
* view/GlobalSettings
* data/SiteDefaultsDoc
* data/ucprep_UC_Profiles
* relation/DP_REL
* data/HcsDpDialPlanSchemaDAT
* data/HcsDpDialPlanSchemaGroupDAT
On forms where you're able to change the layout (depending on your user type and the model type), you can click the layout change icon (**Switch to Panel Layout / Switch to Tab Layout**)
to switch between
a tab layout and a panel layout. The layout you choose is preserved when you log out and log in again.
.. image:: /src/images/tab-or-panel-form-layout.png
|
On some forms, the
action element to use for switching between tabs and panels may display in the overflow actions menu.
.. image:: /src/images/switch-layout-overflow-actions.png
|
.. raw:: html
The animation shows how you can switch between a tab and a panel layout on the Users page.
.. note::
This guide refers to the default layout for the model, unless otherwise specified.
Some form views do not have the action element available
to switch between tabs and panel form views. For details and the list,
see the "Display Groups As" topic at: :ref:`field-display-policies`.
.. rubric:: Related Topics
* :ref:`field-display-policies`
Slide out notifications
..........................
A **Cached** slide-out notification at the top right of the interface
displays when the locally cached data of a resource is used.
This slide-out notification can be minimized to a narrow bar on the
side of the screen.
Accessibility
.................
To support accessibility, when using keyboard navigation, a black bar
is enabled above the toolbar. When the cursor is in the URL box and the Tab key
is pressed, this bar is displayed and has three menu items corresponding to
three areas of the main user interface:
====================== ====================================================================================
Home screen From any form on the interface, return to the main user interface. This is
equivalent to the Home button on the main toolbar, and can, for example be
accessed by means of a screen reader shortcut.
Skip to content On the main user interface, move the focus to the landing page menu items. Press
to move the focus to the first landing page link.
Skip to navigation On the main user interface, move the focus to the menu bar. The first menu item
receives focus.
====================== ====================================================================================
Sessions and Authentication
...............................
Since VOSS Automate sessions are cookie based, it is possible to share the same
session across different tabs or windows of the same browser. However, it is not
possible to have different authentication sessions in different tabs. In
other words, login as different users in different browser tabs is not supported.
.. _on-line-help:
On-line Help
..............
.. rubric:: Classic Portal
Press the **Help** button on both the Main Menu button bar as well as the Button
bar to open a new browser tab to show on-line help for your system.
The new browser tab shows the following menu options:
#. General Help: General help information for the application.
#. Model Detail Help: Model (Item) specific help, for example data/GeneralHelp.
This content may vary according to the Field Display Policy that is
applied to the item.
#. Model API Help: the API reference for the item.
When the **Help** icon (?) is pressed on the main toolbar, only the three
menu options are shown.
.. rubric:: Admin Portal
Press the **Help** button on both the Main Menu button bar to be directed to the on-line help website.
.. rubric:: Context Sensitive Help
When the **Help** icon is clicked on a form or list-specific toolbar,
context sensitive help specific to the associated form is displayed.
If a field on the context sensitive help for an item is marked with an
asterisk next to the field name, it is mandatory and must be filled out in
order for the subsequent transaction to be successful.
A user's view of the available on-line help depends on hierarchy level,
role-based access, and field display policies.
.. _about:
About (System details)
........................
The **About** menu provides details for your system, including version, patches,
and adaptations.
.. note::
The **About** toolbar icon provides only version details.
Version
''''''''
* Release: Installed product release version.
The version naming convention is:
* new: *.*, for example: 19.3 is the 3rd release of 2019.
* legacy: *..*, where major=YY,minor=num,revision=revision of num.
* Patch Bundle: The installed Patch Bundle (PB) number, if any.
* Build Number: Product build number.
* Release Date: Date when this version was released.
* Deployed Mode: Current deployment mode type, for example:
* Provider with HCMF
* Provider Decoupled
* Enterprise
.. note::
You can use the toolbar Copy icon to copy version release text to the clipboard.
Patches
''''''''
If any patches have been installed on the system, these are listed
under the **Patches** menu. Details of installed patches are
also provided for reference and enquiries, for example:
* **Version**: in this context, the patch version
(there can be multiple versions of the same patch).
* **Defect IDs**: VOSS Automate internal IDs for reference
* **Models**: any models and model **Instances** added or affected by the
patch
Adaptations
''''''''''''
If any adaptations are installed on the system, these
are listed. Select an adaptation from the list to
see more details, for example:
* **Adaptation Tag(s)**: the tags can be used to find all models
that are a part of the adaptation, using a search query such as
::
(tag IS ) or (tag IS )
where ```` and ```` are the names of tags.
.. note::
The search for models is carried out from the user hierarchy and down.
* **Upgrade Risk**: an indication of the impact of an adaptation on
an existing system:
* High: Core changes
* Medium: Standalone adaptation using core workflows
* Low: Standalone feature
License
''''''''''''
This menu provides details for your current license, including the platform UUID, license status,
and expiry date. See also, :ref:`voss-license-management`.
.. |image53| image:: /src/images/icon_title_vertical-ellipsis.png
.. |image41| image:: /src/images/icon_title_plus.png
.. |image42| image:: /src/images/icon_title_minus.png
.. |image43| image:: /src/images/icon_title_down.png
.. |image44| image:: /src/images/icon_title_up.png
.. |image45| image:: /src/images/arrow_prev.png
.. |image46| image:: /src/images/arrow_next.png
.. |image50| image:: /src/images/icon_warning.png
.. |image51| image:: /src/images/icon_title_collapse-expand-all.png