[Index]

Model: data/DashboardWidgetCounters

Defines the schema for the Counters Dashboard Widget.

Model Details: data/DashboardWidgetCounters

Title Description Details
Data Settings Group Assigned by FDP
  • Field Name: Data Settings
  • Type: Object
Title * The title to be displayed for this counter.
  • 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
Data Source Specify Data Source 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
Counters Filters that can't be removed by end user.
  • Field Name: automate_counters.[n]
  • Type: Array
Title * The title to be displayed for this counter.
  • Field Name: Data Settings.automate_counters.[n].title
  • Type: String
  • MaxLength: 1024
Icon The icon to be used for this counter.
  • Field Name: Data Settings.automate_counters.[n].icon
  • Type: String
  • Target: data/Icons
  • Target attr: icon_value
  • MaxLength: 1024
  • Format: uri
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: Data Settings.automate_counters.[n].type
  • Type: String
  • MaxLength: 1024
  • Format: uri
Field Display Policy The selected Field Display Policy that is associated with the counter.
  • Field Name: Data Settings.automate_counters.[n].field_display_policy
  • Type: String
  • Target: data/FieldDisplayPolicy
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Condition Only show this counter if this condition evaluates to true.
  • Field Name: Data Settings.automate_counters.[n].condition
  • Type: String
  • MaxLength: 1024
Configuration Template The selected Configuration Template that is associated with the counter.
  • Field Name: Data Settings.automate_counters.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Fixed Filters Filters that can't be removed by end user.
  • Field Name: filter_options.[n]
  • Type: Array
Field Name
  • Field Name: Data Settings.automate_counters.[n].filter_options.[n].filter_by
  • Type: String
  • MaxLength: 1024
Operation
  • Field Name: Data Settings.automate_counters.[n].filter_options.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter Value
  • Field Name: Data Settings.automate_counters.[n].filter_options.[n].filterValue
  • Type: String
  • MaxLength: 1024
Ignore Case
  • Field Name: Data Settings.automate_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
Field Name
  • Field Name: Data Settings.automate_counters.[n].configurable_options.[n].filter_by
  • Type: String
  • MaxLength: 1024
Operation
  • Field Name: Data Settings.automate_counters.[n].configurable_options.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter Value
  • Field Name: Data Settings.automate_counters.[n].configurable_options.[n].filterValue
  • Type: String
  • MaxLength: 1024
Ignore Case
  • Field Name: Data Settings.automate_counters.[n].configurable_options.[n].ignore_case
  • Type: Boolean
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
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
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
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"]
Counter Settings Group Assigned by FDP
  • Field Name: Counter Settings
  • Type: Object
Series Limit The maximum number of groups to display on the chart Default: 0
  • Field Name: Counter 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"]
Color Key Specify Key to determine Color from Color mapping Default: value_key
  • Field Name: Counter Settings.colorKey
  • Type: String
  • Default: value_key
  • MaxLength: 1024
  • Choices: ["Counter name", "Counter value"]
Chart Settings Chart Settings
  • Field Name: settings
  • Type: Object
Color Key Specify Key to determine Color from Color mapping Default: value_key
  • Field Name: Counter Settings.settings.colorKey
  • Type: String
  • Default: value_key
  • MaxLength: 1024
  • Choices: ["Counter name", "Counter value"]
Text Color Mapping Specify counter text color mapping
  • Field Name: Counter Settings.settings.textColorMapping
  • Type: String
  • Target: data/DashboardColorMapping
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Background Color Mapping Specify counter back ground color mapping
  • Field Name: Counter Settings.settings.backgroundColorMapping
  • Type: String
  • Target: data/DashboardColorMapping
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Number Type Specify number format type to be used for the counter value Default: Default
  • Field Name: Counter Settings.settings.numType
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Abbreviation", "Bandwidth", "Throughput", "Percentage"]
Number Base Specify number base (decimal or binary) Default: Base 10 (1000)
  • Field Name: Counter Settings.settings.numberBase
  • Type: String
  • Default: Base 10 (1000)
  • MaxLength: 1024
  • Choices: ["Decimal", "Binary"]
Bit/Byte Type Specify bit type (bit or byte) Default: bit
  • Field Name: Counter Settings.settings.bbType
  • Type: String
  • Default: bit
  • MaxLength: 1024
  • Choices: ["Bit", "Byte"]
Prefix Specify the prefix text to be applied to the counter value.
  • Field Name: Counter Settings.settings.prefix
  • Type: String
  • MaxLength: 1024
Suffix Specify the suffix text to be applied to the counter value.
  • Field Name: Counter Settings.settings.suffix
  • Type: String
  • MaxLength: 1024
Numeric Precision Specify numeric precision to be used for the counter value
  • Field Name: Counter Settings.settings.numericPrecision
  • Type: Integer
Factor Specify factor to be multiplied to the counter value
  • Field Name: Counter Settings.settings.factor
  • Type: Number
Default Value Specify a default value to show in case no data is returned.
  • Field Name: Counter Settings.settings.defaultValue
  • Type: Any
Empty Group Text Text will be used when group name is empty.
  • Field Name: Counter Settings.settings.emptyGroupText
  • Type: String
  • MaxLength: 1024
Renderers Specify renderers
  • Field Name: renderers.[n]
  • Type: Array
Field Name Specify field name.
  • Field Name: Counter Settings.settings.renderers.[n].ruleName
  • Type: String
  • MaxLength: 1024
Display in Title Display the field's data in title? Default: True
  • Field Name: Counter Settings.settings.renderers.[n].showName
  • Type: Boolean
  • Default: True
Text Color Mapping Specify counter text color mapping
  • Field Name: Counter Settings.textColorMapping
  • Type: String
  • Target: data/DashboardColorMapping
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Background Color Mapping Specify counter back ground color mapping
  • Field Name: Counter Settings.backgroundColorMapping
  • Type: String
  • Target: data/DashboardColorMapping
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Number Type Specify number format type to be used for the counter value Default: Default
  • Field Name: Counter Settings.numType
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Abbreviation", "Bandwidth", "Throughput", "Percentage"]
Number Base Specify number base (decimal or binary) Default: Base 10 (1000)
  • Field Name: Counter Settings.numberBase
  • Type: String
  • Default: Base 10 (1000)
  • MaxLength: 1024
  • Choices: ["Decimal", "Binary"]
Bit/Byte Type Specify bit type (bit or byte) Default: bit
  • Field Name: Counter Settings.bbType
  • Type: String
  • Default: bit
  • MaxLength: 1024
  • Choices: ["Bit", "Byte"]
Prefix Specify the prefix text to be applied to the counter value.
  • Field Name: Counter Settings.prefix
  • Type: String
  • MaxLength: 1024
Suffix Specify the suffix text to be applied to the counter value.
  • Field Name: Counter Settings.suffix
  • Type: String
  • MaxLength: 1024
Numeric Precision Specify numeric precision to be used for the counter value
  • Field Name: Counter Settings.numericPrecision
  • Type: Integer
Factor Specify factor to be multiplied to the counter value
  • Field Name: Counter Settings.factor
  • Type: Number
Default Value Specify a default value to show in case no data is returned.
  • Field Name: Counter Settings.defaultValue
  • Type: Any
Empty Group Text Text will be used when group name is empty.
  • Field Name: Counter Settings.emptyGroupText
  • Type: String
  • MaxLength: 1024
Renderers Specify renderers
  • Field Name: renderers.[n]
  • Type: Array
Field Name Specify field name.
  • Field Name: Counter Settings.renderers.[n].ruleName
  • Type: String
  • MaxLength: 1024
Display in Title Display the field's data in title? Default: True
  • Field Name: Counter Settings.renderers.[n].showName
  • Type: Boolean
  • Default: True
Drilldown Options Group Assigned by FDP
  • Field Name: Drilldown Options
  • Type: Object
Drilldown Settings Drilldown Settings
  • Field Name: drilldowns
  • Type: Object
Filter Options Specify Filter option Default: IN
  • Field Name: Drilldown Options.drilldowns.filterOption
  • Type: String
  • Default: IN
  • MaxLength: 1024
  • Choices: ["IN", "REGEX"]
Drilldown Options Specify Drilldown option Default: 0
  • Field Name: Drilldown Options.drilldowns.drilldownOption
  • Type: Integer
  • Default: 0
  • Choices: ["None", "Filter Other Widgets", "Link to Another Dashboard", "Launch Third-Party URL", "Conditional Drilldown"]
Dashboards Specify Dashboard ID
  • Field Name: Drilldown Options.drilldowns.dashboardId
  • Type: String
  • MaxLength: 1024
  • Choices: []
Third-Party URL Specify Third-Party URL
  • Field Name: Drilldown Options.drilldowns.url
  • Type: String
  • MaxLength: 1024
Conditional Drilldown Specify Json Conditional Drilldown Configuration
  • Field Name: Drilldown Options.drilldowns.jsonConf
  • Type: String
  • MaxLength: 1024
Drilldown Fields Specify Drilldown Fields
  • Field Name: drilldownFields.[n]
  • Type: Array
Field Name Specify field name
  • Field Name: Drilldown Options.drilldowns.drilldownFields.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []