See how your repositories join on the System map
Draw every repository the organization reads, the services in each and the requests and topics that join them, and see what depends on a service.
In short
The System map shows every repository your organization reads as a code source, the services each one holds, and the requests and topics that join them. Choose a service to see what depends on it in the other repositories, nearest first, and the tables it reads or writes.
Before you start
- Who: anyone who can open the Designer's "Code" view here.
- Plan: the system map across repositories is part of the Business and Enterprise plans and the 14-day trial. On other plans it lists the repositories and their services, with a line saying so.
- First: two or more repositories connected as code sources. See /help/designer/connect-your-code.
Steps
- On the Designer home, open the header menu and choose "System".
- Under "Draw the system as", keep "Graph" or choose "Columns".
- Choose "Everything", "Requests" or "Topics" to say which joins to show.
- Choose a service: press it on the graph, or press its name in "Columns".
- Read "What depends on" the service: each part in another repository that calls it or consumes its topics, "Directly" or a few steps away. "Tables it reads or writes" lists its tables.
Result: the address keeps your choice, so a link opens the map on the same service.
Good to know
- Each repository's latest reading of its default branch draws its services.
- The line at the top counts the services, the requests and topics joined, and how many repositories are read.
- Each join says how sure it is - "Sure", "Likely" or "A guess" - and the file and line where it was found.
- "Not joined" lists requests no repository here answers, and topics with only one side here.
- The graph shows the services up to two joins from the one you chose. Choose a service nearer to the others to see them. In "Columns", "Show every join" brings back every join.
- A Component detail shows "System" at the top of the screen, and it opens this map. A part other repositories use says so, such as "Used by 2 parts in other repositories", and opens the map on it.
- On a phone the graph is a list.
If something goes wrong
- "No repository read yet" - connect two or more repositories as code sources; "Open code sources" takes you there.
- "Nothing joins these repositories yet" - no request one sends matches an endpoint of another, and no topic is published in one and consumed in another.
- "Not read yet" - the code source has had no reading. See /help/designer/connect-your-code.
- "The system map across repositories is part of the Business and Enterprise plans." - the repositories and their services still show.
Related
- /help/designer/connect-your-code
- /help/designer/start-a-design
- /help/designer/live-match