SharePoint 
Confluence 
Case Studies 
Enterprise Architect Model and Confluence Page Integration
Prolaborate makes sharing live architecture and modeling information from your Sparx Systems Enterprise Architect models to your Confluence pages easier.
It eliminates the need for manual exports, imports, or copy-pasting, ensuring that Confluence users view the most up-to-date information from your EA models.
It is even possible to publish an interactive view that lets your users click and view more information like notes, properties, etc.
Nothing is expected to be done on the Confluence page once configured and published. A small modification to a diagram or an artifact in your Enterprise Architect model will automatically reflect on the Confluence page.
Share Model Information in Atlassian Confluence using Prolaborate Macro
Using Prolaborate Macro, the model information can be published in both Confluence Cloud and Confluence Data Center.
Let us see how to publish Enterprise Architect information in Atlassian Confluence using the Prolaborate Macro.
Prerequisites to install Prolaborate Macro
Prolaborate
- Prolaborate version should be 5.3.0 and above.
Confluence Cloud
- Use Prolaborate 4 Macro to publish data from the latest version of Prolaborate (V5 and above) to Confluence Cloud.
- Upgrade your Macro from Prolaborate to Prolaborate 4 to migrate information for a seamless transition if you upgrade from Prolaborate version 3.x to the latest. Click here to learn more on how to migrate model information in Atlassian Confluence after upgrading Prolaborate to the latest version from 3.x
Confluence Data Center
- For Confluence Data Center, the Macro version must be 3.5.3 as it supports the latest version of Prolaborate. To know more about the version history of Prolaborate Macro in Atlassian Confluence for data center, click here.
- The latest version of Prolaborate Macro is compatible with Confluence Data Center 8.0.0 to 8.9.8
- Confluence Data Center should be able to access the Prolaborate server. This requires the port of the Prolaborate server to be open and accessible to the Confluence Data Center.
Confluence Server
- For Confluence Sever, the Macro version must be 3.5.3 as it supports the latest version of Prolaborate. To learn more about the version history of Prolaborate Macro in Atlassian Confluence for the server, click here.
- The latest version of Prolaborate Macro is compatible with Confluence Server 8.0.0 to 8.5.17
- The Confluence Server should be able to access the Prolaborate server. This requires the port of the Prolaborate server to be open and accessible to the Confluence Server.
- Atlassian ended the support for the Server on February 15, 2024. Starting from version 8.6, the new releases support only Data Center.
Install Prolaborate Macro in Confluence
Confluence admin must install the Prolaborate Macro in their Atlassian Confluence.
Log in to Confluence using valid credentials. On the home page, click the Apps icon from the ribbon and select Find new apps.
In the search bar, type Prolaborate Macro to locate the macro for your Confluence version.
Click the Get it now button next to the Prolaborate macro to initiate the installation.
Confirm the installation by clicking the Accept & Install button to authorize the app.
Once the installation is complete, you will receive a status message confirming the installation was successful.
Note:
- Install Prolaborate 4 Macro in Confluence Cloud if you are using Prolaborate version 5.x and above. Click here to download it directly from the Atlassian Marketplace.
Configuration Part I – Add Confluence Integration in Prolaborate
Log in to Prolaborate as an administrator and add a new application.
Click on Menu > Integrated Application – Access Management and click on Add Application.
On the Add Application page, the user must enter details such as Name and Application ID to add the Confluence application. Click on Save to Add Application. An entry would be added.
Please enter the details below in the respective fields.
| Field | Description |
|---|---|
| Name | Enter a suitable name (e.g., Confluence). |
| Application ID or Client ID | Enter a suitable text as Application ID (Client ID) |
| Authorization | Please Choose Client Credentials if you have limited knowledge of the options |
| Scope | Please Choose Client Credentials if you have limited knowledge of the options. |
| Generate Security Token | This option should be enabled to generate security token (Client Credentials) |
| Enhance Security using PKCE | If it is Enabled in Prolaborate, the option prevents malicious attacks. It adds one more security layer to the authorization code flow in OAuth and OpenID Connect. |
| Redirect URL’s | Skip this field |
| Post Logout URL’s | Skip this field |
Once the values are entered, click on Save to save the configuration.
A token (Client Secret) will be generated automatically for each Application.
Copy or download the Token and Application ID to use it.
To regenerate a token for an application, click on the Key icon. If the token is regenerated, it should be updated in Confluence, where the previous token is used for uninterrupted information access.
Configuration Part II – Configure Prolaborate Macro in Confluence
Open Atlassian Confluence and log in as an administrator using valid credentials.
Click on Apps and then select Manage apps.
Under User-installed apps, Prolaborate will be present. Click on Configure on the app (Prolaborate Macro)
Enter the following details in the respective fields:
| Field | Description |
|---|---|
| Protocol | Protocol of Prolaborate site. (e.g., HTTP or HTTPS). |
| Server Name | IP of Prolaborate application server or its URL |
| Server Port | (Optional) Port of Prolaborate site |
| Client ID | An Application ID is given for Confluence at Prolaborate under Integrated Application Access Management. |
| Client Secret | A security token is generated for Confluence at Prolaborate under Integrated Application Access Management. |
| User ID | Enter the e-mail address of the Prolaborate User (Admin Account is preferred) |
Once the details are entered, click on Connect.
Once the connection is successful, you will see a list of repositories available in Prolaborate.
Select the repositories you want to include by enabling Include in Repository List. Optionally, set a repository as the default using Set as Default.
Click Save to complete the configuration process.
Sharing Diagrams in Confluence
Open the Confluence page in which you want to publish model information.
Click the add button and choose Prolaborate Macro.
Choose the Enterprise Architect Repository containing the diagram and select the Diagrams tab. Enter a search term, select a Stereotype or Type, and click Find.
A list of diagrams will appear based on your filters.
Before clicking Add, please note the options at the bottom of the window.
- Children Table – If you enable this option, details of objects on the selected diagram will be shown in a table on the page.
- Prolaborate Links – If you enable this option, links will be enabled in Objects. You can click on them to see their overview in Prolaborate.
- Artifact Path – Uncheck to hide the path of the Diagram.
- Borders: Show a grey border around the Published content
Click the Insert button to add the diagram.
Once the user adds the diagram and updates the page, the page will have the live image of the diagram that you have selected.
If Children Table is enabled, you will see the details of objects of this diagram in the table view.
Sharing Packages in Confluence
Open the Confluence page in which you want to publish model information.
Click the add button and choose Prolaborate Macro.
Choose the Enterprise Architect Repository containing the diagram and select the Packages tab. Enter a search term, select a Stereotype or Type, and click Find.
A list of packages will appear based on your filters.
Before clicking Add, please note the options at the bottom of the window.
- Children Table – If you enable this option, details of objects on the selected diagram will be shown in a table on the page.
- Prolaborate Links – If you enable this option, links will be enabled in Objects. You can click on them to see their overview in Prolaborate.
- Package Path – Uncheck to hide the path of the package.
- Borders: Show a grey border around the Published content
Click the Insert button to add the package.
Once the user adds the package and updates the page, the page will have the live image of the package that you have selected.
If Children Table is enabled, you will see the details of objects of this package in the table view.
Sharing Elements in Confluence
Open the Confluence page in which you want to publish model information.
Click the add button and choose Prolaborate Macro.
Choose the Enterprise Architect Repository containing the diagram and select the Elements tab. Enter a search term, select a Stereotype or Type, and click Find.
Before clicking Add, please note the options at the bottom of the window.
- Children Table – If you enable this option, details of objects on the selected diagram will be shown in a table on the page.
- Prolaborate Links – If you enable this option, links will be enabled in Objects. You can click on them to see their overview in Prolaborate.
- Element Path – Uncheck to hide the path of the element.
- Borders: Show a grey border around the Published content
Click the Insert button to add the package.
Once the user adds the element and updates the page, the page will have the live image of the element that you have selected.
If Children Table is enabled, you will see the details of objects of this element in the table view.
Share without Prolaborate Macro
Model information can also be published in Confluence without installing the Prolaborate Macro using any HTML Macro available in Confluence.
Note:
While it is possible to publish model information in Confluence using any HTML Macro, we do not recommend this approach due to potential security risks and the possibility of data leakage. To ensure the security of your data and maintain control over its access, we strongly advise using the Prolaborate Macro for publishing information in Confluence.
To know more on how to publish information in Confluence without Prolaborate Macro, click here.
