Why Build an Extension
CALM Hub stores each architecture as CALM, one model that all teams share. Each organisation also has its own notations, tools and processes. An extension connects them to CALM Hub, without a fork. The architecture stays the single source, and each team sees it in the form that it uses.
What you can add
| You want to | Extension point | For example |
|---|---|---|
| Show an architecture in your notation | diagram-lens | The C4 and ArchiMate® layers lenses |
| Show the results of your tools on the diagram | decorator-views | Control results, deployment status, security scan results |
| Show facts about an architecture or a node | designer-tab, detail-panel | The owner from your CMDB, open incidents, cost |
| Start a process from an architecture | action | Request a design review, open a ticket |
| Add a page or a card on the home page | screen, landing-card | A release calendar |
| Let the CLI and AI assistants use it | commands | calm hub ext <id> <command>, and an MCP tool for each command |
One extension can use many extension points. The
release-tracker tutorial uses screen, designer-tab, landing-card,
detail-panel, action, decorator-views and commands.
Why not a fork
| A fork of CALM Hub | An extension | |
|---|---|---|
| CALM Hub updates | You merge each release into your fork | You update CALM Hub. The extension does not change |
| Your release schedule | Tied to CALM Hub | Your own |
| Language | Java and React | Any language that serves HTTP |
| Your data | In CALM Hub | In your service. Your architectures can stay in your network |
| Share it | Hard to share | Other organisations install it. You can list it |
What CALM Hub does for you
An extension is an HTTP service and a manifest. CALM Hub does the work that each extension needs, so the service can stay small:
- Access. CALM Hub signs the user in and checks the scope of each route before it calls the service. See Extension access.
- Data. CALM Hub can read the architecture, with the rights of the user, and send it in the call. The service then needs no account in CALM Hub and no route back to it.
- Identity. CALM Hub signs a short assertion of who asked, so the service can trust the call.
- UI. The service returns data, and CALM Hub draws it with its own components. No extension code runs in the browser, so an extension cannot read the token of the user or change the page.
- Audit and limits. CALM Hub records each call that is not read-only, and limits the size and the time of each call.
When to use something else
| You want to | Use |
|---|---|
| Change what CALM can describe | A change to the CALM schema |
| Require properties on your nodes or relationships | A standard |
| Require a structure for a type of architecture | A pattern |
| Make a document or a website from an architecture | Docify and widgets |
Next steps
- Follow the extension tutorial.
- Read the extension point reference.
- Copy a sample extension.
ArchiMate is a registered trademark of The Open Group in the United States and other countries.