Setting the [Description] in a Data Item’s properties displays it as a note below the corresponding Data Item on the input form. It is used to help the Operator with input by presenting input examples and criteria for judgment.
[Description] is a setting common to all data types. Input is in Markdown format, and HTML can also be written within Markdown syntax.
Capture
Settings Screen
Input Screen
Notes
- [Description] is a setting common to all data types
- [Description] is displayed when the Data Item’s editability is set to [Editable]. It is not displayed for Data Items set to [Display Only]
- If you only want to display an explanation without users entering a value, use a Guide Panel type Data Item
- For Guide Panel type, the [Description] itself becomes the panel’s displayed content. There is no [Editable] option; it will be displayed when set to [Display Only]
- The [Description] field accepts input in Markdown format (R1020, R1021)
- The [Preview] shows the rendered result of the text written in Markdown
- HTML can also be written within Markdown syntax
- There are restrictions on which HTML elements can be used (R2131)
- The [Description] field supports more HTML elements than [String (Markdown)] or the [Work Manual]
- On workflow platforms with a Professional edition subscription, the [Description] field supports
<script>elements and<button>elements with theonclickattribute. This is what enables writing JavaScript (R2131)- Use the “Questetra Form JavaScript API” to get/set input field values and register event handlers
- Display changes and data communication using JavaScript are configured at your own risk
- Examples such as simplified input via button clicks, switching display based on choices, and custom input validation are introduced in “Processing Screen Decoration“
- The examples introduced have only undergone basic functional testing and are not guaranteed to work in all environments. They may also stop working due to product version upgrades
