widget contactSurveys
Surveys widget documentation
Available properties
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
cardAlign |
This sets the widget card row alignment (top | center | bottom | none) |
none |
top | center | bottom | none |
|||
dataSet |
The name of dataset which will be used to resolve incomplete vpath |
|||||
description |
Description (widget header) |
|||||
exportable |
This activates the possibility for the user to download the widget content as a Microsoft Excel (.xslx) file. |
true |
true | false |
|||
headerNumberOfLines |
Here you define the number of lines of text that are to be used for the table header |
1 |
||||
hide |
Hide item |
true | false | pdf | web |
||||
hierarchy |
Hierarchical field (vpath) - a field to define parent-child relations when building hierarchy (example - accounts:ParentAccountID) |
|||||
hierarchyColumn |
When the property "hierarchy" is enabled, the property "hierarchyColumn" sets the identifier of the hierarchical column. The expand/collapse arrows for the hierarchy will be displayed in this column. |
|||||
hierarchyFilters |
A list of filter names to ignore for the columns with the filterable property set to false. |
|||||
hierarchyView |
When the property "hierarchy" is enabled, the property "hierarchyView" specifies whether the table is to use hierarchical view instead of flat view. |
true |
true | false |
|||
ignoreFilters |
A list of filter names to ignore. Container name can be used to ignore group of filters (e.g name of layout area) |
|||||
ignoreFiscalCalendar |
This allows you to use standard calendar instead of fiscal one |
true | false |
||||
ignoreWeights |
Use this property to specify any weights that have been defined but are to be ignored at this time. If the list contains multiple items, separate the items with comma. |
|||||
inHierarchy |
This must be a vpath expression. This property influences how the primary key filter is applied based on url parameters. If this property is not specified then only entries with the exact primary key match will be displayed. If it is specified then entries with the exact primary key match, and entries which match the primary keys of all children of the related record, will be displayed in the list. |
|||||
label |
Label (widget header) |
|||||
navigateDirectNodeTo |
Input the name of the page that is to be navigated to when the user clicks the direct node link. |
|||||
navigateTo |
Page to navigate to or a cross-document link entity |
|||||
paginationType |
Specifies pagination type for table. |
infiniteScroll |
infiniteScroll | paging | none |
|||
record |
The name of the filters for individual record selection |
|||||
rowsPerPage |
Specifies the number of rows per page options available for the pager select (the list of integers, e.g. 20, 30, 40). Applied with paginationType = paging. |
20,50,100 |
||||
showCodeLabelSelector |
false |
true | false |
||||
showCountInLabel |
true |
true | false |
||||
showHeader |
Specifies whether the column header is to be displayed. |
true |
true | false |
|||
showInvalidAnswerCodes |
Specifies whether invalid answers codes are to be displayed. |
false |
true | false |
|||
showTotals |
Specifies whether or not the totals row for the table is to be displayed. To redefine the default formula for a specific column, you can specify the custom totalExpression property for that column. |
false |
true | false |
|||
showWidgetHeader [Beta] |
Shows widget header. True by default. |
true | false |
||||
size |
This defines the size of the widget when it is displayed on the Dashboard. |
small |
small | medium | halfwidth | large |
|||
skip |
The number of items (starting from the first item) that are to be ignored when fetching data. |
0 |
||||
sortColumn |
Specifies which column the list is to be sorted by. Input the column ID. |
|||||
sortOrder |
Specifies the sorting order for the list. |
ascending |
||||
stretchColumns |
Here you can specify that any columns without a defined width are to be stretched such that the table fills the entire table width |
false |
true | false |
|||
table |
The name of the table (alias) for the widget to work with |
|||||
take |
The number of items to be fetched for one request. |
20 |
||||
useOnlySources |
This defines the sources used by the widget to fetch data from. |
|||||
useWeights |
This property holds a list of the weights that are to be used by default. |
|||||
via |
Table(s) for join path conflict resolution |
|||||
viaStrategy |
Join path conflict resolution strategy |
default | shortest |
||||
widgetVariant [Beta] |
Widget variant |
default | subtle | emphasised |
Available objects
Name | Description | |||
---|---|---|---|---|
Selector allows you to select option and exposes property 'selected' which can be referenced from any place |
||||
This is a set of rules used to limit access to particular resources (a page, a widget etc). The rules are joined by logical AND, meaning all the rules must be true for the resource to be shown. |
||||
This is widget documentation; information about the widget that is provided by the dashboard designer to the end report viewer. This allows the designer to add custom content for the widget "info" to provide the user with information necessary to understand the visualisation, type of analysis performed, data, etc. for example details about the risk model applied in the Risk assessment. |
||||
The Toolbar widget is typically used to highlight key information in a simple text format and a selector. |
||||
Suppression criteria for a widget |
||||
Options for optimization |
||||
Expression filter |
||||
This allows variables for a date filter to be redefined |
||||
This allows a level for a filter to be redefined |
||||
Changes the reporting period from default / selected in the filter to different one |
||||
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one |
||||
Changes applied filter to to different one |
||||
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered |
||||
This object defines a standard way of displaying a value column. You can override the formatting to change the look and feel as required by adding properties. You can add as many columns as required; each must have a unique name. |
||||
This object provides a standard way of displaying a value icon column. You can override the formatting to change the look and feel as required. |
||||
This object defines a standard way of displaying an icon column. You can override the formatting to change the look and feel as required. |
||||
This object provides a standard way of displaying a link. You can override the formatting to change the look and feel as required. |
||||
This object provides a standard way of displaying a currency. The default is $ in short-form; you can override the formatting to set up the look and feel as required by adding properties. You can add as many columns as required; each must have a unique name. |
||||
This object adds a hierarchy column that is filtered by default to only show the parent Level of the hierarchy; the child levels are collapsed. It adds an expand button to allow the user to toggle between the hierarchy and the flat views. Note that the data must be in the form of a hierarchy, and the widget must have the hierarchy property set. |
||||
This object provides a standard way of rendering column with formatted date value. The default date formatter applied to this column displays dates in short-form e.g. "17 Jan '17".
You can override the default formatting to change the look and feel as required by specifying a custom value for the |
||||
This object defines a standard way of displaying a metrics column. You can override the formatting to change the look and feel as required by adding properties. You can add as many columns as required; each must have a unique name. |
||||
This defines the column in which the percentage of surveys that are completed is presented. |
||||
This object provides a standard way of displaying a 'value with details' column. You can override the formatting to change the look and feel as required. |
||||
This object adds a column containing a colored bar for each row in the table, which indicates the current expiry status for that row. E.g. gray for unexpired, orange for nearing expiry, and red for expired. |
||||
The response column is a mandatory column type for the recent responses widget. Note that it can also be used in other table-like widgets. A column cell has a configurable header and footer, and a content Block. |
||||
This object contains a set of actions which will be displayed differently depending on whether or not the report is being displayed on a mobile device. |
||||
A default view settings for displaying value with a toggle arrow to show or hide details |
||||
This is a preset view configuration for displaying multi-line text, which by default has 3 lines. This view is available as defaultCommentView when you specify the view for a column. You also may define your own view based on this one to redefine default settings. You can have multiple view_comment objects in a report; each object must have a unique name. |
||||
This block defines icon view settings. You can use this configuration block to redefine default icon view settings. |
||||
This block defines icon view settings. You can use this configuration block to redefine default icon view settings. |
||||
A preset view configuration for displaying a progress bar to track the current date related to the expiry date. Note that this property will normally be unnecessary unless you want to redefine some default settings. |
||||
This is a preset type of view that allows you to style an item or text in a tile with cascading style sheets (CSS) using |
||||
This item creates a colored tile with a centered, colored digit of predefined width inside it. The tile is used to present metric data, and includes an arrow (up or down) or a flat icon located to the right of the digit to indicate how the value has changed from the previous period. |
||||
A view that renders link (does not apply any wrapping) |
||||
This item creates a colored tile with a centered, colored digit of predefined width inside it. The tile is used to present metric data, and includes an arrow (up or down) or a flat icon located to the right of the digit to indicate how the value has changed from the previous period. |
||||
value item |
||||
This view renders HTML. |
||||
select
Selector allows you to select option and exposes property 'selected' which can be referenced from any place
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
applyOnEvent [Beta] |
This property buffers changes to the local state of the select. Changes are not applied directly to the model, but are stored and only applied when a specified event occurs. |
|||||
background |
Set the background of the select; currently this only supports transparent as an option |
transparent |
||||
compareBy [Beta] |
This property allows the selection check in the selector to be based on any option’s property, instead of the default value. By setting compareBy to this.label or this.id, you can customize the attribute used to determine which option is selected. |
|||||
defaultOption |
Use this property to set default option for select |
|||||
delay [Beta] |
Sets the number of milliseconds to wait before applying the selector, effective in 'multi' mode |
|||||
label |
Label of selector |
|||||
mode |
Use this property to switch select type from single-choice to multi-choice |
multi | single |
||||
onDefaultChange |
Use this property to change behavior of selector when defaultOption is changed dynamically |
reset | resetAndApply |
||||
options |
List of options, consist of entities with mainType 'item' and properties 'value' and 'label' |
|||||
preserveState [Beta] |
This property determines whether the previous selection will remain when the select is shown again. If set to true, the previous selection will persist each time the select is made visible. |
true | false |
||||
resetOnEvent [Beta] |
This property resets the state of the select even if it’s buffered. |
|||||
selected |
Selected option value, it is set by system automatically, depends on user choice |
|||||
selectedProperty |
Entity with properties of entity within value, it is set by system automatically, depends on user choice |
|||||
An action that allows setting a specific option in a selector. |
||||||
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard |
||||||
An action that closes modal |
||||||
View resembling a table with customizable columns and selectable rows |
||||||
Selector, that looks like list of checboxes or radiobuttons |
||||||
Selector, that looks like tabs |
action setSelector
An action that allows setting a specific option in a selector.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
compareBy [Beta] |
This property allows the selection check in the selector to be based on any option’s property, instead of the default value. By setting compareBy to this.label or this.id, you can customize the attribute used to determine which option is selected. |
|||||
select |
A reference that specifies the select entity in which the option should be selected. |
|||||
value |
Specifies the value of the option to be selected. |
toolbar
The Toolbar widget is typically used to highlight key information in a simple text format and a selector.
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
A button located within the widget’s toolbar |
button
A button located within the widget’s toolbar
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
||||||
A menu option that opens upon clicking, which |
||||||
An action that navigates to other page |
||||||
An action that allows setting a specific option in a selector. |
||||||
An action that can open infobox with defined text and header |
||||||
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more |
||||||
An action that enables the sending of a command capable of triggering various logic in different parts of the dashboard |
||||||
An action that closes modal |
option
A menu option that opens upon clicking, which
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
label |
||||||
An action that navigates to other page |
||||||
An action that can open infobox with defined text and header |
||||||
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more |
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateTo |
Page to navigate to or a cross-document link entity |
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
info |
||||||
label |
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
format |
Specifies the desired format for the exported file |
png |
png | default |
action navigate [Beta]
An action that navigates to other page
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
navigateFilter |
Formula or question ID / alias |
|||||
navigateHistory |
Keep previous navigation filters |
false |
true | false |
|||
navigateTo |
Page to navigate to or a cross-document link entity |
action showInfobox [Beta]
An action that can open infobox with defined text and header
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
info |
||||||
label |
action export [Beta]
An action that can be initiated by either clicking a button or selecting a menu option. It encompasses various types of actions, including navigation, exporting, and more
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
format |
Specifies the desired format for the exported file |
png |
png | default |
suppressRule
Suppression criteria for a widget
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
criteria |
Expression used to evaluate suppression |
|||||
label |
Text showed in case of suppression |
overrideFilter date
This allows variables for a date filter to be redefined
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
dateVariables |
This property defines data fields for the date filter |
|||||
level |
This property specifies a level which selection in filter should be applied to |
|||||
name |
This property specifies the name of the filter that is to be redefined |
|||||
via |
This property specifies an intermediate level to be used to join not directly related levels: level at which filter is defined and level where filter should be applied to |
overrideFilter level
This allows a level for a filter to be redefined
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
level |
This property specifies a level which selection in filter should be applied to |
|||||
name |
This property specifies the name of the filter that is to be redefined |
|||||
via |
This property specifies an intermediate level to be used to join not directly related levels: level at which filter is defined and level where filter should be applied to |
scope reportingPeriod
Changes the reporting period from default / selected in the filter to different one
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
applyTo |
References to attribute of date variable from dataSet, if omitted then date variables apply for are not changed |
|||||
period |
Defining a new reporting period |
AllData | YoY | Previous | Current |
scope reportingHierarchy
Changes the reporting hierarchy nodes to be used from default/selected in filter to different one
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
mode |
Changes the reporting hierarchy mode |
direct | rollup |
||||
nodeIds |
Changes the reporting hierarchy nodes from default / selected in the filter to particular nodes |
|||||
nodes |
Changes the reporting hierarchy nodes from default / selected in the filter to different one |
AllData | ParentsFromTop | ParentsFromCurrent | Roots | Children | Base |
||||
reportingHierarchy |
Reporting hierarchy name |
scope filter
Changes applied filter to to different one
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
name |
Defining a scope filter name |
|||||
value |
Defining a scope filter value |
propagateFilter
This action requests Data Engine to automatically apply a filter to a dependent (target) level when a source level is filtered
Name | Description | Default value | Available options | |||
---|---|---|---|---|---|---|
dropOriginal |
This flag allows to skip apply of the filter on 'source' level |
false |
true | false |
|||
from |
A level reference specifying the source level |
|||||
to |
A level reference specifying the target level |