[Index]

Model: data/DashboardWidgetText

Defines the schema for the Text Dashboard Widget.

Model Details: data/DashboardWidgetText

Title Description Details
Data Settings Group Assigned by FDP
  • Field Name: Data Settings
  • Type: Object
Title * The title to be displayed for this widget.
  • Field Name: Data Settings.title
  • Type: String
  • MaxLength: 1024
Description The description to be displayed for this widget.
  • Field Name: Data Settings.description
  • Type: String
  • MaxLength: 1024
Condition Only show this widget if this condition evaluates to true.
  • Field Name: Data Settings.condition
  • Type: String
  • MaxLength: 1024
Dynamic Content Specify if the content is dynamic and will be updated based on the data lookup.
  • Field Name: Data Settings.dynamicContent
  • Type: Boolean
Type * Default: Markdown
  • Field Name: Data Settings.type
  • Type: String
  • Default: Markdown
  • MaxLength: 1024
  • Choices: ["Markdown", "HTML"]
Data Source The source from which the data for this column chart is obtained. Default: LXT0
  • Field Name: Data Settings.datasource
  • Type: String
  • Default: LXT0
  • MaxLength: 1024
Data Source Instance Specify Data Source Instance
  • Field Name: Data Settings.datasourceInstance
  • Type: String
  • Target: data/DashboardDatasource
  • MaxLength: 1024
  • Format: uri
Allow Data Source Selection on Dashboard Specify that the Data Source Instance can be modified on Dashboard. Default: True
  • Field Name: Data Settings.allowDatasourceSelection
  • Type: Boolean
  • Default: True
Resource Specify resource
  • Field Name: Data Settings.resource
  • Type: String
  • Target: data/ReporterResource
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Fields Specify the fields from the resource to be used in the chart.
  • Field Name: fields.[n]
  • Type: Array
Field Name This is the field name.
  • Field Name: Data Settings.fields.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Friendly Name Specify a friendly name to be used in the chart.
  • Field Name: Data Settings.fields.[n].headerName
  • Type: String
  • MaxLength: 1024
Field Type This is the field type
  • Field Name: Data Settings.fields.[n].ruleTypeString
  • Type: String
  • MaxLength: 1024
Operation Select the operation to be performed on the field.
  • Field Name: Data Settings.fields.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: []
Value Mapping Select the value mapping to display user-friendly values. This will override the resource value mapping if one exists. To use the raw value, select 'NO MAPPING'.
  • Field Name: Data Settings.fields.[n].value_mapping
  • Type: String
  • MaxLength: 1024
Custom Fields Specify the custom fields that data will be derived from other fields.
  • Field Name: customFields.[n]
  • Type: Array
Field Name Internal column identifier ( must be unique ).
  • Field Name: Data Settings.customFields.[n].ruleName
  • Type: String
  • MaxLength: 1024
Friendly Name Label shown in the table/chart header.
  • Field Name: Data Settings.customFields.[n].headerName
  • Type: String
  • MaxLength: 1024
Value Type Specify the fields from the resource to be used in the chart. Default: string
  • Field Name: Data Settings.customFields.[n].valueType
  • Type: String
  • Default: string
  • MaxLength: 1024
  • Choices: ["Integer", "Number", "String"]
Operation Shown when Value Type is Integer or Number. Default: sum
  • Field Name: Data Settings.customFields.[n].operation_numeric
  • Type: String
  • Default: sum
  • MaxLength: 1024
  • Choices: ["Sum (column)", "Average (column)", "Max (column)", "Min (column)", "Add (A + B)", "Subtract (A - B - C)", "Multiply", "Divide (A / B)", "Format (complex SQL expression)"]
Operation Shown when Value Type is String. Default: substring
  • Field Name: Data Settings.customFields.[n].operation_string
  • Type: String
  • Default: substring
  • MaxLength: 1024
  • Choices: ["Substring", "Length", "Regex Extract", "Split Part", "Prefix", "Suffix", "Concat", "Replace", "Format (complex SQL expression)"]
Source Columns Specify the one or more fields to be used in the custom field.
  • Field Name: sourceColumns.[n]
  • Type: Array
Field Name Rule name / field identifier.
  • Field Name: Data Settings.customFields.[n].sourceColumns.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Parameters
  • Field Name: params
  • Type: Object
Separator (concat)
  • Field Name: Data Settings.customFields.[n].params.separator
  • Type: String
  • MaxLength: 1024
Value (prefix/suffix)
  • Field Name: Data Settings.customFields.[n].params.value
  • Type: String
  • MaxLength: 1024
Find (replace)
  • Field Name: Data Settings.customFields.[n].params.find
  • Type: String
  • MaxLength: 1024
Replacement (replace)
  • Field Name: Data Settings.customFields.[n].params.replacement
  • Type: String
  • MaxLength: 1024
Use Regex (replace) When true, Find is treated as a regular expression; when false, Find is literal text. Use regex for patterns (e.g. \d+ for digits) or capture groups in Replacement (e.g. $1).
  • Field Name: Data Settings.customFields.[n].params.is_regex
  • Type: Boolean
Constant (arithmetic)
  • Field Name: Data Settings.customFields.[n].params.constant
  • Type: Number
As Percent (ratio)
  • Field Name: Data Settings.customFields.[n].params.as_percent
  • Type: Boolean
Start (substring)
  • Field Name: Data Settings.customFields.[n].params.start
  • Type: Integer
Length (substring)
  • Field Name: Data Settings.customFields.[n].params.length
  • Type: Integer
Pattern (regex_extract)
  • Field Name: Data Settings.customFields.[n].params.pattern
  • Type: String
  • MaxLength: 1024
Group (regex_extract) Default: 1
  • Field Name: Data Settings.customFields.[n].params.group
  • Type: Integer
  • Default: 1
Delimiter (split_part) Default: ,
  • Field Name: Data Settings.customFields.[n].params.delimiter
  • Type: String
  • Default: ,
  • MaxLength: 1024
Index (split_part)
  • Field Name: Data Settings.customFields.[n].params.index
  • Type: Integer
Template (format)
  • Field Name: Data Settings.customFields.[n].params.template
  • Type: String
  • MaxLength: 1024
  • Format: multiline
Filters Specify filters to be applied to the data.
  • Field Name: filters.[n]
  • Type: Array
Field Name Specify Field Name
  • Field Name: Data Settings.filters.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Operation Specify operation
  • Field Name: Data Settings.filters.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: []
Filter Value Specify filter value
  • Field Name: Data Settings.filters.[n].filterValue
  • Type: String
  • MaxLength: 1024
Sorts Specify sorts to be applied to the fields.
  • Field Name: sorts.[n]
  • Type: Array
Field Name Select the field name to sort by.
  • Field Name: Data Settings.sorts.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Sort Type Select the sort type
  • Field Name: Data Settings.sorts.[n].sort
  • Type: Integer
  • Choices: ["Ascending", "Descending"]
Series Limit The maximum number of groups to display on the chart Default: 0
  • Field Name: Data Settings._groupingLimit
  • Type: String
  • Default: 0
  • MaxLength: 1024
  • Choices: ["All", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "15", "20", "25", "30", "40", "50", "60", "70", "80", "90", "100", "200", "300", "400", "500", "1000", "10000", "50000", "100000"]
Content *
  • Field Name: Data Settings.content
  • Type: String
  • MaxLength: 16384