[Index]

Model: data/Patch

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:

  1. Hierarchy tree view
 A hierarchy tree view and pop-up displays a tree or list of available nodes. See Navigating the Hierarchy
  1. 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.
  1. 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
  1. Transactions list
 Opens the transactions list, where you can view a list of recent transactions and drill-down to view transaction details.
  1. 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.
  1. Help button
 Opens the system Help file in a new browser tab.
  1. 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.
  1. 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.
  1. 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:

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.

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).

Standard Icons

The table describes standard icons that typically display on all forms and lists.

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.

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 (), 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:

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:

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.
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.

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:

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:

  1. General Help: General help information for the application.
  2. 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.
  3. 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

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:

Adaptations

If any adaptations are installed on the system, these are listed. Select an adaptation from the list to see more details, for example:

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".

A Patch represents an update to one or more models in a bundle. The patch tracks the version of the models and packages updated, the source code files that were modified, and the reason.

Model Details: data/Patch

Title Description Details
base Group Assigned by FDP
  • Field Name: base
  • Type: Object
Name * The unique name of the patch.
  • Field Name: base.name
  • Type: String
  • MaxLength: 1024
Description Description of the patch.
  • Field Name: base.description
  • Type: String
  • MaxLength: 1024
Patch Version The version of the patch.
  • Field Name: base.version
  • Type: String
  • MaxLength: 1024
Notes A description of any side-effects resulting from applying this patch, such as migration of existing data.
  • Field Name: base.notes
  • Type: String
  • MaxLength: 1024
Releases The HCS release to which this patch applies.
  • Field Name: releases.[n]
  • Type: Array
Models
  • Field Name: models.[n]
  • Type: Array
Type The type of model included in the patch.
  • Field Name: base.models.[n].model_type
  • Type: String
  • MaxLength: 1024
Instances
  • Field Name: model_instances.[n]
  • Type: Array
Instance The business key of the model included in the patch.
  • Field Name: base.models.[n].model_instances.[n].model_instance
  • Type: String
  • MaxLength: 1024
Version The new version of the patched model.
  • Field Name: base.models.[n].model_instances.[n].model_version
  • Type: String
  • MaxLength: 1024
Defect IDs A list defects that are fixed by this patch.
  • Field Name: defect_ids.[n]
  • Type: Array