Skip to content

The Modules page

Screen guide6 minFoundation

Before you start

A moduleModuleA table of business data (for example Customers) with fields, forms, views and automation.Open glossary ↗ holds one kind of record, such as Contracts, Vendors or Purchase Orders. The Modules page lists all of them. The page says it plainly: “The tables that hold your business data. Open a module to design its fields, forms, views and automation.”

Open it with Modules in the left rail.

The Modules page: a heading, an Add module button, a search box, a count and a Select button, then a grid of module cards. Each card shows the module name, its table name and a small lock.
    Add module opens the New module dialog.
    Search by module name or by table name. Press / to jump to the box.
    Select lets you tick several modules, to delete them together.
    The card shows the module name and, underneath, its table name.
    The lock means the module’s data is private. A shared module shows Shared.

What does a module card show?

Section titled “What does a module card show?”
  • The module name, as people read it.
  • The table name, in a smaller code style, such as cm_contract_base. It is the name of the table where records are stored. Click it to copy it. It reads Copied for a moment.
  • A lock or a Shared tag. The lock means private data. Shared means everyone can see the module’s records. See Shared data modules.

Hover a card to see the module’s description, if it has one. Click the card to open the module on its Fields page.

What is in the card menu?

Section titled “What is in the card menu?”

Open the menu button (three dots) on a card:

ItemWhat it does
Edit detailsOpens Edit module, to change the description, icon, sharing and barcode setting
DuplicateCopies the module’s structure into a new module. See Duplicate or delete a module
RelationsOpens the Relations manager for this module
DeleteDeletes the module, after you confirm

The name and the table name are fixed once a module exists, so choose them with care. Edit details shows them with a lock.

How do I delete several modules at once?

Section titled “How do I delete several modules at once?”
  1. Click Select. The cards become tick boxes.
  2. Click each module to delete. A bar at the bottom counts them.
  3. Click Delete, then confirm.

Click Cancel on the bar to leave Select mode without deleting. The confirmation says “Delete the selected modules? They will also be removed from every app that uses them.” The buttons are Delete and Keep it.

How do I find a module in a long list?

Section titled “How do I find a module in a long list?”

The page shows 12 cards at a time, with page numbers at the bottom. The count next to Select reads “23 modules” or “1 module”. Type part of a module’s name, or part of its table name, in the search box. When nothing matches, the page says “No module matches your search”.

For a faster route from any page, use Jump to and type the module’s name. See A tour of the Designer.

What should I know before I start?

Section titled “What should I know before I start?”
  • A new workspace shows “No modules yet”, with the line “A module is a table for one kind of record: customers, orders, products.”
  • Deleting a module removes it from every application that lists it.

Check yourself

Sara clicks the Contracts card on the Modules page. What opens?
Show the answer

The Fields page of the module. A card opens the module on its Fields page. Edit details is in the card's menu.

What does the small lock on a module card mean?
Show the answer

The module's data is private, which is the default. A lock marks private data. A module with Share data across users switched on shows a Shared tag instead.

What's next

Create a moduleCreate a module to hold one kind of record, such as contracts or equipment requests, and know the naming rules before you type.The Fields pageA guided look at the Fields page, where you list, add, edit and delete the pieces of information a module keeps.

Last checked