Please enable JS

Enterprise Architect and Confluence Integration

august 20, 2018

Prolaborate lets you add live references to Enterprise Architect diagrams, packages, and elements in Confluence.

There is no export/import needed for this integration and you will always see the most up-to-date version of the EA diagrams and objects.

In this user guide, we will see the two ways in which you can embed EA objects in to Confluence using Prolaborate.

In the first way, you can use the Prolaborate macro to embed EA objects from within Confluence. Second ways lets you embed Prolaborate links in Confluence using any macro that supports iFrames.

Embed using Prolaborate Macro

Prerequisites: Confluence version should be above V6.7. Get the macro file (.jar file) from Prolaborate team.

Install Macro

Click on the Administration > Add-ons > Upload app.

Choose the .jar file and click on Upload. Prolaborate app will now be listed in your Manage apps page.

Configure Prolaborate Macro

Under Atlassian Marketplace on the left-hand side panel, click on Prolaborate Configuration.

Select the Protocol of your Prolaborate site, then enter the Server Name and Port you use to connect to Prolaborate. Click on Connect.

If the connection was successful, you will be shown a list of repositories you have created in Prolaborate. Select the repository which you would be using in Confluence and click on Save.

Use Prolaborate Macro

Using the Prolaborate macro, you can embed diagrams, details of objects on it, details of packages and their children, details of normal and composite elements.

While creating or editing a page, click on Insert more content and select Prolaborate macro. You can add any one of the following objects to your Confluence page.

Embed Diagrams

To get to the diagram you wish to add, enter some or all text in your diagram name, select Stereotype, and Type and then click on Find.

Based on the filters you have used; the list of diagrams will get populated.

Select the diagram you wish to add to your page. To view more details of a diagram, you can click on the info icon and you can see the details as shown in the screenshot.

Before clicking on Add, note the two options at the bottom of the window.

  1. Show Diagram objects in a table – If you enable this option, details of objects on the selected diagram will be shown in a table in the page.
  2. Enable Prolaborate Links – If you enable this option, links will be enabled on Objects. You can click on them to see their overview in Prolaborate

After you have added the diagram and updated the page, the page will have the following components:

A live image of the diagram which you have selected.

Depending on whether you have enabled the option, you will see the details of objects on this page. This will behave exactly as it is in Prolaborate.

You can do the following:

  1. See more than 10 entries at a time
  2. Search for any text either from the whole table or from a specific column
  3. Filter the elements by Stereotype. If you select a stereotype, all the properties that you have configured for that stereotype in Prolaborate will be shown
  4. Show/hide the columns that are shown

Embed Packages

Select Packages tab from the Prolaborate macro window to search for Packages.

Click on Find to view all the packages from the connected repository. And then you can select the package which you want to embed in your page.

Before clicking on Add, note the two options at the bottom of the window.

  1. Show Child Elements – Details of child elements of selected package will be shown in a table in the page
  2. Enable Prolaborate Links – If you enable this option, links will be enabled on Objects. You can click on them to see their overview in Prolaborate

After you have added the package and updated the page, depending on the configuration, the page will show the notes of the package and the details of its children in a table view.

Embed Elements

To embed details of elements you wish to add, enter some or all text in your element name, select Stereotype, and Type and then click on Find.

Select the element you wish to add to your page. To view more details of an element, you can click on the info icon and you can see the details.

Before clicking on Add, note the two options at the bottom of the window.

  1. Show Child Elements – Details of child elements of selected element, if it is a composite element, will be shown in a table in the page
  2. Enable Prolaborate Links – If you enable this option, links will be enabled on Objects. You can click on them to see their overview in Prolaborate

After you have added the element and updated the page, the page will have the details of the element and its children. The table controls will work as explained above.

Any questions? Contact us