Module Builder

Create custom data collection modules with a visual form builder in PEARS.

The Module Builder allows organization administrators to create custom modules for collecting data specific to their organization's needs. Custom modules appear alongside standard PEARS modules in the Plan, Engage, or Reflect navigation menus.

Permission required: Organization administrator

Getting Started

To access the Module Builder, click the cog icon in the top navigation bar and select Module Builder. The list page displays all custom modules and templates for your organization.

Screenshot: The Module Builder list page showing custom modules organized by menu location (Plan, Engage, Reflect) with their statuses, plus the Add Custom Module and Add Template buttons

How It Works

Each custom module is a form that users in your organization fill out to record data. The Module Builder provides a visual interface for designing these forms — you define the sections, fields, response options, and conditional logic that make up the module.

Modules follow a versioned workflow. Each module can have one live (published) version and one draft version at a time. This allows you to update a module's form structure without disrupting users who are actively entering data on the current version.

Workflow Overview

1

Create

Create a new module by providing a name, identifier, and menu location. Optionally start from an existing template.

2

Set Up

Configure the module's display name, introduction, and version notes on the Setup page.

3

Build

Design the module's forms using the visual form builder. Add sections, fields, response options, and conditional logic.

4

Test

Preview the module to verify the form works as expected before publishing.

5

Publish

Publish the module to make it available to users, or schedule it for a future date.

Module Detail Page

After a module is created, its detail page provides an overview of the module's status, response activity, and management options:

Screenshot: The module detail page showing the status card, response summary, permissions, version history, and recent response activity

• Status — Shows whether the module has a live version, a draft in progress, or a scheduled publish date.

• Total Records and Unique Users — Show how many records have been entered and how many users entered them.

• Permissions — Shows who can view response data. Change it with Configure Permissions in the Actions menu. The options are:

  • The creator and users with extended permissions, such as data managers. This is the default.

  • All users in the organization.

  • The creator and their supervisor only.

• Previous Versions — Lists the module's earlier versions and their record counts.

• Recent Response Activity — Lists the most recent record activity for the module.

• Archive — Archive a module from the Actions menu to remove it from the navigation menus. Existing data is preserved.

TIP: Every module includes a Collaborators section by default, and a record's collaborators can view it under any of these permission options. To restrict them, remove the Collaborators section from the module's form.

Additional Features

• Copy a Module — Duplicate an existing module or template.

• Module Templates — Create reusable templates that serve as starting points for new modules.

• Manage Module Versions — Create new versions and migrate response data between versions.

• System Codes — Tag fields and response options with standardized codes so PEARS can summarize data consistently across modules.