4.4.4 Displaying hint messages

This function allows you to display hint messages for each input field in the workflow details window.

(Figure) Displaying hint messages

(Figure) Displaying hint messages (Figure) Displaying hint messages

A question mark icon appears in input fields for which hint messages are set.
When the question mark icon is clicked, the hint message appears. When any other part other than the hint message is clicked, the hint message disappears. The location where the question mark icon appears depends on the type of the input field. See “(Table) Component fields supporting hint messages”.

Hint messages that can be displayed have the following characteristics.

  • Number of characters: 1 to 4096
  • Number of characters per line: 40 to 50 (When this number is exceeded, the message will wrap around)
  • Can be copied and pasted.
  • Cannot contain hyperlinks.
  • Displayed even when the field is disabled.

This function can be configured using the hintMessage label in the YAML file for the UI (UI version 1.1). For details, see “UI (UI Version 1.1)”.

[Supported components and fields]

Hint messages can be set for the following components and fields.

(Table) Component fields supporting hint messages

Component Field type Display position
Form Checkbox Right side of the field
Rich text editor* Right side of the label
Other Left side of the field
Paper Right side of the label
Attachment Right side of the label
*You can display the rich text editor in the following ways.
  • components.properties.fields.source: table(UI YAML file):
    If the YAML file for the datamodel for Include has a column setting of type: text
  • components.properties.fields.source: schema(UI YAML file):
    In the YAML file of the datamodel for Include, if the following is set as the field setting in the JSON schema file specified in schemas.file
    • type: String or number
    • formControl: text
For details on the YAML definition, see "UI (UI Version 1.1)" and "Datamodel", and for details on the JSON schema file settings, see "(Table) Relationship between field types and setting values".