How to update diagrams in this wiki - global-121/121-platform GitHub Wiki

Most of the diagrams in this Wiki were created and can be updated with Diagrams.net:

  1. Clone this Wiki repository locally, see "Clone this wiki locally" bottom right.
  2. Go to diagrams.net (or install the diagrams.net desktop app) and open the diagram from the repository. Source data is included inside the png files, hence they have the extension .drawio.png, files are located in /images
  3. Edit the diagram
  4. Save the updated diagram to PNG, this should both update the visible part of the PNG and the DrawIO source data in it
  5. Commit and push to GitHub

Some diagrams were not created in Diagrams.net:

  1. At this moment the Actors diagram is copy-pasted from the now obsolete Enterprise Architect project, so for this diagram there is no Diagrams.net source file yet.
  2. The 121 Service As Is Entity Relationship Diagram is generated and annotated in DBeaver. See below for more details.

Updating the 121 Service Entity Relationship Diagram using DBeaver:

  1. Have this Wiki repo cloned locally, see above.
  2. Install DBeaver, the Community edition is sufficient. See: dbeaver.io
  3. Open DBeaver and create a connection to the 121 Service Database. Test if the connection works.
  4. In DBeaver go to the Projects tab, Diagrams and then right-click to select Create New ERD Diagram.
  5. Select the tables and views to be included into the diagram and give it the name 121-service-erd.
  6. Customize the generated ERD as you see fit, for example manually re-arranging the tables, adding notes, and/or changing which attributes of tables are shown. See this DBeaver Wiki page for more information.
  7. Note: if you already have created the diagram in the past, then when opening it in DBeaver most changes to the actual database are automatically changed in the ERD, like additions, changes and deletion of attributes and deletion of tables. However, new tables are not automatically added to the ERD. A simple manual action is needed: go to the Database Navigator and drag and drop the Tables node of the 121-service Schema onto the visualized ERD.
  8. Save the ERD.
  9. Export the ERD to .png file and overwrite the old png file in the /images folder of the Wiki repo.
  10. Commit and push the changes in the Wiki Repo.