Skip to main content

What’s New

Qrvey 8.7
Version 8.7 of the Qrvey platform is now available to customers! This version includes new features including area charts, the ability to pivot and export data, as well as numerous bug fixes and performance improvements.
Learn More
Qrvey 8.6
Version 8.6 of the Qrvey platform is now available to customers. This version includes several new feature enhancements and performance improvements.
Learn More
Required Update for 8.5.1
Attention 8.5.1 customers: for any 8.5.1 instance deployed prior to 08/05/2024, an update is required to ensure you are running the latest images.
Learn More
Qrvey 8.5
Version 8.5 (LTS) of the Qrvey platform is now available to customers. This version includes several new features and performance improvements.
Learn More
End-of-life Schedule
We've added a new article that lists the features and endpoints that have been scheduled for deprecation. All features and endpoints will be supported for (1) year after the release date of the LTS version that contains the alternative.
Learn More
Version: 8.7

Custom Tokens

The Bullet Chart and Dial Chart support the use of custom tokens to set threshold values. Custom tokens are based on individualized criteria and are set dynamically each time the widget is rendered.

To create a custom token, use the customTokens property in the Dashboard Builder or Dashboard View widget configuration object. Enter key-value pairs. Use either the basic syntax or expanded syntax.

Basic Syntax

In basic syntax, provide key-value pairs using the following syntax:

"customTokens": {
"key1": "value1",
"key2": "value2"
}

For example:

"customTokens": {
"numericKey": 42.6,
"dateTimeKey": "2023-08-14 10:12:32",
"textKey": "some Text"
}

The tokens display in Qrvey Composer in the following format:

{{customTokens.key}}

Continuing the example above, the tokens display as follows:

{{customTokens.numericKey}}
{{customTokens.dateTimeKey}}
{{customTokens.textKey}}

Expanded Syntax

The expanded syntax of customTokens supports grouping and labels. In expanded syntax, use the following attributes:

  • key: the name of the token
  • label: the label displayed in the token suggestion box
  • value: the value

Use the following syntax:

"customTokens": {
"tokenGroupLabel": [{
"key": "token 1 key",
"label": "token 1 label",
"value": "token 1 value"
},{
"key": "token 2 key",
"label": "token 2 label",
"value": "token 2 value"
}
]
}

For example:

"customTokens": {
"customGroup": [{
"key": "someNumber",
"label": "some Number",
"value": 42.6
},{
"key": "someDateTime",
"label": "some {{DateTime}}",
"value": "2023-08-14 10:12:32"
},{
"key": "someText",
"label": "some . Text",
"value": "This is a sample text"
}
]
}

The tokens display in Qrvey Composer in the following format:

{{customTokens.tokenGroupLabel.key}}

Continuing the example above, the tokens display as follows:

{{customTokens.customGroup.someNumber}}
{{customTokens.customGroup.someDateTime}}
{{customTokens.customGroup.someText}}

Apply a Custom Token to a Chart

After the customToken property is added to the Dashboard Builder or Dashboard View configuration object, it is ready to use in a chart:

  1. Open the embedded Dashboard Builder widget and create or edit a dashboard.

  2. Open Chart Builder to add a Bullet chart or Dial chart.

  3. Expand the Thresholds section and click Add Threshold.

  4. Select Fixed.

    Threshold Fixed

  5. Set a Color, Label, and Operator in the fields provided.

  6. In the Value field, enter {{. A suggestion box displays.

  7. Continue typing the name of the custom token until it displays in the suggestion box.

  8. Select the custom token.