Please enable JS

Enterprise Architect Jira Integration

July 03, 2020

You can integrate Enterprise Architect with Jira through Prolaborate. Creating a two-way link between Enterprise Architect elements (say Use case) and Atlassian Jira issues (say Epic) just got easier through Prolaborate.

With this integration, you can

  1. Easily link Architecture information with Tasks, Requirements or Issues.

    These links can be viewed only in Prolaborate but also in EA. A link back to Prolaborate is introduced in Jira as well.

  2. View filtered information from Jira alongside rich architecture dashboards.

Here’s a quick overview of the Jira Integration:

The workflows involved are

  1. Configure Jira Integration
  2. Link Jira issues to Enterprise Architect elements
  3. View Live Jira Reports in Dashboard
  4. Manage Integrations
  5. Manage Integration Attributes

Configure Jira Integration

Enable Jira Integration

To integrate with Jira, the integration needs to be enabled first. Click on Menu > Manage Applications.

If Jira is in Inactive state, click on Edit and toggle the Status. No change needs to be done if Jira is already Active.

Configure Jira Account

To create the integration bridge, you need to create an application as detailed below.

Click on the Menu > Integrations. You will be taken to the Integrations page.

Click on Add New Project to add a Project and enter the details as below:

Field Description
Name Enter a name which can be understood by your users. For example, name of the Jira project which you are going to select.
Description Give a description to the application
Status It would be set to Active as Default. Please do not change it unless you don’t want to use it anywhere in Prolaborate
Application Choose Jira
Application URL Enter the URL of your Jira account. For example,
Username and Password

If you are using Jira Server, enter the Username and Password of a Jira account. Please note, Prolaborate’s access to Jira will depend on these credentials.

If you are using Jira Cloud, generate an API token and use it in the place of password. Learn more here.

Validate Connection Click on this button once you have entered Application URL, Username and Password. If the credentials worked fine, you will get a success message and Projects field will be enabled.
Project Select a Project which you want to Connect to. If you use multiple projects in Jira, you can add another project in a similar way.

Click on Add Project to complete adding the project and the new project will appear in the Integrations page.

Link Jira issues to Enterprise Architect elements

Add Jira Attribute

As we want the Jira link to be a part of Enterprise Architect’s items, we need to create an Jira attribute and configure it for the stereotypes we need. If you want the Jira attribute to be a part of all stereotypes, that can be done as well.

Click on Menu > Modeling Languages.

Click on Manage Custom Attributes button on the top and you will see the list of custom attributes which are already created in this repository.

Click on Add and choose Attribute Type as Integration Attribute. Fill in the following details:

Field Description
Name Give a name to the Attribute. “PROL_” will be prepended by default
Application As of now, only integration with Jira is possible. So, you can select All or Jira
Project Select the Project
Item Type Select the Item Type(s) you want to link in Prolaborate. This will be useful if you want to refine the list of Jira issues you want to see in Prolaborate.

Click on Save to add the new integration Attribute.

Add Jira Attribute to a Stereotype’s Form

Let’s configure the newly created Integration Attribute to a Stereotype. By doing this, we will be able to add a Jira issue link to that stereotype.

For example, let’s add it to Activity stereotype belonging to BPMN 2.0. In the Modeling Languages page, click on Manage Profiles to see the list of Profiles created for this MDG.

Click on Edit on the Active profile.

Click on the Form Designer of the Stereotype you want to add the Jira attribute to. As per our example, it is Activity.

Add the Jira attribute from Custom Attributes section to the form.

Save the form and click on Update Profile in Edit Profile page to save the changes.

Link Jira issues to EA elements

When you open the Properties window of the stereotype which we configured just now, it will show the Jira attribute.

Click on the plus icon in the attribute and select a Project in the Add Links window.

All the issues which are part of the Project will appear in this window. Please note the issue types which get shown here will be based on the Item type you chose while adding this integration attribute.

You can Search for the item if you know the title of the Jira item or you can filter the list by item type using the All Item Type dropdown.

Select a Jira item which you want to link to this Enterprise Architect item and click on Add. Click on Save in the Properties Window of this item.

Preview JIRA Issues

After you save, click on References in the Properties window. All the Jira links which you have added will be visible here.

Click on the eye icon to preview the Jira issue.

As you notice, Jira bubbles will be added on the element in the diagrams along with the count of the Jira issues it has been linked to. You can even click on that bubble to see the list of Jira issue links.

You can see all the basic details of the issue from Prolaborate itself. To view the complete details and to edit this issue, click on Open in Jira.

Jira issue will open in a new tab and if you notice, a link to this Enterprise Architect element has also been added.

View Live Jira Reports in Dashboard

Select Integration Report widget in Dashboard. Read about Dashboards here.

Select Jira under Application and the Filter.

How it looks in the Dashboard?

The complete list of items from Jira will be shown in the widget.

You can

  1. Click eye icon to preview the item
  2. Click on Jira ID to open a specific item
  3. Click on View on Jira to open the filter in Jira
  4. Click on Table View to see the complete list of items as you can only see 10 Jira items in the dashboard

View All in Jira works in the same way as View in Jira in Dashboard.

Manage Projects

You can edit or delete the Projects from the Integrations page.

Click on edit icon to edit a Project.

Update the password in Prolaborate if your password has expired in Jira and you have updated it.

Manage Integration Attributes

You can view or delete Integration attributes from the custom attributes window.