[Index]
Model: data/adaptation_log
Patches
Full HTML Help
Overview
This topic describes the user interface for the VOSS Automate Admin Portal.
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.
Related Topics
Introduction to Themes in the Core Feature Guide
Theme Customization topics in the Advanced Configuration Guide
Search in VOSS Automate in the Core Feature Guide
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:
The table describes the icons on the main toolbar in the Admin Portal:
- Hierarchy tree view
|
A hierarchy tree view and pop-up displays a tree
or list of available nodes.
See Navigating the Hierarchy |
- 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 Navigating the Hierarchy.
|
- 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
|
- Transactions list
|
Opens the transactions list, where you can view a list
of recent transactions and drill-down to view transaction
details. |
- 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. |
- Help button
|
Opens the system Help file in a new browser tab. |
- 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: About.
Sign out button to log out the user.
|
- 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.
|
- 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.
Form Controls
The following controls are typically available on forms.
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. |
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.
On some forms, the
action element to use for switching between tabs and panels may display in the overflow actions menu.
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: Field Display Policies.
Related Topics
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
<Tab> 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
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.
Admin Portal
Press the Help button on both the Main Menu button bar to be directed to the on-line help website.
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 (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: <YY>.<num>, for example: 19.3 is the 3rd release of 2019.
- legacy: <major>.<minor>.<revision>, 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 <tag1>) or (tag IS <tag2>)
where <tag1> and <tag2> 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, Product License Management.
Docutils System Messages
System Message: ERROR/3 (<string>, line 339); backlink
Undefined substitution referenced: "image41".
System Message: ERROR/3 (<string>, line 341); backlink
Undefined substitution referenced: "image42".
System Message: ERROR/3 (<string>, line 343); backlink
Undefined substitution referenced: "image43".
System Message: ERROR/3 (<string>, line 345); backlink
Undefined substitution referenced: "image44".
System Message: ERROR/3 (<string>, line 351); backlink
Undefined substitution referenced: "image45".
System Message: ERROR/3 (<string>, line 351); backlink
Undefined substitution referenced: "image46".
System Message: ERROR/3 (<string>, line 353); backlink
Undefined substitution referenced: "image50".
Log of all adaptations applied to this system
Model Details: data/adaptation_log
- An asterisk * in the title indicates the field is mandatory.
- If a field has a default value, it is shown in the Description column.
- If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
- Object and array field names are listed to provide context. If a field belongs to an object or an array,
the full field name is shown in dot separated notation.
Adaptation Name
|
Friendly Name of Adaptation
|
- Field Name:
name
- Type: String
|
|
Adaptation Tag(s) |
The tag which all of the changed elements can be viewed
|
- Field Name: tag_array.[n]
- Type: Array
|
|
|
Tag |
Tag for all model included in the Adaptation
|
- Field Name:
tag_array.[n].tag
- Type: String
|
Change Type
|
Definition of change types adaptation being workflow, view and configuration being changes to things like gui rule
|
- Field Name:
change_type
- Type: String
- Choices: ["Configuration", "Adaptation"]
|
Date of Adaptation
|
Default: {{ fn.now %Y-%m-%d }}
|
- Field Name:
date
- Type: String
- Default: {{ fn.now %Y-%m-%d }}
|
Engineer Developer
|
Engineer who developed the adaptation
|
- Field Name:
engineer
- Type: String
|
Upgrade Risk
|
High:Upgrade Impact inevitable-core changes Medium:Standalone adaptation using core workflows Low:Standalone feature
|
- Field Name:
risk
- Type: String
- Choices: ["High", "Medium", "Low", "Adaptation Upgrade Required"]
|
Description of Adaptation
|
Verbose description of Adaptation
|
- Field Name:
description
- Type: String
|
Version
|
Adaptation version
|
- Field Name:
version
- Type: String
|
|
hierarchy_array |
|
- Field Name: hierarchy_array.[n]
- Type: Array
|
|
|
VOSS Model Type |
|
- Field Name:
hierarchy_array.[n].model_type
- Type: String
|
|
|
Model Name |
|
- Field Name:
hierarchy_array.[n].model_name
- Type: String
|
|
|
Hierarchy of Model |
|
- Field Name:
hierarchy_array.[n].hierarchy
- Type: String
|