[Index]

Model: data/DashboardWidgetLinks

Defines the schema for the Links Dashboard Widget.

Model Details: data/DashboardWidgetLinks

Title Description Details
Title * The title to be displayed for this widget.
  • Field Name: title
  • Type: String
Description The description to be displayed for this widget.
  • Field Name: description
  • Type: String
Links List of links that belong to section.
  • Field Name: links.[n]
  • Type: Array
Link Text Text for the link
  • Field Name: links.[n].link_text
  • Type: String
Description A description of the Link.
  • Field Name: links.[n].description
  • Type: String
Icon The icon to be used for this link.
  • Field Name: links.[n].icon
  • Type: String
  • Target: data/Icons
  • Target attr: icon_value
  • Format: uri
Condition Only show this link if this condition evaluates to true.
  • Field Name: links.[n].condition
  • Type: String
Display As Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list
  • Field Name: links.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "Inline List", "List", "External Link", "Dashboard"]
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: 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: links.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: 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: links.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Dashboard The selected Dashboard that is associated with the Menu Item (only available on the New Admin GUI).
  • Field Name: links.[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
Field Name
  • Field Name: links.[n].filter_options.[n].filter_by
  • Type: String
Operation
  • Field Name: links.[n].filter_options.[n].operation
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter Value
  • Field Name: links.[n].filter_options.[n].filterValue
  • Type: String
Ignore Case
  • Field Name: 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
Field Name
  • Field Name: links.[n].configurable_options.[n].filter_by
  • Type: String
Operation
  • Field Name: links.[n].configurable_options.[n].operation
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter Value
  • Field Name: links.[n].configurable_options.[n].filterValue
  • Type: String
Ignore Case
  • Field Name: links.[n].configurable_options.[n].ignore_case
  • Type: Boolean
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 dashboard.
  • Field Name: links.[n].default_model_type
  • Type: Boolean