Create a Module

Learn how to create a new custom module in PEARS using the Module Builder.

This article walks through the steps to create a new custom module in PEARS. Once created, the module appears in the navigation menu you select and is available for your organization's users to fill out.

1

Navigate to Module Builder

Click Module Builder in the top navigation sidebar to open the Module Builder list page.

2

Click Add Custom Module

Click the Add Custom Module button to open the new module dialog.

Screenshot: The Add Custom Module dialog showing the Start with a Template dropdown, Module Name field, Module Identifier field, Menu Location radio buttons, and Save button

TIP: To create a reusable template instead of a module, click Add Template. See Module Templates for details.

3

Enter a Module Name

In the Module Name field, enter a display name for the module (up to 50 characters). This name appears in the navigation menu and on the module's landing page.

4

Enter a Module Identifier

In the Module Identifier field, enter a unique slug for the module (up to 27 characters). The identifier must contain only lowercase letters, numbers, and underscores. It is used in data exports and cannot be changed after responses have been collected.

NOTE: Choose the module identifier carefully. It serves as the internal key for the module's data and appears as a column prefix in exports. Changing it later may require a data migration.

5

Select a Menu Location

In the Menu Location field, select where the module appears in the PEARS navigation:

• Plan — The module appears under the Plan menu.

• Engage — The module appears under the Engage menu.

• Reflect — The module appears under the Reflect menu.

6

Start from a Template (optional)

If your organization has module templates available, you can select one from the Start with Template dropdown. The template's sections, fields, and options are copied into the new module as a starting point.

7

Create the Module

Click Create to create the module. PEARS creates the module with an initial draft version and redirects you to the Module Setup page.

GLOSSARY: Module Builder Terms

• Module — A custom form created by your organization for collecting data in PEARS.

• Module Identifier (Slug) — A unique internal key used in exports and data storage. Contains only lowercase letters, numbers, and underscores.

• Module Version — A snapshot of a module's form structure. Each module can have one live version and one draft version at a time.

• Template — A reusable module design that can be used as a starting point when creating new modules. Templates do not appear in navigation menus.

Generate a Module with AI

If your organization has AI tools enabled, you can generate a module using a conversational AI planner that helps you design the module step by step.

1

Click Generate Module with AI

On the Module Builder list page, click the Generate Module with AI button to open the AI planner.

2

Describe what you need

In the chat interface, describe the module you want to create. For example: "I need a form for tracking youth program attendance with participant name, age group, attendance date, and program type."

The AI may ask clarifying questions to better understand your needs — for example, which fields should use dropdowns versus free text, or whether certain data should be tracked in a subform. Answer the questions or click Skip to let the AI use its best judgment.

3

Review the plan

The AI generates a plan showing the proposed module structure, including sections, fields, field types, and response options. Review the plan to confirm it matches your needs.

• To request changes, type your feedback in the chat (e.g., "Add a notes field to the first section" or "Change age group to a radio group instead of a dropdown").

• The AI revises the plan and shows an updated version. You can refine the plan as many times as needed.

4

Build the module

Once you are satisfied with the plan, click Create Module or confirm in the chat (e.g., "Looks good!"). The AI suggests a Module Name and Module Identifier which you can edit before building. PEARS creates the module and redirects you to the Module Setup page.

TIP: AI-generated modules are drafts. Review the form structure in the form builder before publishing.

Next Steps

After creating a module, proceed to Module Setup to configure the module's details, then use the form builder to design the form.