Filter Configuration

The Filters tab lets you define reusable filter controls that appear in your module's list views. These saved filters help users quickly narrow down records without manually configuring filter conditions each time.

What are Module Filters?

Module filters are predefined filter controls tied to specific fields. When configured, they appear as filter buttons or dropdowns in the module's table and list views, allowing users to quickly filter records by common criteria.

For example:

• A "Status" filter on a Deals module
• A "Priority" filter on a Tasks module
• An "Assigned To" filter on a Tickets module

Accessing the Filters Tab

1. Go to Settings > Modules
2. Select your module
3. Click the Filters tab

Eligible Field Types

Not all fields can have filters created for them. Filters work with fields that have discrete values:

If your module doesn't have any eligible fields, you'll see a message indicating you need to add select, tag, or reference fields first.

Creating a Filter

1. Click Add filter in the Filters tab
2. Fill in the filter details:

Filter Name

A descriptive label shown to users. Examples:

• "Status"
• "Priority"
• "Assigned To"
• "Department"

Field

Select which field this filter controls. The dropdown shows only eligible fields from your module.

Filter Type

Choose based on how users typically filter:

• Status → Single select (one status at a time)
• Tags → Multi select (show records with any selected tag)

Default

Mark a filter as "Default" to highlight it prominently in the filter bar. This is useful for the most commonly used filter.

3. Click Create filter to save

Managing Filters

Editing a Filter

1. Find the filter in the list
2. Click the pencil icon
3. Update the name, field, type, or default setting
4. Click Save changes

Reordering Filters

Filters appear in the order configured. Use the up/down arrows to change the display order:

1. Find the filter you want to move
2. Click the up arrow to move it earlier
3. Click the down arrow to move it later

The first filters appear most prominently in the filter bar.

Deleting a Filter

1. Find the filter to remove
2. Click the trash icon
3. Confirm the deletion

Filter Display

Each configured filter shows:

How Users Use Filters

Once configured, module filters appear in runtime list experiences:

1. User opens the module
2. Filter buttons appear in the toolbar
3. Clicking a filter shows available options
4. Selecting options filters the record list
5. Multiple filters can be combined

Single Select Behavior

Only one value active at a time. Selecting a new value replaces the previous selection.

Multi Select Behavior

Multiple values can be selected. Records matching any selected value are shown (OR logic).

Best Practices

Keep Filters Focused

Create filters for the fields users most commonly filter by. Too many filters clutters the interface.

Recommended: 3-5 filters per module

Use Clear Names

Filter names should be immediately understandable:

• ✅ "Status", "Priority", "Owner"
• ❌ "Field_1", "Category_Type_Code"

Order by Usage

Put the most-used filters first. Users scan left-to-right, so important filters should be early.

Consider the Workflow

Think about how users work with records:

• Sales deals: Status, Stage, Owner
• Support tickets: Status, Priority, Assignee
• Projects: Status, Team, Due Date Range

Set a Sensible Default

Choose one filter as default - typically the most important one. This filter is highlighted and often expanded by default.

Filters vs. View Filters

Module filters provide quick access to common filtering. View filters define the baseline records shown in a saved view.

Both can be used together: a saved view might filter to "My Records" while module filters let users further narrow by Status.

Troubleshooting

"No eligible fields" message

Your module needs select, multi-select, reference, or tag fields to create filters. Add one of these field types first.

Filter not appearing in runtime

1. Verify the filter was saved (appears in the list)
2. Check that the field still exists
3. Refresh the module page

Filter shows no options

The linked field has no options configured. Add options to the select field, or create reference records for lookup fields.

---

Related: Views & Layouts | Configuring Fields | Module Builder Guide