Module Builder Guide

The Module Builder is your central hub for designing and configuring modules. This guide provides an overview of all builder tabs and links to detailed documentation for each.

Accessing the Module Builder

For New Modules

1. Go to Settings in the sidebar
2. Click Modules
3. Click Create Module
4. The Module Builder opens with your new module

For Existing Modules

1. Go to Settings > Modules
2. Find your module in the catalog
3. Click to open the builder

Or from a module's record view:

1. Click the gear icon in the header
2. Select Edit Module

Module Builder Tabs

The builder uses a tabbed interface. Here's a quick reference:

Overview Tab

The Overview tab shows at-a-glance information about your module:

Module Statistics

• Fields: Total number of configured fields
• Views: Number of saved views
• Created: When the module was first created
• Updated: Most recent modification

Record Settings

Allow Private Records

When enabled, users can create records visible only to themselves. Toggle this setting based on your collaboration needs.

Fields Tab

The Fields tab is where you define your module's data structure. Each field represents a property that records can have.

Key features:

• Add new fields with various data types
• Configure field visibility (Details, Sidebar, List)
• Set required fields and validation
• Reorder fields with drag-and-drop
• Configure field-level privacy

Learn more: Configuring Fields | Field Types Reference

Display Name Tab

Control how records are identified throughout Coherence using the Display Name configuration.

Key features:

• Combine multiple fields into a display template
• Add literal text between field values
• Configure fallback behavior for empty fields

Learn more: Display Name Configuration

Create Form Tab

Choose which fields appear when users create new records.

Key features:

• Select additional fields beyond required ones
• Reorder fields in the create form
• Toggle automatic inclusion of required fields
• Show/hide the visibility selector

Learn more: Create Form Configuration

Filters Tab

Define reusable filter controls that appear in list views.

Key features:

• Create filters based on select, reference, or tag fields
• Choose single or multi-select filter behavior
• Set default filters
• Order filters by importance

Learn more: Filter Configuration

Views Tab

Configure how records are displayed with different view types.

Key features:

• Create table, kanban, calendar, and other view types
• Configure columns, grouping, and sorting
• Set view-specific filters
• Share views with team members

Learn more: Views & Layouts

Actions Tab

Define custom actions users can trigger on records.

Key features:

• Convert records between modules
• Create status transition shortcuts
• Trigger automation workflows
• Configure bulk operations

Learn more: Module Actions

Uniqueness Tab

Prevent duplicate records with uniqueness constraints.

Key features:

• Simple single-field uniqueness
• Composite uniqueness across multiple fields
• Flexible duplicate detection rules
• Block or warn on duplicates

Learn more: Uniqueness & Duplicate Detection

Permissions Tab

Control which roles can access and modify records.

Key features:

• View permission matrix by role
• Toggle View, List, Create, Edit, Delete permissions
• Configure custom action permissions

Learn more: Module Permissions

Advanced Tab

Configure system-level module settings.

Key features:

• Edit display name, singular/plural naming
• Change the module slug (URL identifier)
• Configure API access

Learn more: Advanced Settings

Activity Tab

View the history of module configuration changes.

Key features:

• See when module was created and updated
• Track configuration change timeline
• Audit administrative actions

Learn more: Activity Log

Module Status

Modules have one of three statuses:

Publishing Your Module

When you're ready to make changes live:

1. Complete your configuration
2. Click Publish module in the header
3. Changes immediately affect all users

Vendor Modules

Modules marked as "Vendor" are managed by Coherence. You can customize fields and views, but core functionality is maintained by the system.

Common Workflows

Creating a People Module

1. Create module named "Contacts"
2. Add fields:
   • Name (Single Line) - Set as primary
   • Email (Email) - Required
   • Phone (Phone)
   • Company (Reference to Companies)
   • Status (Select: Lead, Customer, Churned)
   • Owner (User)
3. Configure the display name: {first_name} {last_name}
4. Create a Kanban view by Status
5. Publish the module

Creating a Projects Module

1. Create module named "Projects"
2. Add fields:
   • Project Name (Single Line) - Primary
   • Description (Rich Text)
   • Status (Select: Planning, Active, Complete)
   • Start Date (Date)
   • Due Date (Date)
   • Budget (Currency)
   • Client (Reference to Companies)
   • Team Lead (User)
3. Configure uniqueness on Project Name
4. Create Table and Kanban views
5. Publish the module

Troubleshooting

"Field name already exists"

Each field name must be unique within a module. Use more specific names or add prefixes.

"Cannot delete field with data"

Fields containing data require confirmation to delete. You can:

• Archive the field instead
• Export data first
• Force delete (data will be lost)

"Reference module not found"

The target module may have been deleted or renamed. Recreate the reference or update the target.

Changes not appearing

Make sure you've clicked Publish module to make changes live. Changes in Draft status are not visible to regular users.

---

Next steps:

• Create your first module
• Learn about field types
• Configure views