Enterprise Architect and Microsoft Teams Integration
Nov 21, 2022
Prolaborate makes it easier to share real-time architecture and modeling information from your Sparx Systems Enterprise Architect (EA) models to Microsoft Teams.
There is no need to export/import or copy/paste data. It can be an open discussion on the most recent information from the EA models in Microsoft Teams.
Generate Security Token
In Prolaborate, click on Menu > Integrated Application- Access Management > Add Application
Enter the details as mentioned below.
| Field | Description |
|---|---|
| Name | Enter the application name |
| Application ID | Last Name |
| Authorization | Need to choose the required Authorization type from the list. |
| Scope | Need to choose the required Scope from the list. |
| Generate Security Token | Please Enable the Toggle Button |
| Enhance Security using PKCE | Please Enable the Toggle Button |
| Redirect URL’s | Please skip this field |
| Post Logout URL’s | Please skip this field |
Click Save once the details are entered.
Once saved, a Security Token Popup window will appear. Copy the Application ID and Token from this window. Also, it can be downloaded as CSV file.
Close the window once the token is copied.
If successfully added, users can see the application in Integrated Applications- Access Management
Users can copy the security token by clicking the key icon.
Add Prolaborate in Teams
To add Prolaborate in Microsoft Teams, click on Apps and search for Prolaborate.
Click on it and then on Add. Prolaborate will be added to Microsoft Teams.
If you are not able to find Prolaborate, download it using this link.
Configure Prolaborate
User can configure Prolaborate in two different methods.
- Configure Prolaborate App from Search bar
- Configure Prolaborate App from messaging extension
Configure Prolaborate App from Search bar
To configure Prolaborate in Microsoft Teams. Enter @Prolaborate in Search bar and choose Prolaborate app from the list.
Then Prolaborate app shows the empty list.
Now Click the Ellipses icon which is shown in the below screenshot.
Click the ellipsis icon as shown in the image above and then choose Settings.
Now Admin able to add Prolaborate V3 or Prolaborate V4 Repositories by using this same configuration wizard.
To Configure Prolaborate V4
If Client using Prolaborate V4, please choose V4.X to Configure V4 Repository in MS Teams integration.
Fill the form as per instructions below.
| Field | Description |
|---|---|
| Protocol | Protocol of Prolaborate website |
| Server | IP address of Prolaborate application server or its URL |
| Port | (Optional) Port of Prolaborate site |
| User Id | A Prolaborate user’s email id. Detailed notes given below. |
| Client Id | Client Id which is entered in Prolaborate while adding Microsoft Teams |
| Client Secret | Security token generated as instructed in the previous section |
Once the details are entered, click on Connect.
If the connection is successful, the list of repositories available in Prolaborate will be displayed.
Select a Repository and click on Save.
Configure Prolaborate App from messaging extension
Click extension icon from the Chat.
Search Prolaborate in “Find in Apps”
Right click “Prolaborate App” and click “Settings”
If Client using Prolaborate V4, please choose V4.X to Configure V4 Repository in MS Teams integration.
Fill the form as per instructions below.
| Field | Description |
|---|---|
| Protocol | Protocol of Prolaborate website |
| Server | IP address of Prolaborate application server or its URL |
| Port | (Optional) Port of Prolaborate site |
| User Id | A Prolaborate user’s email id. Detailed notes given below. |
| Client Id | Client Id which is entered in Prolaborate while adding Microsoft Teams |
| Client Secret | Security token generated as instructed in the previous section |
Once the details are entered, click on Connect.
If the connection is successful, the list of repositories available in Prolaborate will be displayed.
Select a Repository and click on Save.
Relevance of User Id
You might have configured the complete EA model in Prolaborate but might not want to expose everything to Teams users. This can be easily achieved by following the below steps:
- Create a new user in Prolaborate
- Set access only to the repositories, packages, diagrams, and objects which you want to expose to Teams users
- Use the email id of the user while configuring the Prolaborate app in Teams
Note:
- Prolaborate user should NOT be a SSO user
- There is no mapping done between Microsoft Teams or Prolaborate/EA users. The sole purpose of specifying a user in the configuration is to control what Teams users can see.
Share Diagrams and Collaborate
Share Diagram using Global Search
Open a Teams and type @Prolaborate in search bar to share diagrams and collaborate on them in Microsoft Teams.
Select the @Prolaborate app from the list.
Enter the diagram name in search bar.
Select the required diagram which is needs to share. Click Copy button from the diagram and paste the link in Chat.
Click Send Button.
This how the diagram looks in chat. If user want to see the same image in Prolaborate. Click the “Open in Prolaborate” button from the diagram
Share Diagram using Prolaborate Messaging Extension
Click the Prolaborate messaging extension.
If Prolaborate Extension not found. Please click the Ellipses and search for Prolaborate.
Enter a keyword or name of a diagram to search.
Select the diagram and click on Send.
The current state of the diagram will be posted in the channel.
Microsoft Teams can be used to have a discussion between the modelers and the business stakeholders.
A real- time view of the diagram can be seen by clicking Open in Prolaborate to view any changes made to the diagram.