SPACE

Appearance

Model documentation ​

Diagram ​

The documentation diagram visualises the relationship between different entities such as Cubes and Processes. Nodes in the diagram can be moved by dragging them. Clicking on a node, or a node link allows you to view and update information about that node/link, such as the description or the color.

Diagram image

Options ​

The diagram options can be set by clicking on the setting icon on the top right of the screen.

Diagram settings

  • System objects ​

    By default, system objects are not shown. Enabling this option shows system objects.
  • The diagram only shows cubes that have connections to other items. Enabling this option will show any cube, even those without any links.

  • Processes ​

    Shows processes
  • The diagram only shows processes that have connections to other items. Enabling this option will show any process.

  • Chores ​

    Shows chores

  • Hidden objects ​

    Objects can be hidden from the diagram by clicking on them and checking the "Hide" option. When this option is enabled, hidden objects will still be displayed.

  • Mini map ​

    When enabled, a mini map of the diagram will be displayed on the bottom right of the screen.

Refresh documentation ​

The refresh documentation button fetches the latest data and re-generates the diagram. This action can only be performed by admins.

Diagram settings

Documentation update job ​

The documentation update job performs the refresh documentation action on a set interval. To create the documentation update job, go to the space settings jobs tab, click on new job, and select documentation update. Keep in mind that only users with admin access tokens can create jobs. To find out more about jobs, check out jobs.

Diagram settings