[Index]

Model: data/LandingPage

Landing Pages

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

A landing page is the page you see when you log in, or when clicking the Home button from anywhere in the system, or when choosing a menu item that has been defined as a landing page.

A default landing page ships with the system, and is associated with pre-defined roles in the hierarchy, for example Provider, Customer, and Site administrators.

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 legacy Admin GUI.

Customized Landing Pages

Landing pages may be customized for different user roles, and have several configuration options:

Editable landing pages provide a way to set up direct links to areas in the system, which can be used as short-cuts by the administrators in line with their role.

Existing images can be used or new images can be added in line with branded look and feel.

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

The CSS of the Theme can be used to control the layout of the landing page.

Related Topics

Menu Layouts in the Core Feature Guide

Advanced Configuration Guide

Macros in VOSS Automate in the Core Feature Guide

Fixed and 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

Add or Edit a Landing Page

This procedure adds a new landing page or edits an existing landing page.

  1. Log in to the Admin Portal as a Provider administrator, or higher.

  2. Choose the hierarchy level for the landing page, for example, Customer.

  3. Go to (default menu) Role Management > Landing Pages.

  4. Choose an option:

    • 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. Now modify the settings of the cloned landing page and save it as a new landing page.
    • To edit an existing landing page, click on the landing page in the list view to open its editing screen, update its settings, and save your changes.

  5. On the Details tab, configure the following options for the landing page:

    Note

    • For configuration details, see Landing Pages Field Reference
    • Rows with nested items or links contain a chevron (>) instead of a Plus icon (+) so that you can see which items have child lists.
    • An asterisk indicates required values.
    • Add a name
    • Configure meta tasks (button text, model type, Href, FDP, CFT, display format, filters)
    • Configure counters (filters, icon, title, model type, FDP, CFT).
    • Configure sections, and links in sections.

  6. On the Welcome Header, configure the following options:

    Note

    For configuration details, see Landing Pages Field Reference

    • Header text
    • Line text

  7. Save the landing page.

  8. Assign the landing page to the relevant roles.

Landing Pages Field Reference

This section describes landing page configuration options:

Note

You can view, add, and edit landing pages in the Admin Portal via (default menus) Role Management > Landing Pages. See Create a Landing Page

You can select the following tabs on the Landing Pages add/edit screen:

Details Tab

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

Column Description
Name The name of the landing page.
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.
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.
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.
Links Configures links in sections on landing pages.

Common functionality

The table describes edit functionality typically available for landing page elements:

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

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, (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.
Configuration Template The configuration template associated with the landing page element.

Meta Tasks

The table describes Meta Tasks configuration options:

Column Description
Button Text Text for the button.

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.

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

Optional 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). 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 cannot be removed. The following options are available for configurable filters for links:

  • Columns (Displays only when Display As option is Inline List, and the value for Display Multiple Columns is set to Yes)
  • 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.
Display Multiple Columns Available only when Display As option is Inline List. Defines whether the link displays as multiple columns. When set to Yes (select the checkbox in the field), you can set column values in the filters for this link. When set to No, the filters do not have an option to specify columns.
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.
Href If a direct reference to a model type is used for the menu item, the specified path.
Column Description
Custom Component

Click in the cell to choose an Admin Portal custom components. Options in the drop-down depend on the model you choose in the Type field. For example, when choosing model type view/AddPhone, the custom component available for selection is Add Phone. The custom components allow you to display GUI content (such as landing pages, lists, and forms) in the same layout as they appear in the Business Admin Portal.

Custom components are also available for multi vendor environments and for Microsoft-only environments. This feature is only available in the new VOSS Automate Admin Portal.
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. When choosing this option, you can choose Yes or No for option Display as Multiple Columns. When set to Yes, you can define columns in the filters for this link.

  • Landing Page

    Allows you to choose an existing landing page, which will display when this menu item is chosen.

    This option is only available in the VOSS Admin Portal GUI.

  • Form (for a single instance)

    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; thus, if used, the value should not have the /add/ endpoint, for example, as in this JSON:

{
  "type": "view/QuickSubscriber",
  "display": "form",
  "title": "Quick Add Subscriber"
}

  • External Link

    Recommended for use with href, where a URL specified as the href value opens as a new browser tab. You'll need to 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.

Related Topics

Welcome Header Tab

The table describes the fields on the Welcome Header tab for landing page configuration:

Field Description
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 displayed to end user

Model Details: data/LandingPage

Title Description Details
Name * The name that is given to the Landing Page
  • Field Name: name
  • 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
Meta Tasks Definitions for the meta task shortcut buttons
  • Field Name: meta_tasks.[n]
  • Type: Array
Button Text Text for the button
  • Field Name: meta_tasks.[n].button_text
  • Type: String
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: meta_tasks.[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: meta_tasks.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: meta_tasks.[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: meta_tasks.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
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: meta_tasks.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "Inline List", "List", "Wizard"]
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: meta_tasks.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: meta_tasks.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: meta_tasks.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: meta_tasks.[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: meta_tasks.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: meta_tasks.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: meta_tasks.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: meta_tasks.[n].configurable_options.[n].ignore_case
  • Type: Boolean
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
  • Choices: ["3D Rotation", "Ac Unit", "Access Alarm", "Access Alarms", "Access Time", "Accessibility", "Accessible", "Account Balance", "Account Balance Wallet", "Account Box", "Account Circle", "Add", "Add A Photo", "Add Alarm", "Add Alert", "Add Box", "Add Circle", "Add Circle Outline", "Add Location", "Add Shopping Cart", "Add To Photos", "Add To Queue", "Adjust", "Airline Seat Flat", "Airline Seat Flat Angled", "Airline Seat Individual Suite", "Airline Seat Legroom Extra", "Airline Seat Legroom Normal", "Airline Seat Legroom Reduced", "Airline Seat Recline Extra", "Airline Seat Recline Normal", "Airplanemode Active", "Airplanemode Inactive", "Airplay", "Airport Shuttle", "Alarm", "Alarm Add", "Alarm Off", "Alarm On", "Album", "All Inclusive", "All Out", "Android", "Announcement", "Apps", "Archive", "Arrow Back", "Arrow Downward", "Arrow Drop Down", "Arrow Drop Down Circle", "Arrow Drop Up", "Arrow Forward", "Arrow Upward", "Art Track", "Aspect Ratio", "Assessment", "Assignment", "Assignment Ind", "Assignment Late", "Assignment Return", "Assignment Returned", "Assignment Turned In", "Assistant", "Assistant Photo", "Attach File", "Attach Money", "Attachment", "Audiotrack", "Autorenew", "Av Timer", "Backspace", "Backup", "Battery Alert", "Battery Charging Full", "Battery Full", "Battery Std", "Battery Unknown", "Beach Access", "Beenhere", "Block", "Bluetooth", "Bluetooth Audio", "Bluetooth Connected", "Bluetooth Disabled", "Bluetooth Searching", "Blur Circular", "Blur Linear", "Blur Off", "Blur On", "Book", "Bookmark", "Bookmark Border", "Border All", "Border Bottom", "Border Clear", "Border Color", "Border Horizontal", "Border Inner", "Border Left", "Border Outer", "Border Right", "Border Style", "Border Top", "Border Vertical", "Branding Watermark", "Brightness 1", "Brightness 2", "Brightness 3", "Brightness 4", "Brightness 5", "Brightness 6", "Brightness 7", "Brightness Auto", "Brightness High", "Brightness Low", "Brightness Medium", "Broken Image", "Brush", "Bubble Chart", "Bug Report", "Build", "Burst Mode", "Business", "Business Center", "Cached", "Cake", "Call", "Call End", "Call Made", "Call Merge", "Call Missed", "Call Missed Outgoing", "Call Received", "Call Split", "Call To Action", "Camera", "Camera Alt", "Camera Enhance", "Camera Front", "Camera Rear", "Camera Roll", "Cancel", "Card Giftcard", "Card Membership", "Card Travel", "Casino", "Cast", "Cast Connected", "Center Focus Strong", "Center Focus Weak", "Change History", "Chat", "Chat Bubble", "Chat Bubble Outline", "Check", "Check Box", "Check Box Outline Blank", "Check Circle", "Chevron Left", "Chevron Right", "Child Care", "Child Friendly", "Chrome Reader Mode", "Class", "Clear", "Clear All", "Close", "Closed Caption", "Cloud", "Cloud Circle", "Cloud Done", "Cloud Download", "Cloud Off", "Cloud Queue", "Cloud Upload", "Code", "Collections", "Collections Bookmark", "Color Lens", "Colorize", "Comment", "Compare", "Compare Arrows", "Computer", "Confirmation Number", "Contact Mail", "Contact Phone", "Contacts", "Content Copy", "Content Cut", "Content Paste", "Control Point", "Control Point Duplicate", "Copyright", "Create", "Create New Folder", "Credit Card", "Crop", "Crop 16 9", "Crop 3 2", "Crop 5 4", "Crop 7 5", "Crop Din", "Crop Free", "Crop Landscape", "Crop Original", "Crop Portrait", "Crop Rotate", "Crop Square", "Dashboard", "Data Usage", "Date Range", "Dehaze", "Delete", "Delete Forever", "Delete Sweep", "Description", "Desktop Mac", "Desktop Windows", "Details", "Developer Board", "Developer Mode", "Device Hub", "Devices", "Devices Other", "Dialer Sip", "Dialpad", "Directions", "Directions Bike", "Directions Boat", "Directions Bus", "Directions Car", "Directions Railway", "Directions Run", "Directions Subway", "Directions Transit", "Directions Walk", "Disc Full", "Dns", "Do Not Disturb", "Do Not Disturb Alt", "Do Not Disturb Off", "Do Not Disturb On", "Dock", "Domain", "Done", "Done All", "Donut Large", "Donut Small", "Drafts", "Drag Handle", "Drive Eta", "Dvr", "Edit", "Edit Location", "Eject", "Email", "Enhanced Encryption", "Equalizer", "Error", "Error Outline", "Euro Symbol", "Ev Station", "Event", "Event Available", "Event Busy", "Event Note", "Event Seat", "Exit To App", "Expand Less", "Expand More", "Explicit", "Explore", "Exposure", "Exposure Neg 1", "Exposure Neg 2", "Exposure Plus 1", "Exposure Plus 2", "Exposure Zero", "Extension", "Face", "Fast Forward", "Fast Rewind", "Favorite", "Favorite Border", "Featured Play List", "Featured Video", "Feedback", "Fiber Dvr", "Fiber Manual Record", "Fiber New", "Fiber Pin", "Fiber Smart Record", "File Download", "File Upload", "Filter", "Filter 1", "Filter 2", "Filter 3", "Filter 4", "Filter 5", "Filter 6", "Filter 7", "Filter 8", "Filter 9", "Filter 9 Plus", "Filter B And W", "Filter Center Focus", "Filter Drama", "Filter Frames", "Filter Hdr", "Filter List", "Filter None", "Filter Tilt Shift", "Filter Vintage", "Find In Page", "Find Replace", "Fingerprint", "First Page", "Fitness Center", "Flag", "Flare", "Flash Auto", "Flash Off", "Flash On", "Flight", "Flight Land", "Flight Takeoff", "Flip", "Flip To Back", "Flip To Front", "Folder", "Folder Open", "Folder Shared", "Folder Special", "Font Download", "Format Align Center", "Format Align Justify", "Format Align Left", "Format Align Right", "Format Bold", "Format Clear", "Format Color Fill", "Format Color Reset", "Format Color Text", "Format Indent Decrease", "Format Indent Increase", "Format Italic", "Format Line Spacing", "Format List Bulleted", "Format List Numbered", "Format Paint", "Format Quote", "Format Shapes", "Format Size", "Format Strikethrough", "Format Textdirection L To R", "Format Textdirection R To L", "Format Underlined", "Forum", "Forward", "Forward 10", "Forward 30", "Forward 5", "Free Breakfast", "Fullscreen", "Fullscreen Exit", "Functions", "G Translate", "Gamepad", "Games", "Gavel", "Gesture", "Get App", "Gif", "Golf Course", "Gps Fixed", "Gps Not Fixed", "Gps Off", "Grade", "Gradient", "Grain", "Graphic Eq", "Grid Off", "Grid On", "Group", "Group Add", "Group Work", "Hd", "Hdr Off", "Hdr On", "Hdr Strong", "Hdr Weak", "Headset", "Headset Mic", "Healing", "Hearing", "Help", "Help Outline", "High Quality", "Highlight", "Highlight Off", "History", "Home", "Hot Tub", "Hotel", "Hourglass Empty", "Hourglass Full", "Http", "Https", "Image", "Image Aspect Ratio", "Import Contacts", "Import Export", "Important Devices", "Inbox", "Indeterminate Check Box", "Info", "Info Outline", "Input", "Insert Chart", "Insert Comment", "Insert Drive File", "Insert Emoticon", "Insert Invitation", "Insert Link", "Insert Photo", "Invert Colors", "Invert Colors Off", "Iso", "Keyboard", "Keyboard Arrow Down", "Keyboard Arrow Left", "Keyboard Arrow Right", "Keyboard Arrow Up", "Keyboard Backspace", "Keyboard Capslock", "Keyboard Hide", "Keyboard Return", "Keyboard Tab", "Keyboard Voice", "Kitchen", "Label", "Label Outline", "Landscape", "Language", "Laptop", "Laptop Chromebook", "Laptop Mac", "Laptop Windows", "Last Page", "Launch", "Layers", "Layers Clear", "Leak Add", "Leak Remove", "Lens", "Library Add", "Library Books", "Library Music", "Lightbulb Outline", "Line Style", "Line Weight", "Linear Scale", "Link", "Linked Camera", "List", "Live Help", "Live Tv", "Local Activity", "Local Airport", "Local Atm", "Local Bar", "Local Cafe", "Local Car Wash", "Local Convenience Store", "Local Dining", "Local Drink", "Local Florist", "Local Gas Station", "Local Grocery Store", "Local Hospital", "Local Hotel", "Local Laundry Service", "Local Library", "Local Mall", "Local Movies", "Local Offer", "Local Parking", "Local Pharmacy", "Local Phone", "Local Pizza", "Local Play", "Local Post Office", "Local Printshop", "Local See", "Local Shipping", "Local Taxi", "Location City", "Location Disabled", "Location Off", "Location On", "Location Searching", "Lock", "Lock Open", "Lock Outline", "Looks", "Looks 3", "Looks 4", "Looks 5", "Looks 6", "Looks One", "Looks Two", "Loop", "Loupe", "Low Priority", "Loyalty", "Mail", "Mail Outline", "Map", "Markunread", "Markunread Mailbox", "Memory", "Menu", "Merge Type", "Message", "Mic", "Mic None", "Mic Off", "Mms", "Mode Comment", "Mode Edit", "Monetization On", "Money Off", "Monochrome Photos", "Mood", "Mood Bad", "More", "More Horiz", "More Vert", "Motorcycle", "Mouse", "Move To Inbox", "Movie", "Movie Creation", "Movie Filter", "Multiline Chart", "Music Note", "Music Video", "My Location", "Nature", "Nature People", "Navigate Before", "Navigate Next", "Navigation", "Near Me", "Network Cell", "Network Check", "Network Locked", "Network Wifi", "New Releases", "Next Week", "Nfc", "No Encryption", "No Sim", "Not Interested", "Note", "Note Add", "Notifications", "Notifications Active", "Notifications None", "Notifications Off", "Notifications Paused", "Offline Pin", "Ondemand Video", "Opacity", "Open In Browser", "Open In New", "Open With", "Pages", "Pageview", "Palette", "Pan Tool", "Panorama", "Panorama Fish Eye", "Panorama Horizontal", "Panorama Vertical", "Panorama Wide Angle", "Party Mode", "Pause", "Pause Circle Filled", "Pause Circle Outline", "Payment", "People", "People Outline", "Perm Camera Mic", "Perm Contact Calendar", "Perm Data Setting", "Perm Device Information", "Perm Identity", "Perm Media", "Perm Phone Msg", "Perm Scan Wifi", "Person", "Person Add", "Person Outline", "Person Pin", "Person Pin Circle", "Personal Video", "Pets", "Phone", "Phone Android", "Phone Bluetooth Speaker", "Phone Forwarded", "Phone In Talk", "Phone Iphone", "Phone Locked", "Phone Missed", "Phone Paused", "Phonelink", "Phonelink Erase", "Phonelink Lock", "Phonelink Off", "Phonelink Ring", "Phonelink Setup", "Photo", "Photo Album", "Photo Camera", "Photo Filter", "Photo Library", "Photo Size Select Actual", "Photo Size Select Large", "Photo Size Select Small", "Picture As Pdf", "Picture In Picture", "Picture In Picture Alt", "Pie Chart", "Pie Chart Outlined", "Pin Drop", "Place", "Play Arrow", "Play Circle Filled", "Play Circle Outline", "Play For Work", "Playlist Add", "Playlist Add Check", "Playlist Play", "Plus One", "Poll", "Polymer", "Pool", "Portable Wifi Off", "Portrait", "Power", "Power Input", "Power Settings New", "Pregnant Woman", "Present To All", "Print", "Priority High", "Public", "Publish", "Query Builder", "Question Answer", "Queue", "Queue Music", "Queue Play Next", "Radio", "Radio Button Checked", "Radio Button Unchecked", "Rate Review", "Receipt", "Recent Actors", "Record Voice Over", "Redeem", "Redo", "Refresh", "Remove", "Remove Circle", "Remove Circle Outline", "Remove From Queue", "Remove Red Eye", "Remove Shopping Cart", "Reorder", "Repeat", "Repeat One", "Replay", "Replay 10", "Replay 30", "Replay 5", "Reply", "Reply All", "Report", "Report Problem", "Restaurant", "Restaurant Menu", "Restore", "Restore Page", "Ring Volume", "Room", "Room Service", "Rotate 90 Degrees Ccw", "Rotate Left", "Rotate Right", "Rounded Corner", "Router", "Rowing", "Rss Feed", "Rv Hookup", "Satellite", "Save", "Scanner", "Schedule", "School", "Screen Lock Landscape", "Screen Lock Portrait", "Screen Lock Rotation", "Screen Rotation", "Screen Share", "Sd Card", "Sd Storage", "Search", "Security", "Select All", "Send", "Sentiment Dissatisfied", "Sentiment Neutral", "Sentiment Satisfied", "Sentiment Very Dissatisfied", "Sentiment Very Satisfied", "Settings", "Settings Applications", "Settings Backup Restore", "Settings Bluetooth", "Settings Brightness", "Settings Cell", "Settings Ethernet", "Settings Input Antenna", "Settings Input Component", "Settings Input Composite", "Settings Input Hdmi", "Settings Input Svideo", "Settings Overscan", "Settings Phone", "Settings Power", "Settings Remote", "Settings System Daydream", "Settings Voice", "Share", "Shop", "Shop Two", "Shopping Basket", "Shopping Cart", "Short Text", "Show Chart", "Shuffle", "Signal Cellular 4 Bar", "Signal Cellular Connected No Internet 4 Bar", "Signal Cellular No Sim", "Signal Cellular Null", "Signal Cellular Off", "Signal Wifi 4 Bar", "Signal Wifi 4 Bar Lock", "Signal Wifi Off", "Sim Card", "Sim Card Alert", "Skip Next", "Skip Previous", "Slideshow", "Slow Motion Video", "Smartphone", "Smoke Free", "Smoking Rooms", "Sms", "Sms Failed", "Snooze", "Sort", "Sort By Alpha", "Spa", "Space Bar", "Speaker", "Speaker Group", "Speaker Notes", "Speaker Notes Off", "Speaker Phone", "Spellcheck", "Star", "Star Border", "Star Half", "Stars", "Stay Current Landscape", "Stay Current Portrait", "Stay Primary Landscape", "Stay Primary Portrait", "Stop", "Stop Screen Share", "Storage", "Store", "Store Mall Directory", "Straighten", "Streetview", "Strikethrough S", "Style", "Subdirectory Arrow Left", "Subdirectory Arrow Right", "Subject", "Subscriptions", "Subtitles", "Subway", "Supervisor Account", "Surround Sound", "Swap Calls", "Swap Horiz", "Swap Vert", "Swap Vertical Circle", "Switch Camera", "Switch Video", "Sync", "Sync Disabled", "Sync Problem", "System Update", "System Update Alt", "Tab", "Tab Unselected", "Tablet", "Tablet Android", "Tablet Mac", "Tag Faces", "Tap And Play", "Terrain", "Text Fields", "Text Format", "Textsms", "Texture", "Theaters", "Thumb Down", "Thumb Up", "Thumbs Up Down", "Time To Leave", "Timelapse", "Timeline", "Timer", "Timer 10", "Timer 3", "Timer Off", "Title", "Toc", "Today", "Toll", "Tonality", "Touch App", "Toys", "Track Changes", "Traffic", "Train", "Tram", "Transfer Within A Station", "Transform", "Translate", "Trending Down", "Trending Flat", "Trending Up", "Tune", "Turned In", "Turned In Not", "Tv", "Unarchive", "Undo", "Unfold Less", "Unfold More", "Update", "Usb", "Verified User", "Vertical Align Bottom", "Vertical Align Center", "Vertical Align Top", "Vibration", "Video Call", "Video Label", "Video Library", "Videocam", "Videocam Off", "Videogame Asset", "View Agenda", "View Array", "View Carousel", "View Column", "View Comfy", "View Compact", "View Day", "View Headline", "View List", "View Module", "View Quilt", "View Stream", "View Week", "Vignette", "Visibility", "Visibility Off", "Voice Chat", "Voicemail", "Volume Down", "Volume Mute", "Volume Off", "Volume Up", "Vpn Key", "Vpn Lock", "Wallpaper", "Warning", "Watch", "Watch Later", "Wb Auto", "Wb Cloudy", "Wb Incandescent", "Wb Iridescent", "Wb Sunny", "Wc", "Web", "Web Asset", "Weekend", "Whatshot", "Widgets", "Wifi", "Wifi Lock", "Wifi Tethering", "Work", "Wrap Text", "Youtube Searched For", "Zoom In", "Zoom Out"]
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
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
Fixed 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
Configurable 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
  • Choices: ["3D Rotation", "Ac Unit", "Access Alarm", "Access Alarms", "Access Time", "Accessibility", "Accessible", "Account Balance", "Account Balance Wallet", "Account Box", "Account Circle", "Add", "Add A Photo", "Add Alarm", "Add Alert", "Add Box", "Add Circle", "Add Circle Outline", "Add Location", "Add Shopping Cart", "Add To Photos", "Add To Queue", "Adjust", "Airline Seat Flat", "Airline Seat Flat Angled", "Airline Seat Individual Suite", "Airline Seat Legroom Extra", "Airline Seat Legroom Normal", "Airline Seat Legroom Reduced", "Airline Seat Recline Extra", "Airline Seat Recline Normal", "Airplanemode Active", "Airplanemode Inactive", "Airplay", "Airport Shuttle", "Alarm", "Alarm Add", "Alarm Off", "Alarm On", "Album", "All Inclusive", "All Out", "Android", "Announcement", "Apps", "Archive", "Arrow Back", "Arrow Downward", "Arrow Drop Down", "Arrow Drop Down Circle", "Arrow Drop Up", "Arrow Forward", "Arrow Upward", "Art Track", "Aspect Ratio", "Assessment", "Assignment", "Assignment Ind", "Assignment Late", "Assignment Return", "Assignment Returned", "Assignment Turned In", "Assistant", "Assistant Photo", "Attach File", "Attach Money", "Attachment", "Audiotrack", "Autorenew", "Av Timer", "Backspace", "Backup", "Battery Alert", "Battery Charging Full", "Battery Full", "Battery Std", "Battery Unknown", "Beach Access", "Beenhere", "Block", "Bluetooth", "Bluetooth Audio", "Bluetooth Connected", "Bluetooth Disabled", "Bluetooth Searching", "Blur Circular", "Blur Linear", "Blur Off", "Blur On", "Book", "Bookmark", "Bookmark Border", "Border All", "Border Bottom", "Border Clear", "Border Color", "Border Horizontal", "Border Inner", "Border Left", "Border Outer", "Border Right", "Border Style", "Border Top", "Border Vertical", "Branding Watermark", "Brightness 1", "Brightness 2", "Brightness 3", "Brightness 4", "Brightness 5", "Brightness 6", "Brightness 7", "Brightness Auto", "Brightness High", "Brightness Low", "Brightness Medium", "Broken Image", "Brush", "Bubble Chart", "Bug Report", "Build", "Burst Mode", "Business", "Business Center", "Cached", "Cake", "Call", "Call End", "Call Made", "Call Merge", "Call Missed", "Call Missed Outgoing", "Call Received", "Call Split", "Call To Action", "Camera", "Camera Alt", "Camera Enhance", "Camera Front", "Camera Rear", "Camera Roll", "Cancel", "Card Giftcard", "Card Membership", "Card Travel", "Casino", "Cast", "Cast Connected", "Center Focus Strong", "Center Focus Weak", "Change History", "Chat", "Chat Bubble", "Chat Bubble Outline", "Check", "Check Box", "Check Box Outline Blank", "Check Circle", "Chevron Left", "Chevron Right", "Child Care", "Child Friendly", "Chrome Reader Mode", "Class", "Clear", "Clear All", "Close", "Closed Caption", "Cloud", "Cloud Circle", "Cloud Done", "Cloud Download", "Cloud Off", "Cloud Queue", "Cloud Upload", "Code", "Collections", "Collections Bookmark", "Color Lens", "Colorize", "Comment", "Compare", "Compare Arrows", "Computer", "Confirmation Number", "Contact Mail", "Contact Phone", "Contacts", "Content Copy", "Content Cut", "Content Paste", "Control Point", "Control Point Duplicate", "Copyright", "Create", "Create New Folder", "Credit Card", "Crop", "Crop 16 9", "Crop 3 2", "Crop 5 4", "Crop 7 5", "Crop Din", "Crop Free", "Crop Landscape", "Crop Original", "Crop Portrait", "Crop Rotate", "Crop Square", "Dashboard", "Data Usage", "Date Range", "Dehaze", "Delete", "Delete Forever", "Delete Sweep", "Description", "Desktop Mac", "Desktop Windows", "Details", "Developer Board", "Developer Mode", "Device Hub", "Devices", "Devices Other", "Dialer Sip", "Dialpad", "Directions", "Directions Bike", "Directions Boat", "Directions Bus", "Directions Car", "Directions Railway", "Directions Run", "Directions Subway", "Directions Transit", "Directions Walk", "Disc Full", "Dns", "Do Not Disturb", "Do Not Disturb Alt", "Do Not Disturb Off", "Do Not Disturb On", "Dock", "Domain", "Done", "Done All", "Donut Large", "Donut Small", "Drafts", "Drag Handle", "Drive Eta", "Dvr", "Edit", "Edit Location", "Eject", "Email", "Enhanced Encryption", "Equalizer", "Error", "Error Outline", "Euro Symbol", "Ev Station", "Event", "Event Available", "Event Busy", "Event Note", "Event Seat", "Exit To App", "Expand Less", "Expand More", "Explicit", "Explore", "Exposure", "Exposure Neg 1", "Exposure Neg 2", "Exposure Plus 1", "Exposure Plus 2", "Exposure Zero", "Extension", "Face", "Fast Forward", "Fast Rewind", "Favorite", "Favorite Border", "Featured Play List", "Featured Video", "Feedback", "Fiber Dvr", "Fiber Manual Record", "Fiber New", "Fiber Pin", "Fiber Smart Record", "File Download", "File Upload", "Filter", "Filter 1", "Filter 2", "Filter 3", "Filter 4", "Filter 5", "Filter 6", "Filter 7", "Filter 8", "Filter 9", "Filter 9 Plus", "Filter B And W", "Filter Center Focus", "Filter Drama", "Filter Frames", "Filter Hdr", "Filter List", "Filter None", "Filter Tilt Shift", "Filter Vintage", "Find In Page", "Find Replace", "Fingerprint", "First Page", "Fitness Center", "Flag", "Flare", "Flash Auto", "Flash Off", "Flash On", "Flight", "Flight Land", "Flight Takeoff", "Flip", "Flip To Back", "Flip To Front", "Folder", "Folder Open", "Folder Shared", "Folder Special", "Font Download", "Format Align Center", "Format Align Justify", "Format Align Left", "Format Align Right", "Format Bold", "Format Clear", "Format Color Fill", "Format Color Reset", "Format Color Text", "Format Indent Decrease", "Format Indent Increase", "Format Italic", "Format Line Spacing", "Format List Bulleted", "Format List Numbered", "Format Paint", "Format Quote", "Format Shapes", "Format Size", "Format Strikethrough", "Format Textdirection L To R", "Format Textdirection R To L", "Format Underlined", "Forum", "Forward", "Forward 10", "Forward 30", "Forward 5", "Free Breakfast", "Fullscreen", "Fullscreen Exit", "Functions", "G Translate", "Gamepad", "Games", "Gavel", "Gesture", "Get App", "Gif", "Golf Course", "Gps Fixed", "Gps Not Fixed", "Gps Off", "Grade", "Gradient", "Grain", "Graphic Eq", "Grid Off", "Grid On", "Group", "Group Add", "Group Work", "Hd", "Hdr Off", "Hdr On", "Hdr Strong", "Hdr Weak", "Headset", "Headset Mic", "Healing", "Hearing", "Help", "Help Outline", "High Quality", "Highlight", "Highlight Off", "History", "Home", "Hot Tub", "Hotel", "Hourglass Empty", "Hourglass Full", "Http", "Https", "Image", "Image Aspect Ratio", "Import Contacts", "Import Export", "Important Devices", "Inbox", "Indeterminate Check Box", "Info", "Info Outline", "Input", "Insert Chart", "Insert Comment", "Insert Drive File", "Insert Emoticon", "Insert Invitation", "Insert Link", "Insert Photo", "Invert Colors", "Invert Colors Off", "Iso", "Keyboard", "Keyboard Arrow Down", "Keyboard Arrow Left", "Keyboard Arrow Right", "Keyboard Arrow Up", "Keyboard Backspace", "Keyboard Capslock", "Keyboard Hide", "Keyboard Return", "Keyboard Tab", "Keyboard Voice", "Kitchen", "Label", "Label Outline", "Landscape", "Language", "Laptop", "Laptop Chromebook", "Laptop Mac", "Laptop Windows", "Last Page", "Launch", "Layers", "Layers Clear", "Leak Add", "Leak Remove", "Lens", "Library Add", "Library Books", "Library Music", "Lightbulb Outline", "Line Style", "Line Weight", "Linear Scale", "Link", "Linked Camera", "List", "Live Help", "Live Tv", "Local Activity", "Local Airport", "Local Atm", "Local Bar", "Local Cafe", "Local Car Wash", "Local Convenience Store", "Local Dining", "Local Drink", "Local Florist", "Local Gas Station", "Local Grocery Store", "Local Hospital", "Local Hotel", "Local Laundry Service", "Local Library", "Local Mall", "Local Movies", "Local Offer", "Local Parking", "Local Pharmacy", "Local Phone", "Local Pizza", "Local Play", "Local Post Office", "Local Printshop", "Local See", "Local Shipping", "Local Taxi", "Location City", "Location Disabled", "Location Off", "Location On", "Location Searching", "Lock", "Lock Open", "Lock Outline", "Looks", "Looks 3", "Looks 4", "Looks 5", "Looks 6", "Looks One", "Looks Two", "Loop", "Loupe", "Low Priority", "Loyalty", "Mail", "Mail Outline", "Map", "Markunread", "Markunread Mailbox", "Memory", "Menu", "Merge Type", "Message", "Mic", "Mic None", "Mic Off", "Mms", "Mode Comment", "Mode Edit", "Monetization On", "Money Off", "Monochrome Photos", "Mood", "Mood Bad", "More", "More Horiz", "More Vert", "Motorcycle", "Mouse", "Move To Inbox", "Movie", "Movie Creation", "Movie Filter", "Multiline Chart", "Music Note", "Music Video", "My Location", "Nature", "Nature People", "Navigate Before", "Navigate Next", "Navigation", "Near Me", "Network Cell", "Network Check", "Network Locked", "Network Wifi", "New Releases", "Next Week", "Nfc", "No Encryption", "No Sim", "Not Interested", "Note", "Note Add", "Notifications", "Notifications Active", "Notifications None", "Notifications Off", "Notifications Paused", "Offline Pin", "Ondemand Video", "Opacity", "Open In Browser", "Open In New", "Open With", "Pages", "Pageview", "Palette", "Pan Tool", "Panorama", "Panorama Fish Eye", "Panorama Horizontal", "Panorama Vertical", "Panorama Wide Angle", "Party Mode", "Pause", "Pause Circle Filled", "Pause Circle Outline", "Payment", "People", "People Outline", "Perm Camera Mic", "Perm Contact Calendar", "Perm Data Setting", "Perm Device Information", "Perm Identity", "Perm Media", "Perm Phone Msg", "Perm Scan Wifi", "Person", "Person Add", "Person Outline", "Person Pin", "Person Pin Circle", "Personal Video", "Pets", "Phone", "Phone Android", "Phone Bluetooth Speaker", "Phone Forwarded", "Phone In Talk", "Phone Iphone", "Phone Locked", "Phone Missed", "Phone Paused", "Phonelink", "Phonelink Erase", "Phonelink Lock", "Phonelink Off", "Phonelink Ring", "Phonelink Setup", "Photo", "Photo Album", "Photo Camera", "Photo Filter", "Photo Library", "Photo Size Select Actual", "Photo Size Select Large", "Photo Size Select Small", "Picture As Pdf", "Picture In Picture", "Picture In Picture Alt", "Pie Chart", "Pie Chart Outlined", "Pin Drop", "Place", "Play Arrow", "Play Circle Filled", "Play Circle Outline", "Play For Work", "Playlist Add", "Playlist Add Check", "Playlist Play", "Plus One", "Poll", "Polymer", "Pool", "Portable Wifi Off", "Portrait", "Power", "Power Input", "Power Settings New", "Pregnant Woman", "Present To All", "Print", "Priority High", "Public", "Publish", "Query Builder", "Question Answer", "Queue", "Queue Music", "Queue Play Next", "Radio", "Radio Button Checked", "Radio Button Unchecked", "Rate Review", "Receipt", "Recent Actors", "Record Voice Over", "Redeem", "Redo", "Refresh", "Remove", "Remove Circle", "Remove Circle Outline", "Remove From Queue", "Remove Red Eye", "Remove Shopping Cart", "Reorder", "Repeat", "Repeat One", "Replay", "Replay 10", "Replay 30", "Replay 5", "Reply", "Reply All", "Report", "Report Problem", "Restaurant", "Restaurant Menu", "Restore", "Restore Page", "Ring Volume", "Room", "Room Service", "Rotate 90 Degrees Ccw", "Rotate Left", "Rotate Right", "Rounded Corner", "Router", "Rowing", "Rss Feed", "Rv Hookup", "Satellite", "Save", "Scanner", "Schedule", "School", "Screen Lock Landscape", "Screen Lock Portrait", "Screen Lock Rotation", "Screen Rotation", "Screen Share", "Sd Card", "Sd Storage", "Search", "Security", "Select All", "Send", "Sentiment Dissatisfied", "Sentiment Neutral", "Sentiment Satisfied", "Sentiment Very Dissatisfied", "Sentiment Very Satisfied", "Settings", "Settings Applications", "Settings Backup Restore", "Settings Bluetooth", "Settings Brightness", "Settings Cell", "Settings Ethernet", "Settings Input Antenna", "Settings Input Component", "Settings Input Composite", "Settings Input Hdmi", "Settings Input Svideo", "Settings Overscan", "Settings Phone", "Settings Power", "Settings Remote", "Settings System Daydream", "Settings Voice", "Share", "Shop", "Shop Two", "Shopping Basket", "Shopping Cart", "Short Text", "Show Chart", "Shuffle", "Signal Cellular 4 Bar", "Signal Cellular Connected No Internet 4 Bar", "Signal Cellular No Sim", "Signal Cellular Null", "Signal Cellular Off", "Signal Wifi 4 Bar", "Signal Wifi 4 Bar Lock", "Signal Wifi Off", "Sim Card", "Sim Card Alert", "Skip Next", "Skip Previous", "Slideshow", "Slow Motion Video", "Smartphone", "Smoke Free", "Smoking Rooms", "Sms", "Sms Failed", "Snooze", "Sort", "Sort By Alpha", "Spa", "Space Bar", "Speaker", "Speaker Group", "Speaker Notes", "Speaker Notes Off", "Speaker Phone", "Spellcheck", "Star", "Star Border", "Star Half", "Stars", "Stay Current Landscape", "Stay Current Portrait", "Stay Primary Landscape", "Stay Primary Portrait", "Stop", "Stop Screen Share", "Storage", "Store", "Store Mall Directory", "Straighten", "Streetview", "Strikethrough S", "Style", "Subdirectory Arrow Left", "Subdirectory Arrow Right", "Subject", "Subscriptions", "Subtitles", "Subway", "Supervisor Account", "Surround Sound", "Swap Calls", "Swap Horiz", "Swap Vert", "Swap Vertical Circle", "Switch Camera", "Switch Video", "Sync", "Sync Disabled", "Sync Problem", "System Update", "System Update Alt", "Tab", "Tab Unselected", "Tablet", "Tablet Android", "Tablet Mac", "Tag Faces", "Tap And Play", "Terrain", "Text Fields", "Text Format", "Textsms", "Texture", "Theaters", "Thumb Down", "Thumb Up", "Thumbs Up Down", "Time To Leave", "Timelapse", "Timeline", "Timer", "Timer 10", "Timer 3", "Timer Off", "Title", "Toc", "Today", "Toll", "Tonality", "Touch App", "Toys", "Track Changes", "Traffic", "Train", "Tram", "Transfer Within A Station", "Transform", "Translate", "Trending Down", "Trending Flat", "Trending Up", "Tune", "Turned In", "Turned In Not", "Tv", "Unarchive", "Undo", "Unfold Less", "Unfold More", "Update", "Usb", "Verified User", "Vertical Align Bottom", "Vertical Align Center", "Vertical Align Top", "Vibration", "Video Call", "Video Label", "Video Library", "Videocam", "Videocam Off", "Videogame Asset", "View Agenda", "View Array", "View Carousel", "View Column", "View Comfy", "View Compact", "View Day", "View Headline", "View List", "View Module", "View Quilt", "View Stream", "View Week", "Vignette", "Visibility", "Visibility Off", "Voice Chat", "Voicemail", "Volume Down", "Volume Mute", "Volume Off", "Volume Up", "Vpn Key", "Vpn Lock", "Wallpaper", "Warning", "Watch", "Watch Later", "Wb Auto", "Wb Cloudy", "Wb Incandescent", "Wb Iridescent", "Wb Sunny", "Wc", "Web", "Web Asset", "Weekend", "Whatshot", "Widgets", "Wifi", "Wifi Lock", "Wifi Tethering", "Work", "Wrap Text", "Youtube Searched For", "Zoom In", "Zoom Out"]
Link Text Text for the link
  • Field Name: sections.[n].links.[n].link_text
  • Type: String
Condition Only show this link if this condition evaluates to true.
  • Field Name: sections.[n].links.[n].condition
  • Type: String
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
Custom Component The selected Voss Portal Custom Component that is associated with the Menu Item.
  • Field Name: sections.[n].links.[n].custom_component
  • Type: String
  • Target: data/VossPortalCustomComponent
  • Target attr: component_route
  • Format: uri
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", "Landing Page", "List", "Wizard"]
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