.. _introduction-to-the-admin-gui:
Guide 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:
.. _21.4-PB3|EKB-16988:
.. _21.4-PB5|VOSS-1261|EKB-19391:
.. _24.1|EKB-19980:
.. _24.1-PB2|EKB-21314:
.. _25.1|EKB-21317:
.. _25.1|EKB-23489:
.. _25.1|EKB-23602:
.. _25.3|EKB-20180:
.. _25.4|EKB-26618:
.. tip::
:ref:`use-action-search-to-navigate-automate`
Overview
..........
This topic is a guide to the standard functionality found in the Automate Admin Portal user interface
toolbars, forms, and lists.
.. note::
Automate 25.1 ships with role-based GUI layouts, available by default on new installs, that can be enabled for
different roles. For details, refer to :ref:`default-and-custom-menus`.
.. rubric:: Related topics
*
.. raw:: latex
Role-based dashboards and menus, in the Core Feature Guide
.. raw:: html
Role-based dashboards and menus
*
.. raw:: latex
Introduction to Themes in the Core Feature Guide
.. raw:: html
Introduction to Themes
*
.. raw:: latex
Theme Customization topics in the Advanced Configuration Guide
.. raw:: html
Theme Customization
*
.. raw:: latex
Search in Automate in the Core Feature Guide
.. raw:: html
Search in Automate
* :ref:`concepts-working-with-lists`
Admin Portal toolbars
........................
In the Automate Admin Portal, icons on the main toolbar are always available, regardless
of the form or list you're viewing.
.. important::
Some icons (and related functionality) are available only if your access profile permissions allow it. For
example:
* The **Transaction** icon is available only if you have read permissions on ``tool/Transaction``
* The **Saved Searches** panel is available only if you have read permissions on ``data/UserSavedSearch``
* You'll only receive alert notifications if you have read permissions on ``data/Alert``
* The **Help** book icon displays only when you have access to the general help (Misc Permissions)
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/toolbar-dashboards.png
The table describes the icons on the main toolbar in the Admin Portal:
=============================== =====================================================================
1. Home The Home button displays a customizable dashboard that serves as a
landing page. See "Automate Dashboards" 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.
2. Organization Selection Launches a hierarchy (organization) tree view that displays a tree
or list of available nodes.
See :ref:`navigating-the-hierarchy`
Note that the accent color is used for this element.
3. 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`.
4. Search The toolbar 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 user*.
* 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
5. Transactions log Displays the Opens the Transactions Log, where you can view a list
of in progress and recent completed transactions, and drill-down
to view transaction details.
The pulsing counter above the icon indicates the number of transactions
currently in progress. The spinner adjacent to the icon indicates
that your transactions are in progress.
6. Messages 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.
7. Wingman Opens Wingman Chat if enabled. Refer to :ref:`voss-wingman`.
=============================== =====================================================================
=============================== =====================================================================
8. Help Opens the system online Help in a new browser tab.
9. Settings (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.
=============================== =====================================================================
.. note::
To view details for and of the following applied to any page in the GUI, on the **Preferences** page,
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:
* Model
* Field display policy
* Configuration template
* Fixed filters
.. 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. |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Refresh | Manually refresh a list view to load updated data. |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. A Cancel icon on forms aborts the page or action. |
+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 via the **Bulk Load** page, 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. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Refresh User | On the **User Management** page, click **Refresh User** to align user data in relation/User with user data from source, caching from the UC application. This option is not exposed by default in the access |
| | profiles. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Align Hierarchy to Sync | Used for managing users. See *User added as Microsoft Active Directory LDAP User*. |
| Source | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Align Hierarchy to User | Used for managing users. See *User added as Microsoft Active Directory LDAP User*. |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Restart | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Vendor Config | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Wipe | |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Forms and lists
...................
The Admin Portal displays information in forms (pages) and lists.
====================== ============================================================================
Detail 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.
====================== ============================================================================
.. 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.
Alternatively, a selected item (drop-down list selection box is active) from a drop-down list can be
copied with **CTRL-C** and pasted into another input field using **Ctrl-V**.
.. _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| | Plus. Open another instance of the current form field or open a pop-up screen to add an item. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image42| | Minus. Delete the current instance of a field from a form or open a pop-up screen to confirm. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image43| | Down arrow. 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| | Up arrow. 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/expand icons. 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| | Left arrow. Right arrow. On multi-tabbed forms, navigate to the previous or next tab. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |image50| | Warning. Used, 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. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |linkIcon| | URI link. A link icon that appears next to certain drop-down fields. When clicked, it opens the related entity (such as a configuration template, relation model, or resolved target model) based on |
| | the field value. Link visibility depends on access permissions, and may also be controlled or overridden by GUI rules (for example Hide Link or Link Target Override). For full details, see |
| | *Navigate to related entities from drop-downs*. |
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. 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.
.. rubric:: Related topics
* :ref:`go-to-related-entity-from-dropdown`
*
.. raw:: latex
Introduction to access profiles in the User Guide
.. raw:: html
Introduction to access profiles
*
.. raw:: latex
GUI rules in the Admin Guide
.. raw:: html
GUI rules
Switching form layouts
.........................
The layout of forms in 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`
Pop-ups and slide out notifications
....................................
* A **Please confirm** pop-up notification appears in the middle
of an add or edit form of the interface if the **Enter** key is used
in the input field. This notification thus allows for the confirmation of
the data currently entered or edited prior to saving the form.
.. image:: /src/images/confirmation-notification.png
* 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.
.. _go-to-related-entity-from-dropdown:
Navigate to related entities from drop-downs
..............................................
The VOSS GUI provides clickable link icons next to certain drop-down fields. These links allow direct
navigation to the related entity shown in the drop-down, such as a configuration template (CFT) or
model instance.
.. image:: /src/images/clickable-links-to-entities.png
.. rubric:: When links are shown
Link icons display only when both of the following are true:
* The field has a value
* The user has access to the target model (based on their access profile)
Access permissions always take precedence. If a user lacks permission to the target, the link icon
does not display, even if other rules would normally allow it.
.. rubric:: Supported link targets
Drop-down links support the following types of targets:
* **Direct URI links**: If the drop-down provides a direct URI, the link opens that resource.
* **Macro-backed drop-downs**: Links are shown when the system can determine the underlying model type.
The following common macro functions are supported and route to the Number Inventory list view,
(``InternalNumberInventoryREL``), with the selected drop-down value applied as a filter:
* ``fn.get_lines``
* ``fn.get_filtered_lines``
* ``fn.get_lines_associated_to_user``
* ``fn.get_available_vm_patterns_dropdown``
* **Device and data models**: When a drop-down references a ``device/*`` or ``data/*`` model, the system
dynamically resolves the corresponding relation model and routes the link there.
.. rubric:: GUI Rule overrides
Administrators can customize link behavior using GUI Rules:
* **Hide Link**: Force hides the link icon
* **Link Target Override**: Replaces the default link target with a custom one
.. rubric:: Where links take you
After determining the correct target, the system applies any relevant filters and opens the corresponding
detail or list view at the same hierarchy level.
This feature applies broadly across drop-downs in the GUI, including areas like Quick Add Groups, to
streamline administrator workflows.
.. rubric:: Related topics
*
.. raw:: latex
Introduction to access profiles in the User Guide
.. raw:: html
Introduction to access profiles
*
.. raw:: latex
GUI rules in the Admin Guide
.. raw:: html
GUI rules
Sessions and authentication
...............................
Since 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
..............
To access the full online help website from the Automate Admin Portal, press the toolbar Book icon. To access
help for a page you've viewing in the system, click the **Help** icon.
The page-level (context) help also includes a **Full HTML Help** link for the entry on the online help
website and the model help (as seen in the GUI tooltips).
.. note::
* To access the online help website URL, you may need to request that the website be made accessible by your network administrator.
* Your view of the system help depends on your hierarchy level, role-based access permissions, and the
field display policies applied to your system.
.. |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
.. |linkIcon| image:: /src/images/icon_link.png
.. |searchIcon| image:: /src/images/searchIcon.png
.. |refresh| image:: /src/images/refresh-icon.png
.. |cancelIcon| image:: /src/images/cancel-icon.png