Landing Pages Field Reference

This topic describes the fields and configuration options on the Landing Pages screen in the VOSS-4-UC 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.