Modules
Modules
The Modules screen shows what this MaxSuite has installed, what each organisation may use, and what is switched on. It is the place to look when a sidebar entry you expected is missing.
Modules sits at the foot of the sidebar only for platform administrators given the Platform: modules right. Anyone else who opens it sees "Only somebody given 'Platform: modules' can see and switch modules."
What you see
- Figures: how many modules are Installed, Entitled, Enabled, and how many Capabilities are on offer.
- A filter box, to find a module by name or id.
- Where files are kept: where uploads, attachments and pictures sent to the bot are stored.
- Where site backups are kept: where every organisation's shop and site backups are copied.
- Products: groups of modules offered as one thing, with whether the organisation has each.
- The module table: one row per installed module.
- Capabilities on offer: things one module offers to others, such as
llm.chat ← ai.
The module table
| Column | Meaning |
|---|---|
| Module | Its name and id |
| Entitled | "yes" if the organisation may use it, "not bought" if not |
| Enabled | "on" or "off", for the whole MaxSuite |
| In sidebar | "shown" when entitled and enabled, otherwise "hidden" (hover to see why) |
| Depends on | Modules it needs |
| Needed by | Modules that would be refused if this one went away |
A module reaches the sidebar only when it is installed, entitled and enabled. Then you still need the permission its entry asks for. See Workspaces and modules.
New modules usually arrive switched off. Switch one on here before anyone can use it.
What you can do
Find out why a module is missing
- Type its name in the filter box.
- No row: it is not installed.
- Entitled says "not bought": the organisation does not have it.
- Enabled says "off": it is switched off for everyone.
- All three fine: you lack the permission its entry needs. See People, roles and permissions.
Grant or revoke a module
- On the row, press Grant. This grants the module and everything it depends on.
- To take it away, press Revoke and confirm. Revoking is refused while another entitled module depends on it.
Products work the same way.
Switch a module on or off
- On the row, press Enable, or Disable and confirm.
- This is for every organisation, and its scheduled jobs start or stop with it.
Disabling keeps the data. Enabling it again brings everything back.
Choose where files are kept
Change where uploads are stored, from the built-in setting to an S3-compatible bucket (Endpoint, Region, Bucket name, Access key, Secret key, Prefix, and Path-style addressing under Advanced). Press Test it to write and read a file there. Files already stored are not moved: anything uploaded before the change stays where it was. Others see "Only an administrator can change this."
Choose where site backups are kept
Under Keep site backups in, choose File store bucket (under site-backups/ in the bucket above) or Own bucket (kept apart, with its own bill and lifecycle). This is used for any organisation that has not named a bucket of its own on Shops → Backups. Each organisation gets its own folder.
Make AI work
If Capabilities on offer says nothing offers one, add a model connection under Agents → AI. See AI.
Who can do what
| What | Who |
|---|---|
| See the screen, enable and disable modules | a platform administrator given Platform: modules |
| Grant and revoke modules and products | entitlements:manage |
| Change where files and backups are kept | a platform administrator |
For agents
core.modules lists modules and their state. core.setModule switches one on or off, and asks a person first.