[Index]

Model: data/MenuLayout

Menu Layouts

Full HTML Help

Overview

Menu layouts define the content and structure of menus in the Admin Portal, based on your user role at the hierarchy where you log in.

VOSS Automate allows an administrator (with appropriate permissions) to customize menu layouts for different user roles and hierarchy levels. For example, the menu layouts at Provider level of the hierarchy can be different to menu layouts at Customer or Site level. Customizing menu layouts for different user roles at each hierarchy allows you to hide or show resources appropriate for different roles.

Related Topics

Navigation - Menu and Dashboards in the Best Practices Guide

Advanced Configuration Guide

Fixed and Configurable Filters in Menus in the Core Feature Guide

HCS Dial Plan Macros in VOSS Automate in the Core Feature Guide

Fixed and Configurable Filters

If a menu layout applies to the list view of a model, this list can be filtered by means of a number of filter options that apply to the displayed list. Only instances where the values of a model attribute that match the filter, are then shown. For details, see Fixed and Configurable Filters in Menus and Landing Pages

Default Menu Layouts

VOSS Automate ships with a number of default menu layouts for the following, hierarchy-based administrator user roles:

If you wish to create a new menu layout, you can create a copy (clone) of a default menu layout, edit the settings, and save it as a new, custom, menu layout.

You can also export a menu layout, edit it externally, and re-import it. For example, you can apply an alternative FDP or CFT, or change the order and grouping of items on the menu layout. Designers with access to tag or version tag can apply these to a menu layout so that it can be uniquely identified to track changes.

Note

The VOSS Automate documentation is based on the default, predefined menu layouts that ship with the system.

To work with menu layouts in the Admin Portal (via the default menus):

Best Practice Menus

In addition to the default menu layouts, VOSS Automate provides best practice menus for Provider and Customer administrators, including the associated access profiles and dashboards.

The best practice menus are more business-oriented, and include additional options based on best practice adaptations that may also be included in VOSS Automate.

The table describes the key features of the best practice menus:

Feature Description
Structure mapped to business use case

A menu order, nesting and naming convention based on common business use.

Menus are ordered 'top-down, following the logical order of tasks and the system hierarchies that perform these tasks.

Example: For Provider admins, the Cisco UC App Management menu has menus only for these devices, while SMTP server and other settings that Provider admins use are arranged under a menu called Provider Configuration.

In a similar way, the Cisco Subscriber Services menu has sub-menus for all the functionality associated with Cisco subscribers in VOSS Automate.

Naming convention

First word capitalized for menu names where the menu is for a form view (input or edit). For example ADD Internal Number Inventory

Where such menu names start with abbreviations or acronyms, for example, E164, HCS, or LDAP, the capitalization rule applies to the next word in the name.

Menus for URLs

Included in the structure are menus that provide links to other VOSS Automate portals, allowing you to launch a another portal directly from a menu.

For this to work, you must update these URLs to match your configuration.

Considerations when Customizing and Assigning a Best Practice Menu

If you wish to modify a best practice menu and then assign the customized best practice menu to a user role, consider the following:

Enhanced menu layouts and dashboards for multi vendor environments

VOSS Automate provides two sets of menus, dashboards, and access profiles for use or cloning and further customization for multi vendors scenarios. These sets offer best-practice reference role-sets that can be used by service providers.

The set of best practice menus and dashboards is comprehensive and includes some add-on options which are not currently included in the core solution. If you want to use a specific option and get a permission error when trying it using the MVS- set, please reach out to the VOSS service team to discuss.

Note

Multi vendor subscriber (MVS) dashboards and menu layouts that contain links referencing an adaptation (add-on), have an asterisk (*) postfix in the link text.

Microsoft-only deployment items contain MS-Only in the name, and menu names have the MVS prefix:

These menu layouts offer a number of benefits, for example:

The comprehensive set of sample dashboards is provided and used in these menu layouts. They are identified by the dashboard name with prefix, MVS-, and suffix, -Dashboard. For example, the Role Management dashboard is MVS-RoleManagement-Dashboard.

Note

This also includes home dashboards:

These dashboards can therefore also be cloned and customized as required.

The access profiles associated with these menu layouts and dashboards can also be cloned and configured according to the customized menu layouts and dashboards. They contain the prefix:

The Condition field in menu layouts and dashboard widgets can be configured for multi vendors by using the macros as conditional values - as per enabled features in Global Settings:

Sample administrator roles are provided that combine all these elements:

Add or Edit a Menu Layout

This procedure adds new menus and modifies existing menus. You can create a new layout for your system or update the default menu layout.

  1. Log in to the Admin Portal as a Provider or Reseller administrator (or higher).

  2. Choose the hierarchy for the new menu layout, for example, Customer.

  3. Go to (default menus) Role Management > Menu Layouts.

  4. Choose an option:

    Create a new menu layout, based on settings in an existing menu layout

    Recommended method.

    Click on the menu layout you wish to copy. On the menu layout editing screen, click the toolbar Clone icon. A new record is created with pre-populated settings.

    Go to the next step to edit settings for the clone to create a new, custom menu layout.

    Create a new menu layout as a new record (without existing settings) Click the toolbar Plus icon (+) to open the Menu Layouts/New Record page. Go to the next step to set up the new menu layout.
    Edit an existing menu layout Click on the menu layout you wish to edit, update its settings, then save your changes. Log out, then log in again to see your changes.

    Note

    • You can click in a row to edit a value (either type in the field or select an option from a drop-down)
    • Rows with nested menu 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.
    • For further details around menu configuration, see Menu Layout Field Reference.
  5. At Menu Items, configure the main menus and sub-menus, as required

    • To re-order menus, click on the hamburger icon and drag items to the required position.

    • To add, clone, or delete rows for main menus and nested sub-menus, click the Plus icon, Clone icon, or Delete icon in the relevant row.

      Note

      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 menu layout you're configuring.

    • Add, clone, or delete sub-menus (click the Plus icon in the Menu Items column to display nested sub-menus).

    • At Filters, configure fixed and configurable filters.

    • At Icon, choose a menu icon (main menus only). See: Custom Icon Names Reference.

    • At Title, add or edit the menu title, and (optionally), provide a description.

    • At Condition (optionally), fill out a condition to define when the menu will display.

    • At Display As, choose an option to define how the menu or sub-menu will display. Options are: Form, List, External Link, or Dashboard.

      Note

      • The value for Display As must be Form when the value at Model Type is view.
      • The value for Display As must be Dashboard if you're choosing a dashboard.
    • At Type, choose the model type.

      Note

      When type is view (view/ModelType), the value in the Display As column must be Form.

    • At Href, create internal or external links.

      Note

      • If Display As is set to External Link, the Href value should start with http.

      • If Display As is set to List, the internal Href value should start with /api/.

      • If you wish to provide a sorted list view of a model in a menu item, the Href internal href value can be entered with additional parameters to specify attribute and sort order. In this case, Display As should be selected as List, with the direction parameter to sort.

        For example, if Href is:

        /api/data/Countries/?order_by=iso_country_code;direction=desc
        

        the list view from the menu item of data/Countries will be sorted in descending order, by iso_country_code: ZIM, ZAF, VNM, USA, UKR,... and so on.

    • At Field Display Policy, choose a field display policy, if required.

    • At Configuration Template, choose a configuration template, if required.

    • Select Set as default Model Type to define that when a user navigates to a form for that model from a location where any of the FDP, CFT, and title is not available, then the form will contain these elements configured as the default.

      Note

      If no default is set, or multiple defaults are set for FDP and CFT selection, the selection is random. Multiple defaults will also yield an error message in the browser console if the Browser Console Log Level is set to Debug (see: Introduction to the Admin Portal User Interface) The format of the message is:

      Multiple defaults configured for ... <model-type>
      

      It is therefore advisable to explicitly set the default and ensure that only one default is set.

    • At Dashboard, you can instead choose an existing dashbaord to associate with the menu item.

      Note

      • You can choose a dashboard for a main menu, sub-menu, or sub-sub-menu.
      • When setting a dashboard, the value in the Display As column must be Dashboard.
  6. Click Save. Updated or new menu layouts are saved.

  7. Assign the menu layout to the appropriate roles.

Menu Layouts Field Reference

This section describes menu layout configuration options:

Note

You can view, add, and edit menu layouts in the Admin Portal via (default menus) Role Management > Menu Layouts. See Create a Menu Layout

Field Description
Name Mandatory. The menu layout name.
Description A description of the menu layout.
Menu Items This section displays the menus and sub-menus in an editable table layout.

Menu Layouts

Note

To work on an existing menu layout, we recommend that you clone the menu layout and work on the clone.

  1. Log in as hcsadmin, provider or reseller administrator.

  2. Choose the hierarchy for the menu layout.

  3. Choose Role Management > Menu Layouts.

  4. Click Add to open the Menu Layouts input form.

  5. Enter a Name and a Description for the menu layout.

  6. Add (by clicking + next to Menu Items), and optionally nest Menu Items for each required menu item:

    1. Choose an Icon name from the dropdown to be displayed on the GUI menu. To see the icons, refer to Business Admin Portal Interface Custom Icon Names Reference.

    2. Enter a Title.

    3. For a list view of a model, select from the Type drop-down list and choose List as the Display as value. For the selected model type, choose a default Field Display Policy and Configuration Template. If a User Role is associated with the menu layout, then users with this role see the model type according to these.

      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.

    4. Href is generally used for external links. It can however be used for links within the application to link directly to a form. For example, the Add Phone form would have the HREF value of api/relation/SubscriberPhone/add. In such cases, any associated Field Display Policies and Configuration Templates for the menu item can only be added by using a menu import in JSON format or on a bulk load sheet.

      Note that view/ type models should not be referenced as Href - only from the Type drop down. The view/ model types always open the "Add" form - without having to use the href with /add/.

      If Href is used, choose the Display as format of the item as follows:

      • Form - Show an input form. The Href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with "/add/".

      • IFrame - A URL specified as the Href value opens as an IFrame for cross-launching.

      • External Link - A URL specified as the Href value opens as a new browser tab.

        Note: pop-up blocking should be disabled on user browsers for the external link to resolve.

      • Tree - If available, a tree view of resource to display. Href provides the tree path.

      • List - List view of a resource referenced by Type or Href. A tool (tool/[toolname]) can also be presented as a list, for example

        /api/tool/Transaction/?entity=data/Event&operation=execute

      • Wizard - Execute a wizard referenced by Href (wizard resource ends with "/0/"). For example:

        /api/wizard/AddressWizard/0/

    5. Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.

  7. Click Save on the button bar when complete to create the menu layout.

To modify an existing menu layout, click the relevant menu layout name from the Menu Layouts list view and edit the appropriate fields as described above. Click Save when complete.

Updates in the menu layout are available for the user only when logging in again.

When complete, assign the menu layout to the appropriate roles.

Menu Layouts

Menu layouts define the view a user has of the menu content and structure on the GUI. This is fully customizable up to three levels deep and can be created or edited to represent the content any user needs to have access to. The association of the defined view of the menu is made with the user's role and menu layouts can be created directly on the GUI.

To refine a view of model entities for a user, a Field Display Policy (FDP) and Configuration Template (CFT) for a model can be applied. The FDP and CFT for a specific model is applied as part of the menu layout - in other words in the menu structure, the FDP and CFT are attributes of the specific model entry for that menu layout. This means that:

If a menu layout applies to the list view of a model, this list can be filtered by means of a number of filter options that apply to the displayed list. Only instances where the values of a model attribute that match the filter, are then shown.

Default menu layouts are provided with VOSS-4-UC. These include defaults for pre-defined hierarchy based user roles, namely Global Administrator, Provider Administrator, Customer Administrator and Site Administrator. The details of these default menu layouts can be viewed and easily edited to either remove or add entries, update entries (for example with an alternative FDP), change default values (for example with an alternative CFT), or change the order and groupings of the items.

The menu layout is an attribute of the user role. Each user must be assigned a User Role, thus the user will see the menu layout based on this user role. Refer to the User Role topic.

Menu layouts can also be copied via the Clone option so they can be edited or exported and re-imported.

Designers who have access to tag or version tag can apply these to a menu layout so that it can be uniquely identified to track and control changes.

Create a Menu Layout

  1. Choose the hierarchy for the menu layout.

  2. Choose System Configuration > Menu Layouts.

  3. Click Add to open the Menu Layouts input form.

  4. Enter a Name for the menu layout.

  5. Add (by clicking Add adjacent to Menu Items), and optionally nest Menu Items for each required menu item:

    1. Enter a Title.

    2. For a list view of a model, select from the Type drop-down list and choose List as the Display as value. For the selected model type, choose a default Field Display Policy and Configuration Template. If a User Role is associated with the menu layout, then users with this role see the model type according to these.

      If List is selected as the display, then the resulting list can also be filtered. Click More... in the Filter Options column to open the dialog to enter one or more filter options. More than one filter results in a logical AND of the filters.

      • Filter By - attributes of the selected Type can be selected from the drop-down list.
      • Filter Type - select the matching operator for the filter.
      • Filter String - select the value that the matching operator should match by.

      For example, if the selected type has a name attribute to filter by and the Filter Type is Starts With, then the menu item list only shows instances where the names start with the Filter String.

    3. If Href is used, choose the Display as format of the item as follows:

      • Form - Show an input form. The Href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with "/add/".

      • IFrame - A URL specified as the Href value opens as an IFrame for cross-launching.

      • External Link - A URL specified as the Href value opens as a new browser tab.

      • Tree - If available, a tree view of resource to display. Href provides the tree path.

      • List - List view of a resource referenced by Type or Href. A tool (tool/[toolname]) can also be presented as a list, for example

        /api/tool/Transaction/?entity=data/Event&operation=execute

      • Wizard - Execute a wizard referenced by Href (wizard resource ends with "/0/"). For example:

        /api/wizard/AddressWizard/0/

    4. Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.

  6. Click Save on the button bar when complete to create the menu layout.

To modify an existing menu layout, click the relevant menu layout name from the Menu Layouts list view and edit the appropriate fields as described above. Click Save when complete.

Updates in the menu layout are available for the user only when logging in again.

While default menu layouts are available for a user and an administrator user, a menu layout can be created from the GUI and can then be associated with a User Role. Users that have been assigned to this role will be able to use the created menu layout.

Model Details: data/MenuLayout

Title Description Details
Name * The name that is given to the Menu Layout.
  • Field Name: name
  • Type: String
Description A description of the Menu Layout.
  • Field Name: description
  • Type: String
Menu Items The list of menu items and -sub items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Title * The menu item title as it will show on the menu.
  • Field Name: menu_items.[n].title
  • Type: String
Description The menu item description as it will show on the menu.
  • Field Name: menu_items.[n].description
  • Type: String
Condition Only show this menu item if this condition evaluates to true.
  • Field Name: menu_items.[n].condition
  • Type: String
Icon The icon to be used for this menu entry.
  • Field Name: menu_items.[n].icon
  • Type: String
  • Target: data/Icons
  • Target attr: icon_value
  • 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: menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "External Link", "Dashboard"]
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[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: menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[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: menu_items.[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: menu_items.[n].default_model_type
  • Type: Boolean
Landing Page The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI).
  • Field Name: menu_items.[n].landing_page
  • Type: String
  • Target: data/LandingPage
  • Target attr: name
  • Format: uri
Dashboard The selected Dashboard that is associated with the Menu Item.
  • Field Name: menu_items.[n].dashboard
  • Type: String
  • Target: data/Dashboard
  • Target attr: name
  • Format: uri
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: menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[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: menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean
Menu Items The list of nested menu items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Title * The nested menu item title as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].title
  • Type: String
Description The nested menu item description as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].description
  • Type: String
Condition Only show this menu item if this condition evaluates to true.
  • Field Name: menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "External Link", "Dashboard"]
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].default_model_type
  • Type: Boolean
Landing Page The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI).
  • Field Name: menu_items.[n].menu_items.[n].landing_page
  • Type: String
  • Target: data/LandingPage
  • Target attr: name
  • Format: uri
Dashboard The selected Dashboard that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].dashboard
  • Type: String
  • Target: data/Dashboard
  • Target attr: name
  • Format: uri
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: menu_items.[n].menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean
Menu Items The list of nested menu items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Title * The nested menu item title as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].title
  • Type: String
Description The nested menu item description as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].description
  • Type: String
Condition Only show this menu item if this condition evaluates to true.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "External Link", "Dashboard"]
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].menu_items.[n].default_model_type
  • Type: Boolean
Landing Page The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI).
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].landing_page
  • Type: String
  • Target: data/LandingPage
  • Target attr: name
  • Format: uri
Dashboard The selected Dashboard that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].dashboard
  • Type: String
  • Target: data/Dashboard
  • Target attr: name
  • Format: uri
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: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[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: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean