Articles in this section

See more

Module Setup

  • Updated

Summary:
This article explains how to configure individual modules within Assure by managing settings, captions, reports, and search columns. It is used by system administrators and users with appropriate permissions to customize module behaviour, change field labels, control report outputs, and define quick search fields.

Prerequisites

  • User must have access to Settings → System Configuration → Module Setup
  • User must have appropriate system permissions (typically Administrator or System Configurator role)
  • Access to the Assure platform (web application)
  • Familiarity with the module structure and form fields in Assure

Problem/Intent

Users need to customize modules in Assure to:

  • Change field labels (captions) to match organizational terminology
  • Configure automatic review schedules and patterns for compliance tracking
  • Control which reports are available and set default report output formats
  • Define which fields appear in the Quick Search functionality for faster data retrieval

This is essential for tailoring the system to organizational needs, improving user experience, and ensuring compliance workflows are correctly configured.

Steps

Accessing Module Setup

  1. Log in to the Assure platform.
  2. Navigate to Settings in the main menu.
  3. Select System Configuration.
  4. Click Module Setup.
  5. A list of available modules will be displayed.
  6. Select the module you wish to configure from the list.
  7. Choose one of the four configuration tabs: Settings, Captions, Reports, or Search Columns.

Configuring Module Settings

  1. In the Module Setup screen, select the Settings tab.
  2. Review the Automatic Reviews section to enable or disable scheduled reviews for the module.
  3. Define the Review Pattern by specifying the frequency and timing for automatic reviews.
  4. Click Save to apply the settings.

Use case: Configure automatic reviews for Risk Assessment modules to ensure assessments are reviewed annually.

Changing Module Captions

  1. Select the Captions tab within the chosen module.
  2. Click New Record to add a new caption change.
  3. In the caption editor:
    • Select the Field you wish to rename.
    • Enter the New Caption text.
  4. Click Save to store the caption change.
  5. To edit an existing caption, select it from the list and click Edit.
  6. To delete a caption change, select it and click Delete.
  7. Navigate to the module form to verify the caption change is reflected.

 

Example: Change the caption "Risk Assessment" to "Workplace Risk Assessment" in the Risk Assessment module.

Configuring Module Reports

  1. Select the Reports tab within the chosen module.
  2. Review the list of available reports for the module.
  3. To change the default output format for a report:
    • Locate the report in the list.
    • Select the desired Default Output format: Excel, PDF, Word, or Report Viewer.
  4. To customize the report name:
    • Enter a Custom Title in the provided field.
  5. Click Save to apply the report configuration.

Example: Set the default output for the "Incident Summary Report" to PDF and rename it to "Monthly Incident Report."

Configuring Quick Search Columns

  1. Select the Search Columns tab within the chosen module.
  2. The screen displays two lists:
    • Available Fields: Fields that can be added to Quick Search.
    • Current Fields: Fields currently enabled in Quick Search.
  3. To add a field to Quick Search:
    • Locate the field in the Available Fields list.
    • Click the up arrow to move it to the Current Fields list.
  4. To remove a field from Quick Search:
    • Locate the field in the Current Fields list.
    • Click the down arrow to move it back to Available Fields.
  5. Click Save to apply the search column configuration.

Example: Add "Organisation Unit" and "Status" fields to the Quick Search for the Incident module.

Notes & Warnings

  • Caption changes apply system-wide to the selected module and affect all users.
  • Automatic review settings must align with organizational compliance requirements.
  • Changing captions does not alter the underlying data structure or field names in reports or APIs.
  • Users may need to refresh their browser or log out and back in to see caption changes.
  • Only fields available in the module can be added to Quick Search.
  • Removing fields from Quick Search does not delete the data; it only hides the field from the search interface.

Examples

Example 1: Change Caption for a Field

Scenario: An organization refers to "Hazard" as "Workplace Hazard" and wants to update the Assure system to reflect this terminology.

Steps:

  1. Navigate to Settings → System Configuration → Module Setup.
  2. Select the Incident module.
  3. Go to the Captions tab.
  4. Click New Record.
  5. Select the field Hazard.
  6. Enter Workplace Hazard as the new caption.
  7. Click Save.

Result: The field "Hazard" will now display as "Workplace Hazard" throughout the Incident module.

Example 2: Configure Automatic Reviews

Scenario: Risk assessments must be reviewed every 12 months.

Steps:

  1. Navigate to Settings → System Configuration → Module Setup.
  2. Select the Risk Assessment module.
  3. Go to the Settings tab.
  4. Enable Automatic Reviews.
  5. Set the Review Pattern to "12 months."
  6. Click Save.

Result: Risk assessments will automatically be flagged for review 12 months after their last review date.

Example 3: Add a Search Column

Scenario: Users need to search for Incidents by "Organisation Unit" quickly.

Steps:

  1. Navigate to Settings → System Configuration → Module Setup.
  2. Select the Incident module.
  3. Go to the Search Columns tab.
  4. In the Available Fields list, locate Organisation Unit.
  5. Click the up arrow to add it to Current Fields.
  6. Click Save.

Result: "Organisation Unit" will now appear as a searchable field in the Quick Search for Incidents.

Troubleshooting

Issue: Caption Changes Not Appearing

Cause: Browser cache may be displaying old captions.

Resolution:

  1. Clear the browser cache.
  2. Log out of Assure and log back in.
  3. Verify the caption change in the Captions tab of Module Setup.

Issue: Unable to Add Field to Quick Search

Cause: The field may not be configured as searchable in the module schema.

Resolution:

  1. Verify the field exists in the module.
  2. Contact Evotix Technical Support or your Customer Success Manager to confirm field availability for search.

Issue: Automatic Reviews Not Triggering

Cause: Incorrect review pattern or automatic reviews not enabled.

Diagnostics:

  1. Navigate to Settings → System Configuration → Module Setup.
  2. Select the relevant module and go to the Settings tab.
  3. Check if Automatic Reviews is enabled.
  4. Verify the Review Pattern is correctly configured.

Resolution:

  1. Enable Automatic Reviews if disabled.
  2. Correct the Review Pattern and click Save.
  3. Monitor the module for review notifications.

Issue: Report Output Format Not Defaulting to Selected Format

Cause: Report configuration may not have been saved correctly.

Resolution:

  1. Navigate to Settings → System Configuration → Module Setup.
  2. Select the module and go to the Reports tab.
  3. Verify the Default Output is set to the desired format.
  4. Click Save and test the report generation.

Related Articles

Cross-Module Relevance

Applicable to: All modules within Assure (Incident, Risk Assessment, Audit, Contractor, Person Register, Equipment Register, etc.)

Explanation:
Module Setup applies universally across all modules in Assure. The process for configuring settings, captions, reports, and search columns is consistent, though the available fields and reports will vary depending on the module. This article provides a foundational workflow that spans multiple modules, ensuring consistency in system configuration and user experience.

Dependencies:

  • User permissions (Administrator or System Configurator role)
  • Module-specific field schemas
  • Reporting infrastructure (Insights or custom reports)

AI Metadata

  • Product Area: Assure - System Configuration
  • User Role: System Administrator, System Configurator, EHS Manager
  • Tags: Module Setup, Captions, Reports, Search Columns, Automatic Reviews, Configuration, Assure, Settings
  • Version/Region: Assure (all versions), applicable globally
  • Important synonyms: Module Configuration, Module Customization, Form Setup, Field Labels, Quick Search
  • Suggested embedding keywords: module setup, configure captions, change field labels, automatic reviews, report output, quick search columns, Assure configuration, system settings, module settings, form customization

 

 

Return to top

Related articles