The Model Viewer macro of the ADOIT Enterprise Architect for Confluence enables you to display an ADOIT model as an interactive image in Confluence.
With the Model Viewer macro you can:
- Add an interactive model image from ADOIT to Confluence
- Get a closer look at the parts of the model you are interested in with zoom and drag and drop
- Get additional information on your model's objects as tooltips by clicking on them (e.g. view the description of an object)
- Access the model in ADOIT from your Model Viewer macro in Confluence
How to use the Model Viewer macro
Add a macro to a Confluence page
While editing a Confluence page, type /adoit and select the ADOIT Model Viewer macro.
A configuration dialogue opens. Here you can add an ADOIT model URL, search for a specific model name, or select a model in the explorer view on the left of the configuration dialogue. In the center you can see a model preview.
After selecting the model, you can define the visualization details of your model viewer.
If you don't want to show the name of your model above the model viewer, clear the "Include model name as title" check box.
You can define the width and height of the Model Viewer macro in your Confluence page or else keep the default values.
To display a different content language of the model, available languages can be selected. If no model language is selected, the default language of your Confluence instance is used.
When you are done configuring your model viewer, click "Insert". In case you want to change the visualization later, the model viewer configuration can be adjusted at any time while editing your Confluence page.
Alternatively, ADOIT models can directly be embedded by pasting an ADOIT URL. Please note, that an
adoit:: prefix has to be added before the URL is pasted to the Confluence page.
An ADOIT smart link URL looks similar like:
With the Model Viewer macro, you can display your model as an interactive image on your Confluence page.
To zoom in/out of the model displayed in the model viewer, click the "+" and "-" icons.
To reset the zoom level of your model image, so that the complete model can be seen within the Model Viewer macro bounds, click the "Fit" arrow icon.
As Default layout, Responsive or Fixed can be choosen. Responsive uses dynamically the whole available width and the manually defined height. Fixed uses the manually defined width and height.
You can define the width and height of the Model Viewer macro in your Confluence page or else keep the default values. Width impacts only the default layout fixed.
To open the corresponding model in ADOIT, click the "Open in ADOIT" button on the right below the model viewer.
To refresh your model image manually to synchronize its content with your ADOIT instance, click the refresh button on the right on top of your model viewer. A refresh is needed for example, if the model language of the macro has been changed.
To get additional information about the model's objects as tooltips, directly click on the objects.
Model Viewer object tooltips
The Model Viewer tooltips enable you to get attribute information of an object with a single click.
With a tooltip you can:
- Get the attribute values of the selected object
- Get relations of the selected object
- Access the object in ADOIT
Example of an Model Viewer macro tooltip:
How to configure the Model Viewer macro
Visible attributes and relations in the tooltip
There are two ways to define the attributes and relations that are visualized in tooltips:
Global configuration: Apps -> Manage apps -> ADOIT Enterprise Architect -> Configure
Space-specific configuration: Space Seetings -> ADOIT Enterprise Architect - Space Settings
In both configuration windows, you can add attributes and relations from the tree view to the selected object.