Provide instructions or guidance to end users on a Step

How to provide instructions or guidance to your End Users with two methods 

Overview

You can provide your end users instructions or guidance on a how to fill out a form in a Step in two ways: 

1. Rich Text Sections 
2. Subsection Guidance
3. Field Level Guidance

4. Default Text in Text Area Fields (only visible on any newly created Records)

Method 1: Rich Text Sections

Rich Text Sections can be used to provide context on to a record, link to other related materials, or provide instructions to end users.

To add a Rich Text Section in a Step, navigate to the Step Builder and click Add Form Section. Click </> Add Rich Text Section located at the bottom right of the new Section. 

When viewed by an end user, a Rich Text Section looks like this: 

When to use Rich Text Sections

Rich Text Section are ideal for displaying information related to the entire record - for example, why the user is completing this record, what happens after the record is submitted, who to contact with questions, etc.

Method 2: Subsection Guidance

The March 2024 release includes a rich text field under every subsection header that can store read-only guidance. This feature can benefit end users by:

1. Positioning guidance closer to the relevant fields, eliminating unnecessary scrolling and confusion
2. Eliminating duplicate section headings on the outline, providing a cleaner, easier-to-use navigation panel

To access, navigate to the step builder, and click the "Add Subsection Guidance Button:"

This will open a new rich text field where the builder can enter information:

Text will auto-save and be displayed on the record page:

When to use Subsection Guidance

Subsection Guidance is ideal for displaying information related to a specific subsection in the record - for example, if a user needs to reference a risk scoring table. The risk scoring table may not be relevant to questions in a different part of the form, but they help the user make an informed decision for the field in the corresponding subsection.

Method 3: Field Level Guidance

RiskCloud allows users to enter Guidance on the field. To display this information, the builder can populate the 'Guidance Text' field on the 'Edit Field' modal:

This will be displayed on the record page:

When to use Field Guidance

Field Guidance is useful for explaining information that will help an end user enter correct information in a given field.

Method 4: Default value in Text Area Fields

Guidance or instructions can be provided to end users by entering a default value in Text Area Fields. To do this, first create a new Text Area Field from the Workflow Fields section in the Step Builder. Fill out the Name and Label for the Field (the example below has Guidance as the name and label). 

Navigate to the Default tab. Enter appropriate text as the default value under the "Preview" section and click Save Field. 

Add your newly created Field to the relevant Subsection. Make sure to toggle the Field to Read-Only.

When viewed by an end user, a Text Area Field with a default value will look like this: 

Note: The Text Area Field will not display Default Value text on existing Records. Only new Records will display the text.