[Index]
Overview
Landing pages define the look and feel and layout of elements that display in the main part of the system screens.
Note
This topic describes functionality as displayed in the Admin Portal. The look and feel of landing page and menu layout configuration options may differ in the classic Admin GUI.
When selecting a menu item that has been set to be a landing page, the main part of the system screen will then be the landing page defined for that menu item.
In addition, when logging or when clicking the Home button from anywhere in the system, you will see the landing page defined as the Landing Page on the user's role.
Note
Saved Searches are shown as the first landing page entry on the Home page.
Default landing pages ship with the system, associated with pre-defined roles in the hierarchy, for example Provider, Customer, and Site administrators.
You can modify landing pages to set up direct links to areas in the system, which can be used as short-cuts by the administrators, based on their role.
Note
When viewing lists or forms that link from landing pages, you can navigate back to the landing page via the breadcrumb.
Customizing Landing Pages
You can clone (copy) existing landing pages and then create a new landing page based on pre-populated settings, or the landing page can be exported, edited externally, and then re-imported. Designers with access to the tag function can use tag versions to uniquely identify different landing pages, and to track and control changes.
Landing pages may be customized for different user roles, and include several configurable elements:
Counters
Widgets
Charts can be selected to show:
Sections
Add or Edit a Landing Page
This procedure adds a new landing page and edits an existing landing page.
Log in to the Admin Portal as a Provider administrator, or higher.
Choose the hierarchy level for the landing page, for example, Customer.
Go to (default menu) Role Management > Landing Pages to open the Landing Pages list view.
Choose an option:
Create a new landing page using the settings of an existing one | Recommended method. Click on the relevant landing page to open its editing screen, then click Clone. Update the settings of the cloned landing page and save it as a new landing page. Go to the next step for details around configuring your new landing page. |
Create a new landing page from scratch | Click the Plus (+) icon to add a new record. Go to the next step for details around configuring your new landing page. |
Edit an existing landing page | Click on the landing page in the list view to open its editing screen, update settings, and save your changes. |
On the Details tab, configure the options for the landing page. See: Landing Pages Field Reference.
Note
On the Welcome Header, configure the following options:
Save the landing page.
Assign the landing page to the relevant roles or add to a menu layout.
Landing Pages Field Reference
The table describes the configuration options for landing pages on the Details tab:
Column | Description |
---|---|
Name | The name of the landing page. |
Description | An optional description of the landing page. |
Counters | These rows display the model-type instance counts (one or more) that display on the landing page. Click in a row to edit an existing counter, or click the Plus icon (+) to add a new counter. Use the hamburger icon to re-order the counters. Refer to further details in the tables below. |
Widgets | A side-by-side transfer box is available to select and order widgets. Widgets typically show data in a chart or details format. Note The Headset Summary By Model widget cannot be arranged side-by-side with another widget since it spans the entire landing page. In order to group widgets on the landing page, ensure this widget is ordered as either the first or last in the Selected list. Refer to further details in the tables below. |
Sections | These rows display the sections (one or more) that display as blocks on the landing page. Click on an item to edit it, or click the Plus (+) icon to add a new section. Use the hamburger icon to re-order the sections. Refer to further details in the tables below. |
Links | Configures links in sections on landing pages. Items are arranged in two columns. Refer to further details in the tables below. |
Common: Counters, Widgets, Sections
The table describes common edit functionality and data types typically available for the various landing page elements - Counters, Widgets and Sections:
Column | Description |
---|---|
Reorder | Click on the reorder icon in the relevant row to change the location of a landing page element. |
Add, clone, or delete row | Click an icon to either add a row, clone (copy) a row, or to delete the row. Clicking the Delete icon in a row triggers a system message asking you to confirm that you want to remove the row. This allows you to review the change in case you clicked the Delete icon by mistake. Clicking the toolbar Save icon saves all changes to the landing page you're configuring. |
Type | The model type to associate with the landing page element. Blank when href field is populated. The model type shows the related FDPs (field display policies) and CFTs (configuration templates) that can be applied. When type is view (view/ModelType), the value for Display As must be Form. |
Href | Mandatory when the value for Display As is External Link. For backwards compatibility, hrefs can be used for links within the application to link directly to a form. For example, (example API URL for a list of items of type relation/SubscriberPhone) the Add Phone page would have the following href (API URL): api/relation/SubscriberPhone/add In this case, you'll need to use JSON-format landing page import, or bulk load, to add any associated field display policies (FDPs) and configuration templates for the menu item. The recommendation is not to use hrefs to reference view/ type models. Href is a direct reference to a model type (the path), if applicable. If used, the Type field is empty. |
Field Display Policy | The field display policy associated with the landing page element: Counters or Sections. |
Configuration Template | The configuration template associated with the landing page element: Counters or Sections. |
Counters
The table describes configuration options for Counters:
Column | Description |
---|---|
Icon | The icon to be used for this counter. |
Title | Mandatory. The title to be displayed for this counter, for example, Phones, Users. |
Filters | For Filters, fixed and configurable filters can be applied to the counters, so that the count is carried out in accordance with the filters. Fixed filters can't be removed. Filters are relevant only for models where we have a list (not forms). The following options are available for filters once the Counter Type is selected:
|
Condition | Click in the cell to add or edit a macro that allows you to display/hide the counter, based on a condition specified in a macro. If the macro evaluates to true, the counter displays, else, when false, the counter is hidden. The default is true (counters you add display by default). A condition may be needed if the counter, for example, relates to a feature that has to be enabled. Examples:
See the Advanced Configuration Guide for more information about using macros. |
Sections
The table describes configuration options for Sections:
Column | Description |
---|---|
Links | Displays a Links table where you can configure links in the section. |
Title | Mandatory. The section title as it will show on the Landing page. |
Image URL | NB: This image is only displayed on the classic GUI landing page section. Select a landing page section image from the drop-down list. Optionally, an URL image to be displayed as section image. For example, let's say a theme is uploaded with landing page images, and the theme folder has a subfolder with the following file: mytheme/img/landingpage/landing1.png In this case, the URL would be: /www/themes/mytheme/img/landingpage/landing1.png |
Condition | Click in the cell to add or edit a macro that allows you to display/hide the section, based on a condition specified in a macro. If the macro evaluates to true, the section displays, else, when false, the section is hidden. The default is true (sections you add display by default). Examples:
See the Advanced Configuration Guide for more information about using macros. |
Links
The table describes configuration options for Links in sections on a landing page:
Column | Description |
---|---|
Filters | Click the filter icon in the relevant row to display a dialog where you can choose fixed and configurable filters for the link. Fixed filters can't be removed and are applicable when Display As is 'List'. Filters are relevant only for models where we have a list (not forms). The following options are available for configurable filters for links:
|
Icon | The icon to use for the link. Click in the cell to choose an icon. Icons display in the drop-down with a descriptive name. |
Link Text | Mandatory. Text for the link. |
Description | Add a description of the link. |
Column | Description |
---|---|
Condition | Optional. Specify a macro as a condition to define whether the link displays on the landing page. If the macro evaluates to True (default), the link displays. See the Advanced Configuration Guide for more information about using macros as conditional criteria. |
Href | If a direct reference to a model type is used for the menu item, the specified path. |
Set as default Model Type | This menu entry configuration is the default for this model type. Its selected Field Display Policy and Configuration Template will be used for the model in cases like search and when not navigating from a menu or landing page. |
Column | Description |
---|---|
Display As | Click in the cell to choose how the menu item should display. The default is List. Options are: List, Landing Page, Form, External Link, Tree
|
Landing Page Examples and Suggestions
From release 21.4, VOSS Automate provides a set of sample "Dashboard" landing pages that can be used or customized (cloned to a required hierarchy and modified) and referenced in a menu layout that can then for example be associated with an administrator user role.
The sample landing pages are designed to support both Cisco and Microsoft devices and services. Service, user or device counters and a section titled Quick Actions are included that contain links to carry out common tasks.
Note
A user's Access Profile - Permitted Operation options on a Permitted Type - will impact the availability of a related quick action entry on a landing page. See: Access Profiles.
The example below is the default "Dashboard Subscribers" landing page, for example associated with a Subscribers menu item:
From release 21.4 onwards, VOSS Automate provides a set of landing pages, menu layouts and field display policies that are used in two sample menu layouts - for use or customization as a Business Administration Portal menu layout to be added to a user's role.
The example below shows the Call Groups setup and display:
Example display of Number Management landing page:
The lists below are the landing page names grouped by the provided sample menu layout names.
Field Display Policies:
Landing Pages: MenuSiteAdmin
Landing Pages: MenuCustomerAdmin
Related Topics
Menu Layouts in the Core Feature Guide
Advanced Configuration Guide
HCS Dial Plan Macros in VOSS Automate in the Core Feature Guide
Fixed and Configurable Filters in Menus and Landing Pages in the Core Feature Guide
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
This procedure adds a new landing page.
Note
To create a new landing page based on settings in an existing landing page, it is recommended that you clone the landing page you want to work with, save it as a new landing page, and edit the settings to create the new landing page.
Perform these steps:
Log in as the provider administrator, or higher.
Choose the hierarchy level for the landing page.
Go to (default menu) Role Management > Landing Pages.
To create a new landing page based on settings in an existing landing page (recommended), click on the relevant landing page to open its editing screen, then click Clone.
On the Details tab:
Define a name for the new landing page.
In Meta Tasks, click the Plus icon (+), then configure the following: button text, model type, Href, field display policy, configuration template, display format (list or form), and fixed and configurable filters (if required).
In Counters, click the Plus icon (+), then configure the following: a title for the counter, choose an icon to use, the model type, field display policy, configuration template, and fixed and configurable filters (if required).
In Sections, click the Plus icon (+), then configure the landing page sections: provide a title, an image URL, and configure links on the landing page:
To configure the links, click the Plus icon (+) for each link you want to add to the landing page, and configure the links:
Select an icon for the link, and specify the link text.
If you want the link to display only in some circumstances, you can use a macro in the Condition field to define criteria that will show or hide the link. The default is True, which means that if no condition is provided, the link displays, else, use a macro to define when to show or hide the link.
Select a model type, which will show related field display policies and configuration templates that can be applied.
In the Href field, define a link to to be used for external or internal links.
Note
Hrefs are generally recommended for external links. For backwards compatibility, hrefs can be used for links within the application to link directly to a form. For example, the Add Phone page would have the following href: api/relation/SubscriberPhone/add
In this case, you'll need to use JSON-format landing page import, or bulk load, to add any associated field display policies (FDPs) and configuration templates for the menu item. The recommendation is not to use Hrefs to reference view/ type models.
Select a Field Display Policy and Configuration Template.
From the Custom Component drop-down, select the VOSS portal custom component. See: Custom Components for Menu Layouts and Landing Pages
Display As. The link type is displayed as the chosen Display As item:
Form: Displays an input form (for an Href resource value other than view/ models, a resource ends with /add/).
Inline List: The link points to the first five list of items.
List: List view of a resource referenced by Type or Href. If List is chosen as the Display As type, then the resulting list can also be filtered. See Configurable Filters in Menus and Landing Pages.
Tree: A tree view of resource to display (if the system Href provides a tree path).
If you wish to re-arrange the order of items, click the hamburger icon in the first column and drag items to re-order.
On the Welcome Header tab:
Save the landing page.
Assign the landing page to the relevant roles.
Edit a Landing Page
To edit an existing landing page, click on the landing page to open its editing screen. Update settings, and save your changes.
Related Topics
Landing Pages in the Core Feature Guide
Landing Pages Field Reference in the Core Feature Guide
Configurable Filters in Menus and Landing Pages in the Core Feature Guide
Custom Icon Names Reference in the Core Feature Guide
Custom Components for Menu Layouts and Landing Pages in the Core Feature Guide
Landing page displayed to end user
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name * | The name that is given to the Landing Page |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | A description of the Landing Page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Welcome Header | Text for the welcome section. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Header Text | A single line static welcome test displayed on top of the landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Line Text | Text for the welcome line displayed under the header. Use [userrole] as a placeholder to insert the current user's role. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Counters | The list of counters for the Landing Page dashboard |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title * | The title to be displayed for this counter. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Icon | The icon to be used for this counter. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Type | The selected model type from the Type drop-down list to associate with the Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Display Policy | The selected Field Display Policy that is associated with the counter. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this counter if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Configuration Template | The selected Configuration Template that is associated with the counter. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Hidden Filters | Filters that can't be removed by end user. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Visible Filters | Filters suggested to end users and my be cleared. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Sections | The list of section items that belong to the Landing Page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title * | The section title as it will show on the Landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Image URL | Optional URL to image to be displayed as section image. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this section if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Links | List of links that belong to section. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Icon | The icon to be used for this link. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Link Text | Text for the link |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | A description of the Link. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this link if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display As | Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Type | The selected model type from the Type drop-down list to associate with the Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Href | If a direct reference to a model type is used for the menu item, the specified path. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Display Policy | The selected Field Display Policy that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Configuration Template | The selected Configuration Template that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Set as default Model Type | Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Fixed Filters | Filters that can't be removed by end user. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Configurable Filters | Filters suggested to end users and my be cleared. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Widgets |
|