When upgrading to Automate release 24.1, existing landing pages on VOSS Automate are converted to dashboards. These dashboards allow for the same functionality as landing pages, but additional features such as widgets, are available on dashboards that allow for an enriched landing page interface.

For default landing pages included in the system, the conversion process retains a part of the landing page name, but adds or replaces any indication (for example: LP) in the name with a dashboard equivalent (such as DB). For custom landing pages found in a system, the original names are retained following conversion to dashboards.

As a part of the landing page to dashboard conversion during upgrade, a number of related elements are also migrated:

Landing pages define the look and feel and layout of elements that display in the main part of the system screens.

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

Default landing pages ship with the system and are 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. The links can be used as short-cuts by the administrators, based on their role.

Fixed and Configurable Filters in Menus and Landing Pages in the Core Feature Guide

You can make a clone (copy) of a landing page and then create a new landing page based on pre-populated settings. Alternatively, you can export a landing page, edit it externally, and then re-import it. 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:

Landing pages are configured via (default menus) Role Management > Landing Pages.

The list view accessible via this path displays the landing pages available in your system, and includes the landing page name, a description, and the hierarchy.

You can click on a landing page in the list view to edit it. Landing pages have the following configuration options - you can either select a tab or, if you're using the panel layout, fields display in the following main sections:

Details Tab

On the Details tab (panel), you can configure basic options (name and description) and configure counters, sections, and widgets.

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.

Landing page counters, widgets, and 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 landing page 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: Filter By: summary fields of the Type Filter Type: matching operator Filter String: value
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: `{{ macro.is_cisco_cucm_enabled }}` only displays if Cisco CUCM enabled in global settings. `{{ macro.is_microsoft_enabled }}` only displays if Microsoft enabled in global settings. See the Advanced Configuration Guide for more information about using macros.

Sections

The table describes landing page 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.

Condition

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.
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: `{{ macro.is_cisco_cucm_enabled }}` only displays if Cisco CUCM enabled in global settings. `{{ macro.is_microsoft_enabled }}` only displays if Microsoft enabled in global settings. See the Advanced Configuration Guide for more information about using macros.

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:

{{ macro.is_cisco_cucm_enabled }} only displays if Cisco CUCM enabled in global settings.
{{ macro.is_microsoft_enabled }} only displays if Microsoft enabled in global settings.

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: Filter By Filter Type Filter String
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

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 List (default) For two or more instances. If you choose List, and you've selected a default FDP and CFT for the model type, users with a user role associated with the menu layout view the model type based on these options. It is also possible to filter the list view. If you choose List display referenced by Type or Href, note that a tool (`tool/[toolname]`) can also be presented as a list, for example: `/api/tool/Transaction/?entity=data/Event&operation=execute` Inline List The link points to the first five list of items. Landing Page You must choose a landing page when Display As value is Landing Page. Allows you to choose an existing landing page, which will display when this menu item is chosen. Form (for a single instance) When model type is `view`, the value for Display As must be Form. Displays an input form (for an Href resource value other than view/models, a resource ends with /add/). If you're using href and you choose the Form display, the href value points to a model instance with the pkid, for example `data/Countries/5331a739d0278d7893e26d2e`, or ends with `/add/`. The `view/` model types always open the Add form. External Link Href is mandatory when Display As is External Link. You'll need to specify a URL to open a new browser tab, and disable pop-up blocking on the users browsers to allow the external link to resolve. Tree (if available, for two or more instances) Choosing a Tree display shows a tree view of the resource. When using href with Tree display, the href provides the tree path.

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

List (default)

For two or more instances. If you choose List, and you've selected a default FDP and CFT for the model type, users with a user role associated with the menu layout view the model type based on these options. It is also possible to filter the list view.

If you choose List display referenced by Type or Href, note that a tool (tool/[toolname]) can also be presented as a list, for example: /api/tool/Transaction/?entity=data/Event&operation=execute
Inline List

The link points to the first five list of items.
Landing Page

You must choose a landing page when Display As value is Landing Page. Allows you to choose an existing landing page, which will display when this menu item is chosen.
Form (for a single instance)

When model type is view, the value for Display As must be Form.

Displays an input form (for an Href resource value other than view/models, a resource ends with /add/). If you're using href and you choose the Form display, the href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with /add/. The view/ model types always open the Add form.
External Link

Href is mandatory when Display As is External Link. You'll need to specify a URL to open a new browser tab, and disable pop-up blocking on the users browsers to allow the external link to resolve.
Tree (if available, for two or more instances)

Choosing a Tree display shows a tree view of the resource. When using href with Tree display, the href provides the tree path.

Welcome Header Tab

This tab configures the landing page header text and line text.

Header Text	A single line static welcome message displayed at the 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, to serve as the header. For example: `/www/img/landingPageIcons/User.png`

Landing Page Examples

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 counter, 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 image shows an example of the default "Dashboard Subscribers" landing page, for example associated with a Subscribers menu item:

Landing Pages for a Business Admin Role

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.

Example landing pages - Business Admin Role

Example - Call Groups setup and display

Example - display of Number Management landing page

Landing page names grouped by sample menu layout names

The following lists are the landing page names grouped by the provided sample menu layout names.

Field Display Policies

Field display policies with customer_admin in their names are also provided and used for some of the Quick Action section links in the landing pages
Field display policies with BusinessAdmin in their names are also provided and used for some of the links in the landing pages

Landing Pages: MenuSiteAdmin

Dashboard Number Management
Dashboard MV Subscribers
Dashboard Phones
Dashboard Headsets
Dashboard Voicemail
Dashboard Collaboration
Dashboard Conferencing
Dashboard Contact Center
Dashboard Call Groups
Dashboard MS Exchange
Dashboard Tools

Landing Pages: MenuCustomerAdmin

Dashboard Site Management
Dashboard Number Management
Dashboard MV Subscribers
Dashboard Phones
Dashboard Headsets
Dashboard Voicemail
Dashboard Collaboration
Dashboard Conferencing
Dashboard Contact Center
Dashboard Call Groups
Dashboard MS Exchange
Dashboard Tools

Landing Pages

To edit an existing landing page, click on the landing page to open its editing screen. Update settings, and save your changes.

This topic describes the fields and configuration options on the Landing Pages screen in the VOSS Automate Admin Portal.

Details Tab

The Details tab defines the following options for the landing page:

Name: The name of the landing page.
Meta Tasks
Counters
Sections

Meta Tasks

These rows display the shortcut buttons (one or more) at the top of the home page screen (directly below the line text, if configured). Click in the row to edit an existing shortcut button, or click the Plus icon (+) to add a new shortcut button.

The table describes the fields on the Meta Tasks editing screen:

Title	Field Name	Description
Button Text	button_text	Text for the button.
Type	type	The model type to associate with the Title. Blank when href field is populated.
Href	href	API URL. Direct reference to a model type (the path), if applicable. If used, the Type field is empty. Example API URL for a lit of items of type relation/SubscriberPhone: /api/relation/SubscriberPhone/
Field Display Policy	field_display_policy	The field display policy associated with the menu item.
Configuration Template	configuration_template	The configuration template associated with the menu item.
Display As	display	The display format of the model types of the menu item. The default is list. Form: (for a single instance) The link opens a form. Tree: (for two or more instances) List (for two or more instances)

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.

The table describes the fields on the Counters editing screen:

Title	Field Name	Description
Title	display	Mandatory. The title to be displayed for this counter. For example, Phones, Users.
Icon	display	The icon to be used for this counter.
Type	type	The model type to count and associate with the counter.
Field Display Policy	field_display_policy	The field display policy associated with the counter.
Configuration Template	configuration_template	The configuration template associated with the counter.

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.

The table describes the general fields on the Sections editing screen:

Title	Field Name	Description
Title *	title	Mandatory. The section title as it will show on the Landing page.
Image URL	image	Optional URL to the 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
Links	links	List of links (one or more) in the section.

Title

Field Name

Description

Title *

title

Mandatory. The section title as it will show on the Landing page.

Image URL

image

Optional URL to the 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

Links

links

List of links (one or more) in the section.

The table describes the fields on the Links editing screen:

Title	Field Name	Description
Icon		Choose an icon for the link.
Link Text	link_text	Mandatory. Text for the link.
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.
Type	type	The model type to associate with the Title.
Href	href	If a direct reference to a model type is used for the menu item, the specified path.
Field Display Policy	field_display_policy	The field display policy associated with the menu item.
Configuration Template	configuration_template	The selected Configuration Template that is associated with the Menu Item.
Display As	display	The display format of the model types of the menu item. The default is list. Default = list. * Form (for a single instance) * Tree (for multiple instances) * List (for multiple instances)
Display Multiple Columns	is_multicolumn	Determines if link is shown as multiple columns or not.

Welcome Header Tab

The table describes the fields on the Welcome Header tab:

Title	Field Name	Description
Header Text	header	A single line static welcome test displayed on top of the landing page.
Line Text	line	Text for the welcome line displayed under the header. Use [userrole] as a placeholder to insert the current user's role.

Related Topics

Advanced Configuration Guide

Macros in VOSS Automate in the Core Feature Guide

Landing Pages 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

Model Details: data/LandingPage

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.

Title							Description	Details
Name *							The name that is given to the Landing Page	Field Name: name Type: String
Description							A description of the Landing Page.	Field Name: description Type: String
Welcome Header							Text for the welcome section.	Field Name: welcome Type: Object
	Header Text						A single line static welcome test displayed on top of the landing page.	Field Name: welcome.header Type: String
	Line Text						Text for the welcome line displayed under the header. Use [userrole] as a placeholder to insert the current user's role.	Field Name: welcome.line Type: String
	Counters						The list of counters for the Landing Page dashboard	Field Name: counters.[n] Type: Array
		Title *					The title to be displayed for this counter.	Field Name: counters.[n].title Type: String
		Icon					The icon to be used for this counter.	Field Name: counters.[n].icon Type: String Target: data/Icons Target attr: icon_value Format: uri
		Type					The selected model type from the Type drop-down list to associate with the Title.	Field Name: counters.[n].type Type: String Format: uri
		Field Display Policy					The selected Field Display Policy that is associated with the counter.	Field Name: counters.[n].field_display_policy Type: String Target: data/FieldDisplayPolicy Target attr: name Format: uri
		Condition					Only show this counter if this condition evaluates to true.	Field Name: counters.[n].condition Type: String
		Configuration Template					The selected Configuration Template that is associated with the counter.	Field Name: counters.[n].configuration_template Type: String Target: data/ConfigurationTemplate Target attr: name Format: uri
			Hidden Filters				Filters that can't be removed by end user.	Field Name: filter_options.[n] Type: Array
				Filter By				Field Name: counters.[n].filter_options.[n].filter_by Type: String
				Filter Type				Field Name: counters.[n].filter_options.[n].filter_type Type: String Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
				Filter String				Field Name: counters.[n].filter_options.[n].filter_string Type: String
				Ignore Case				Field Name: counters.[n].filter_options.[n].ignore_case Type: Boolean
			Visible Filters				Filters suggested to end users and my be cleared.	Field Name: configurable_options.[n] Type: Array
				Filter By				Field Name: counters.[n].configurable_options.[n].filter_by Type: String
				Filter Type				Field Name: counters.[n].configurable_options.[n].filter_type Type: String Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
				Filter String				Field Name: counters.[n].configurable_options.[n].filter_string Type: String
				Ignore Case				Field Name: counters.[n].configurable_options.[n].ignore_case Type: Boolean
	Sections						The list of section items that belong to the Landing Page.	Field Name: sections.[n] Type: Array
		Title *					The section title as it will show on the Landing page.	Field Name: sections.[n].title Type: String
		Image URL					Optional URL to image to be displayed as section image.	Field Name: sections.[n].image Type: String Choices: ["Accounting", "Arrows", "Charting", "Configuration", "Deployment", "Detail", "Feedback", "Global", "Like", "Migration", "Network2", "Network", "News", "Options", "Permissions", "Reconciliation", "Reports", "Roles", "Search", "Security", "Settings", "Terminals", "User"]
		Condition					Only show this section if this condition evaluates to true.	Field Name: sections.[n].condition Type: String
			Links				List of links that belong to section.	Field Name: links.[n] Type: Array
				Icon			The icon to be used for this link.	Field Name: sections.[n].links.[n].icon Type: String Target: data/Icons Target attr: icon_value Format: uri
				Link Text			Text for the link	Field Name: sections.[n].links.[n].link_text Type: String
				Description			A description of the Link.	Field Name: sections.[n].links.[n].description Type: String
				Condition			Only show this link if this condition evaluates to true.	Field Name: sections.[n].links.[n].condition Type: String
				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	Field Name: sections.[n].links.[n].display Type: String Default: list Choices: ["Form", "Inline List", "List", "External Link"]
				Type			The selected model type from the Type drop-down list to associate with the Title.	Field Name: sections.[n].links.[n].type Type: String Format: uri
				Href			If a direct reference to a model type is used for the menu item, the specified path.	Field Name: sections.[n].links.[n].href Type: String
				Field Display Policy			The selected Field Display Policy that is associated with the Menu Item.	Field Name: sections.[n].links.[n].field_display_policy Type: String Target: data/FieldDisplayPolicy Target attr: name Format: uri
				Configuration Template			The selected Configuration Template that is associated with the Menu Item.	Field Name: sections.[n].links.[n].configuration_template Type: String Target: data/ConfigurationTemplate Target attr: name Format: uri
				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.	Field Name: sections.[n].links.[n].default_model_type Type: Boolean
					Fixed Filters		Filters that can't be removed by end user. Applicable to display as = 'list'	Field Name: filter_options.[n] Type: Array
						Filter By		Field Name: sections.[n].links.[n].filter_options.[n].filter_by Type: String
						Filter Type		Field Name: sections.[n].links.[n].filter_options.[n].filter_type Type: String Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
						Filter String		Field Name: sections.[n].links.[n].filter_options.[n].filter_string Type: String
						Ignore Case		Field Name: sections.[n].links.[n].filter_options.[n].ignore_case Type: Boolean
					Configurable Filters		Filters suggested to end users and my be cleared. Applicable to display as = 'list'	Field Name: configurable_options.[n] Type: Array
						Filter By		Field Name: sections.[n].links.[n].configurable_options.[n].filter_by Type: String
						Filter Type		Field Name: sections.[n].links.[n].configurable_options.[n].filter_type Type: String Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
						Filter String		Field Name: sections.[n].links.[n].configurable_options.[n].filter_string Type: String
						Ignore Case		Field Name: sections.[n].links.[n].configurable_options.[n].ignore_case Type: Boolean
	Widgets							Field Name: widgets.[n] Type: Array

Model: data/LandingPage

Landing Pages

Details Tab

Welcome Header Tab

Example landing pages - Business Admin Role

Landing page names grouped by sample menu layout names

Landing Pages

Details Tab

Welcome Header Tab

Model Details: data/LandingPage