Your timesheet module needs the list of projects. Your invoicing module needs the hours. Modules on the platform work together through services: one module offers a named service, another calls it, and the platform passes the call along with the right person's permissions. Nobody reaches into anyone else's tables or code.
Declaring a service
A service is a promise your module makes to others. You declare:
| Part | Example |
|---|---|
| Name and description | project_actuals: a project's actual costs by cost code |
| What it takes | the project's id |
| What it returns | a summary and a list of lines |
| Who may call it | anyone holding ACCOUNTING.VIEW |
The call runs as the person using the other module, so they only get what they could see themselves. A service with a permission is refused when there's no person behind the call.
Changing a promise has rules. Adding an optional field is fine. Removing or renaming one is a breaking change: give it a new version number and keep the old behavior working until the modules that use it have moved.
Required or optional
When your module uses another's service, you say whether you need it:
- Required: installing your module installs the other one too. On the Marketplace, required modules are included automatically.
- Optional: your module works without it. The feature that needs it hides, and your screen can say what to install to switch it on.
Prefer optional. Every required module is one more thing a workspace has to own.
Interfaces: "any module that provides projects"
Often you don't care which module holds projects, customers or employees, only that one does. Data Visions defines standard interfaces for the common things:
project, customer, employee, worker, crew, department, team members.
Depend on the interface, and your module works with whichever module the workspace uses for that thing, today and after they switch.
Seeing the connections: Works with
- On the Marketplace, every module's page has a Works with tab: the modules it uses and the ones that use it.
- Workspace Admins can see how all their modules connect, including anything that needs attention, from the command line or through Claude with the connector.
Ask the Module Builder
For developers
"service_dependencies": [
{"module": "ACCOUNTING", "service": "project_actuals", "contract": "1",
"reads": ["summary"], "optional": true, "usage": "Actuals on the job page"}
],
"interface_dependencies": [
{"interface": "dv.project", "contract": "1", "optional": true,
"fields": ["name", "customer"], "usage": "Charge time to projects"}
]Call with service_registry.invoke(...), passing the person, and catch the error for an optional module that isn't installed. platform modules interfaces lists the interfaces.
Good to know
- Never read another module's tables, not even through its dataset. If your reports need its data, copy what you need through its service.
- A call that goes through the platform has 60 seconds. Start long work and come back for the result.
- Services are included; they aren't metered.
- Reacting instead of asking? See Events and live updates.