Add and Edit Landing Pages¶

Add a Landing Page¶

This procedure adds a new landing page.

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:
- In Header Text, provide a single line static welcome message for the top of the landing page.
- In Line Text, provide required line text for the welcome line displayed beneath 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.
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.

Landing Pages Field Reference¶

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

Note

To access this screen (default menus) go to Role Management > Landing Pages; then, click on an existing landing page to open the Landing Pages editing screen, or click the Plus icon (+) to add a new landing page (which also opens the Landing Pages editing screen).

You can select the following tabs on this screen:

Details tab
Welcome Header tab

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.

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.

VOSS Automate 21.2