Map your systems
The system map
Your systems and the connections between them on one canvas, coloured by contract health, with a table and a Connections view.
Open System map in the appHow the map reads
The map is the home of your organization or project. Each box is a system. Each line is a connection: every API one system (the consumer) calls on another (the provider). The arrow points from consumer to provider.
A line takes the colour of its worst contract, and its label counts them, so one broken API turns the whole line red while the label still shows how many are fine. The legend in the bottom left lists every status with its colour, line style and icon. See Contract statuses.
Add and connect systems
- Press System in the toolbar and create the system. See Systems.
- Hover a system and drag its + handle onto the system it calls. You can also click the handle, or choose Connect systems from the toolbar's more menu.
- The Connect systems dialog opens with the consumer and the provider filled in. Tick the provider APIs the consumer uses, then press the Connect button. Each ticked API becomes an expectation, and its contract is checked straight away.
- If the API doesn't exist yet, choose Need an API that doesn't exist yet? and declare it. It shows as Unresolved until the provider offers it.
From a system page, … → Add a dependency… opens the same dialog.
Move around
- Drag the background to pan, and use the zoom buttons or the wheel to zoom.
- Drag a system to move it. Positions are saved. Arrange automatically lays the map out again, each chain of calls straight across, and Fit to screen shows everything.
- Click a system to select it. Right-click it (or press
Shift+F10) for its menu: Open system page, Edit system, Add endpoint, Depends on, Used by and more. - The panel on the left has four tabs. Filter & view has Find system or API… to find a system, the Filter choices (All, Healthy, Broken, Warnings, Unresolved & planned) and the view. Environment picks the environment, Overlays has the flow overlay and Tickets, and Draft has Draft mode.
- With the keyboard, Tab to a system, use the arrow keys to move it and Enter to select it.
Ctrland an arrow key goes to the nearest system that way;HomeandEndgo to the first and last.
Zoom from the map to a field
Rabbinatix shows more detail only when you ask for it.
The connection page
The connection page lists every API the consumer expects on the left and what the provider offers on the right, joined by a status line. Rows are sorted by severity, broken first.
- Use the status chips to show one status. No consumer shows provider APIs nobody calls.
- A row the provider doesn't declare says "Not declared by" the provider, with a Not built yet button that creates a planned endpoint for it.
- Press New expectation to declare another call, or Consume more APIs to tick more of the provider's APIs. Export Pact is in the more menu.
- Below the rows, Mismatches seen in development lists what the consumer's contract watcher saw, and Flows crossing this connection lists the flows that use it.
Map views
The Map view switch, in the Filter & view tab, has three views. Your choice is kept in this browser.
In Connections, each system is a circle. Its ring shows service health from its latest health check, its size grows with its number of connections, and particles move from consumer to provider. Red particles show the share of broken contracts, amber ones the share of warnings.
- Click a circle, or press Enter on it, to focus on it and its neighbours. All systems in the breadcrumb, or Esc, goes back.
- Double-click a circle to open its system page. Click a line to open the connection page.
- Re-arrange spreads the circles out, and Map layout puts them back where they are on the canvas.
- Pause animation stops the particles. With reduced motion turned on, the view starts still.
- Follow theme swaps the dark stage for your light or dark theme. The Legend explains every colour.
Overlays and modes
The environment is in the Environment tab on the left, the flow overlay and Tickets in Overlays, and Draft mode in Draft. Present is in the toolbar.
- Environment. Development is where you work. Choose another environment to see contracts as they are deployed there: the map is read-only meanwhile. See Environments and deployments.
- Flow overlay. Choose a flow instead of No flow overlay to highlight the systems it crosses and play its calls one by one.
- Tickets is a switch: on, it shows open tickets on systems and connections.
- Present shows the canvas full screen, fitted to it. Nothing on the map can be moved, connected or added while presenting. Going to another page ends presenting.
- Draft mode lets you try API changes first. See Change impact.
Everything an object is linked to
What’s linked in the sidebar shows any object in the middle with everything it is linked to around it: systems, APIs, contracts, logic, flows, test cases, tickets, releases and more.
- Open What’s linked and pick a system to start from, or search for any object.
- Choose Direct links or Two steps, and use the kind chips to hide what you don't need.
- Choose the button beside a linked object to move to it; its name opens it. Back returns.
- Press Impact to see what is affected when the object Changes, Breaks or Goes down, with the chain that explains each one.
Linked objects lists the same objects as text. The What’s linked tab on a system page, and the related panel in a contract, show the same links, with Show what’s linked to open them here.
Sticky notes
A sticky note is a short note on the canvas, for you or for everyone. Anyone in the organization or project can add one, viewers included. A sticky note is never part of what it sits on: it has no versions, it isn't reviewed, and Draft mode and draft-first publishing don't hold it back.
- Add one. Press the sticky note button with the zoom buttons and choose Add sticky note, or right-click an empty part of the canvas and choose Add sticky note here. Type, then press Save (or
Ctrl+Enter). An empty note goes away. - Who sees it. A new note is Only me: nobody else ever sees it. Choose Organization before saving, or later from the note's menu, and everyone who can open the map sees it with your name on it.
- Fold it. The fold button turns a note into a small icon; click the icon to open it again. Folding is yours alone: a shared note you fold stays open for everyone else, and stays folded on your other devices.
- Change it. Only the person who wrote a note changes it. Double-click the text (or choose Edit) to edit it, drag it by its top bar to move it, or nudge it with the arrow keys. Its menu also has the colours.
- Delete it. Delete your own from its menu, and Undo brings it back for a few seconds. Someone who may edit the map can also delete a shared note left by someone else, after a confirm.
- Hide them. Hide sticky notes in the same button hides every note on the map for you, until you choose Show sticky notes.
Sticky notes are on the map's canvas only, not in the Table or Connections view, an environment's view, or while presenting.
Related
- SystemsCreate the apps and services you build or depend on, give them owners and tags, and find any system or API again.
- Contract statusesWhat each status means, how one contract colours a connection and a system, how to read a contract, and how to tune the checks.
- Change impact and Draft modeSee what an API change would break before anyone feels it, share the drafts for review, and publish them when they are right.
- FlowsBuild a flow from the logic it starts at, see it cross your systems in lanes, and move it from draft to verified.
- AccessibilityHow Rabbinatix supports WCAG 2.2 AA: using it by keyboard (canvases, whiteboards and Inspect too), Simple view, reduced motion, the text alternatives to canvases, and how to report a problem.
