Add Help Text to Workflow Forms

 Take Control

   Estimated Read Time: 6 minutes

---

Sections in this article:

• Labels
  • Field Labels
  • Phase Labels
• Descriptions
  • Phase Descriptions
  • Section Descriptions
  • Field Descriptions
• Tooltips
  • Tooltip Text
  • Tooltip Links

---

 

There are various types of help text that you can add to sections and fields within workflow forms. This provides guidance and context to users as they complete the form:

These can be configured by clicking on a phase to edit it, then navigating to the Form section:

Labels

Form sections automatically use the section name as the label. However, form fields and phases can have customised labels.

Field Labels

By default, form fields display the same names used in the repository. However, you can change these to show a different label to form submitters.

The label will appear on the form above the input box, instead of the field name:

Phase Labels

You can also change the label for an entire phase. To do this, click on the phase to edit it, then enter a label.

Descriptions

Descriptions are available for phases, form sections and form fields. It is possible to add up to 2,000 characters to a description.

Phase Descriptions

To add a description to a phase:

1. Click on the relevant phase to edit it.
2. Enter a header if required, then enter a description and use the toolbar to apply formatting.
   
3. Select the relevant radio button to determine how the description will display within workflow cards:
   1. Hide: The description will not be visible within workflow cards.
   2. Above: The description will appear above the form:
      
   3. Sidebar: The description will appear as a tab in the sidebar:
      

Section Descriptions

To add a description to a form section:

1. Click on the start phase to edit it.
2. From Form, click the pencil icon on the relevant section to edit it.
3. Enter a description, then select the Display Description checkbox.
   
4. Click Save to confirm your changes.

This will appear underneath the section name for users completing the form:

Field Descriptions

To add a description to an individual form field:

1. Click on the start phase to edit it.
2. From Form, expand the 3 dots on the relevant field, then click the pencil icon.
3. Enter a description, then select the Display Description checkbox.
   
4. Click Save to confirm your changes.

This will appear underneath the form label for users completing the form:

 

Tooltips

Tooltips are only available for form fields. A blue icon appears next to the field label, and when a user hovers over it, the tooltip text is displayed.

Tooltip Text

To configure tooltip text: 

1. Click on the start phase to edit it.
2. From Form, expand the 3 dots on the relevant field, then click the pencil icon.
3. Enter the tooltip in the Text field.
   
4. Click Save to confirm your changes.

Tooltip Links

You can include a link in a tooltip. If a link is added, it will appear after any tooltip text. The link will be underlined, clickable, and will open in a new tab for the user.

To configure a tooltip link: 

1. Click on the start phase to edit it.
2. From Form, expand the 3 dots on the relevant field, then click the pencil icon.
3. Enter the URL in the Link field.
4. Enter a label for the link in the Link Text field. If no link text is entered, the link will not appear in the tooltip.
   
5. Click Save to confirm your changes.