This article explains how to add Guidance Text (instructional text displayed to users on a module form field to help them complete the field accurately) to fields on Assure main system module forms. Guidance Text can be configured to display as a Pop-up (shown when the user hovers over an information icon) or as Static text (permanently visible next to the field). Configuration is performed via Caption Maintenance (the Assure configuration area that controls which fields are visible, labelled, and behave in a particular way on module forms), accessed through Module Setup in Settings.
This article applies to the Assure main system only. Any module that supports Caption Maintenance can have Guidance Text added to its form fields, including the Incident Record, Activity Risk Assessment, and others.
Prerequisites
- Role required: System Administrator, or a user with the Manage Caption Maintenance and Manage Module Settings Supervisor Privileges.
- Access required: Settings menu access in Assure.
- System location: Assure web application (main system only).
Steps
Step 1: Navigate to Module Setup
In Assure, navigate to Settings > System Configuration > Module Setup.
Step 2: Open Caption Maintenance for the Target Module
Locate the module you want to configure in the list (for example, Incident Record or Activity Risk Assessment).
Click the Menu Cog icon on the right side of the module row.
From the dropdown menu, select Captions.
The Caption Maintenance screen opens, displaying all field captions currently configured for that module.
Step 3: Create a New Caption Record
On the Caption Maintenance screen, click the New Record button.
The new caption configuration form opens.
Step 4: Select the Field and Enter Guidance Text
In the Property Name dropdown, select the field to which you want to add guidance (for example, "Description" or "Location").
In the Guidance Text field, enter the guidance message you want users to see.
In the Guidance Text Display field, select how the guidance should appear:
- Pop-up: The guidance displays when the user hovers their mouse over the 'i' icon next to the field label.
Static: The guidance text appears permanently next to the field at all times.
Step 5: Save the Configuration
Click Save and Close.
The Caption Maintenance screen refreshes and the newly configured field appears in the list.
Users will now see guidance text when completing the relevant field on the form.
Display Behaviour
Pop-up Guidance
When Pop-up is selected, an 'i' icon appears next to the field label. The guidance text displays when the user hovers their mouse over the icon.
Static Guidance
When Static is selected, the guidance text appears permanently next to the field on the form, visible at all times without any user interaction required.
Notes
- Guidance Text can be added to any field available in the Property Name dropdown for the selected module.
- Guidance Text configured in Caption Maintenance applies immediately. No system restart is required.
- Changes to Caption Maintenance apply system-wide across all Organisational Units for the selected module.
- Guidance Text is separate from making a field mandatory. Both settings can be applied to the same field at the same time.
- This configuration applies to the Assure main system only. For guidance text on fields in AssureGO+ Questionnaire forms, the guidance text must be configured separately within the relevant Questionnaire field configuration.
AI Metadata
Product Area: Assure Main System -- System Configuration, Module Setup, Caption Maintenance
User Role: System Administrator; users with the Manage Caption Maintenance and Manage Module Settings Supervisor Privileges
Tags: Caption Maintenance, Guidance Text, Module Setup, System Configuration, Field Configuration, Popup Guidance, Static Guidance, Incident Record, Activity Risk Assessment, Form Fields, Assure
Version/Region: All Assure versions; all regions
Important synonyms:
- Guidance Text = field guidance, inline help, field hint, tooltip
- Caption Maintenance = Captions, Field Configuration, Module Captions
- Module Setup = System Configuration, Module Configuration
- Pop-up Guidance = popup tooltip, hover guidance, 'i' icon help
- Static Guidance = inline guidance, permanent guidance text
- Property Name = field name, field selector
Suggested embedding keywords: add guidance text assure, caption maintenance guidance, field guidance text module setup, popup guidance assure form, static guidance text field, how to add help text to a form field assure, configure field guidance assure, guidance text incident record assure, caption maintenance field help, assure form field instructions
Relevant modules and cross-module implications: This configuration is performed within Module Setup under System Configuration and applies to any Assure module that supports Caption Maintenance, including Incident Record, Vehicle Incident Record, Activity Risk Assessment, Job Hazard Analysis, Audit, Hazard Spotting, and others. Configuration must be repeated per module as Caption Maintenance settings for one module do not carry over to another. For Guidance Text to appear within AssureGO+ Questionnaire forms, the guidance must be configured separately within the relevant Questionnaire field settings (Settings > Portal > Questionnaire > Sections > Fields).