Modules
Modulix is made of modules: Contacts, Sales, Accounting, Inventory and so on. Each organization turns on only the modules it needs. The Modules page lists every module available on your server and lets administrators enable or disable them for the organization, without downtime.
Before you begin
- To see the Modules page, you need View modules (
core.modules.read). - To enable or disable modules, you need Enable and disable modules (
core.modules.manage). Owners and administrators have both by default. - Installing, upgrading and uninstalling modules affect the whole server. Only platform administrators can do them; they are usually the people who run your Modulix server.
Key concepts
- Installed: the module is set up on the server, with its database tables. A module that is not installed shows the Not installed badge.
- Enabled: the module is turned on for your organization. Its pages, menu entries, dashboard widgets and permissions appear. Each organization on the server enables its own modules.
- Dependency: a module that another one needs. For example, Banking needs Accounting. A card shows its dependencies as requires module badges.
The Modules page
In the sidebar, under Administration, select Modules.
- Use the All, Enabled and Available tabs to filter the cards. Available shows the modules that are not enabled.
- Type in Search modules to find a module by name, description or category.
Each card shows the module's name, version, author and category, its description, a switch, and badges:
| Badge | Meaning |
|---|---|
| Enabled | The module is on for your organization. |
| Not installed | The module is on the server but not installed yet. Only a platform administrator can install it. |
| requires module | The module needs this other module. |
| Update to vversion | A newer version is on the server. A platform administrator can upgrade it. |
| System | A module that is always enabled. Its switch cannot be turned off. |
| Plugin | A module added to the server by your organization or a third party, not shipped with Modulix. |
Enable a module
- On the Modules page, find the module.
- Turn on its switch (Enable for this organization).
Modulix shows "Module enabled". The change applies right away, for everyone in the organization:
- Modules it requires are enabled first, if they are not already.
- Its entries appear in the sidebar, and its widgets on the dashboard.
- Its default permissions are given to the system roles (Administrator, Member, Read-only). Custom roles get nothing automatically: add the new permissions to them on Roles and permissions.
- If it has organization settings, a new section appears on the Settings page. Review it. See Organization settings.
Disable a module
- On the Modules page, find the module.
- Turn off its switch (Disable for this organization).
Modulix shows "Module disabled". The module's pages, menu entries, widgets, settings and API disappear for your organization. Its data is kept: enable the module again and everything comes back as it was.
You cannot disable a module that another enabled module requires. Modulix answers, for example, "Disable banking first: they depend on "accounting"". Disable the dependent modules first, then this one.
Disabling a module affects everyone in the organization immediately. Links to its pages show Page not found, and integrations that call its API get errors. Check with your team before you disable a module in use.
Install, upgrade and uninstall (platform administrators)
Platform administrators see extra buttons at the bottom of each card.
| Button | What it does |
|---|---|
| Install | Sets up a module that is Not installed on the server, with the modules it requires. Organizations can then enable it. |
| Upgrade | Moves an installed module to the newer version on the server (shown as Update to vversion). Upgrades apply to every organization. |
| Uninstall | Removes the module from the server. Asks "Uninstall module?" first. |
When you uninstall a module, it is disabled for every organization on the server, and its permissions are removed from all roles. Its data is kept and is available again if you reinstall it. You cannot uninstall a module while other installed modules require it; uninstall those first. System modules show System module instead and cannot be uninstalled.
Modules that are not on the server at all do not appear on this page. Adding a new module to a Modulix server is a deployment task; see Building modules.
Modules shipped with Modulix
| Module | Category | What it does | Requires |
|---|---|---|---|
| Accounting | Finance | General ledger: chart of accounts, journal entries, posting and reversing, fiscal periods, trial balance and ledgers. | — |
| Accounts Payable | Finance | Vendor bills, payment scheduling, payments, postings to the ledger, aging. | Purchasing, Accounting |
| Accounts Receivable | Finance | Invoices and payments posted to the ledger, customer balances, aging, statements, collections notes. | Sales, Accounting |
| Activities & Tasks | Productivity | Notes and threaded comments with @mentions on any record, tasks with reminders, My tasks and record timelines. | — |
| Banking | Finance | Bank accounts, statement imports (CSV or OFX), matching, reconciliation and transfers. | Accounting |
| Contacts | Sales | The people and companies you work with, each with an owner. | — |
| Custom Fields | Administration | Your own fields on users, organization units, notes and other records. | — |
| Documents | Productivity | Files in folders, with versions, attached to records. | — |
| Expenses | Finance | Expense claims with receipts, categories on ledger accounts, approval, reimbursement and postings. | Accounting, Workflow Automation |
| Financial Reporting | Finance | Balance sheet, profit and loss and cash flow statement, with comparisons, in PDF and Excel. | Accounting |
| Forms | Productivity | Forms with several pages and conditional questions, shared internally or through a public link. | — |
| Inventory | Inventory | Warehouses and locations, stock on hand, reserved and available, movements, receipts, shipments and adjustments. | Product Catalog |
| Leads | Sales | Capture, qualify, assign, score and convert leads. | Contacts |
| Notes | Productivity | Shared notes for your team. | — |
| Notifications | Communication | In-app, email and browser push notifications, each person choosing what they receive. | — |
| Opportunities | Sales | Deals with value, close date, stage and probability, product lines and won or lost reasons. | Contacts, Product Catalog, Pricing |
| Organization Structure | Administration | Companies, subsidiaries, divisions, business units, branches, departments and teams as one hierarchy. | — |
| Pricing | Sales | Price books per currency and customer group, book prices and discount limits per role. | Product Catalog |
| Product Catalog | Inventory | Products and services with variants, units of measure, categories and pictures. | — |
| Purchasing | Purchasing | Suppliers, the products they supply, and purchase orders. | Contacts, Product Catalog, Inventory, Taxes |
| Sales | Sales | Quotations, sales orders, invoices and payments. | Contacts, Product Catalog, Pricing, Taxes, Opportunities, Inventory |
| Tax Management | Finance | Tax collected and paid by period, GST/HST and VAT returns, tax accounts in the ledger. | Accounting, Taxes |
| Taxes | Sales | Tax rates and groups, rules by customer location and product tax class, exemptions. | — |
| Workflow Automation | Productivity | Steps that run when records change or on a schedule, with conditions, approvals and webhooks. | — |
Because dependencies are enabled automatically, enabling Sales alone also turns on Contacts, Product Catalog, Pricing, Taxes, Opportunities and Inventory.
How it connects to other features
- Roles and permissions: enabling a module gives its default permissions to the system roles. See Roles and permissions.
- Settings: each enabled module with organization settings has its own section. See Organization settings.
- Webhooks: other systems can be told when a module is enabled or disabled. See API keys and webhooks.
- Audit log: enabling, disabling, installing, upgrading and uninstalling are recorded (
module.enabled,module.disabled,module.installed,module.upgraded,module.uninstalled).
Permissions
| Permission | What it allows | Granted by default to |
|---|---|---|
core.modules.read (View modules) | See the Modules page. | Owner, Administrator |
core.modules.manage (Enable and disable modules) | Enable and disable modules for the organization. Platform administrators also need it to install, upgrade and uninstall. | Owner, Administrator |