Skip to content

Commit

Permalink
Documentation for entity overlay diagrams
Browse files Browse the repository at this point in the history
#CTCTOWALTZ-2784
#6688
  • Loading branch information
jessica-woodland-scott-db committed Aug 21, 2023
1 parent 66ddbd8 commit 887f26a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 4 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Entity Overlay Diagrams are constructed of 'group cells' which may or may not be
The cell contents can show aggregated waltz data relating to the backing entity of the cell by selecting one of the overlays.



## Model

We make use of `aggregate_overlay_diagrams` for storing entity overlay diagram data.
Expand Down Expand Up @@ -58,20 +57,36 @@ Example:
"titleColor":"#1F7FE0",
"contentColor":"#eef5fb",
"contentFontSize":0.7,
"titleFontSize":0.8},
"titleFontSize":0.8,
"position":1
}
}
]
```


## Features

### Builder

Available via the 'System Admin' page. Users with admin privileges can create / edit diagrams.

![img.png](entity-overlay-diagram-builder.png)

The diagram builder shows the selected diagram information at the top of the page (1). You can construct diagrams without them being saved to the database, in which case this is hidden.
The diagrams controls are at the bottom of the header (2); here you can update the lifecycle status of the diagram, rename it or save any changes to the layout below.

The main section of the diagram editor is split into the rendered diagram (3) and the context panel (4). The rendered diagram gives you a preview of the structure and can be used to interact with the groups and reorder sections.
The context panel displays the overall structure of the diagram (useful for navigation), and once a group is selected, the edit options for the layout relating to that group.

### Section

A list of active diagrams can be selected from in the diagrams section.
A list of active diagrams can be viewed and selected from the 'Entity Diagrams' tab (1) in the diagrams section.

![img.png](entity-overlay-diagram-overlay-picker.png)

The default overlay shows the backing entities for the group cells. In the context panel you can pick from the list of available overlays to populate data on the diagram relative to the vantage point you are using e.g. the current `ORG_UNIT` or `APP_GROUP`.

![img.png](entity-overlay-diagram-selected-overlay.png)

Once an overlay has been picked the cell contents show the overlay (where one exists). Group cells that are not backed by data will not show an overlay. Cells with no relevant data for that overlay will also appear blank. There is the option to toggle whether to show or hide cells with empty cell contents in the context panel (2).
By selecting a group cell on the diagram you can get an enhanced view of the overlay in the context panel (4).

0 comments on commit 887f26a

Please sign in to comment.