Jira Software Integration

Overview

The SAP LeanIX for Jira integration lets you link Jira issues to SAP LeanIX fact sheets. Once you set up the integration, you can create and search fact sheets directly from Jira issues and monitor Jira issues from within SAP LeanIX. This makes it easy to keep track of ongoing initiatives and align on their progress.

📘

Note

The SAP LeanIX for Jira integration only supports Jira Cloud.

Benefits

• Link SAP LeanIX fact sheets to Jira issues: Access to your entire SAP LeanIX IT repository from your Jira projects. Link multiple fact sheets to an issue to provide your project teams with more context.
• Create and sync: Create new fact sheets, search for fact sheets within Jira tickets, and automate the synchronization of relevant data. This improves data quality across both tools for further collaboration and transparency.
• Track status updates: Monitor the development of Jira issues by adding them as resources on one or more fact sheets. This improves collaboration and links the fact sheets to the teams responsible for their continuous development.

Limitations

• You can connect only one SAP LeanIX workspace to a Jira account.
• You can only map text fields from your fact sheets. These correspond with the SAP LeanIX field type "string," including fields like name, description, or alias. Read more about field types in the topic Fact Sheet Fields.
• A fact sheet can only be paired with one Jira issue type. However, you can sync a single Jira issue type with multiple fact sheet types.
• There are no restrictions on fact sheet creation in Jira. After you integrate an SAP LeanIX workspace with Jira, all Jira users can create fact sheets within Jira issues.

Configuration

Prerequisites

• In SAP LeanIX:
  • Administrator access to your workspace.
  • An API token. To get an API token, create a technical user. Learn how in Technical Users.
• Jira administrator access.

📘

Note

Only Jira admins can install Atlassian apps. If you don’t have an admin account, contact your Jira admin for help with installing SAP LeanIX for Jira.

Step 1: Install the SAP LeanIX for Jira App

The SAP LeanIX for Jira app is available for download from the Atlassian Marketplace. This means you can find and install the app without leaving your Jira instance.

To install SAP LeanIX for Jira, follow these steps:

1. In the top navigation bar in Jira, go to Apps > Find new apps.
2. Enter “SAP LeanIX for Jira” in the search field and choose the app tile.
3. Choose Get app.

Step 2: Configure the SAP LeanIX for Jira App

After you install SAP LeanIX for Jira, the next step is to connect the app to your SAP LeanIX workspace. You will do this in the Jira administration.

To configure SAP LeanIX for Jira, follow these steps:

1. In the top navigation bar in Jira, go to Apps > Manage apps.

2. To find SAP LeanIX for Jira, navigate the list or search for it in the Filter visible box. Click the app listing to open the app details.

3. Choose Configure to open the configuration options.

4. Enter the following information:

   1. Host: The main domain where the application is hosted. For example, your-subdomain.leanix.net. You don’t need to enter the protocol (https://).
   2. Workspace Name: The specific workspace within SAP LeanIX. For example, DemoEAM.
   3. API Token: The unique identifier from SAP LeanIX that allows Jira to access your workspace. To get an API token, create a technical user. Learn how in Technical Users.

5. Choose Save.

   
   

Linking Jira Issues to SAP LeanIX Fact Sheets

Link your fact sheets to relevant Jira issues to add context to the initiatives you’re tracking in Jira. You can use synchronization mappings to automate the data exchange between linked issues and fact sheets.

To link a Jira issue to an SAP LeanIX fact sheet, follow these steps:

1. Open an existing Jira issue in one of your Jira projects.
2. In the Glance view, choose the SAP LeanIX fact sheet icon.
3. Choose Link a Fact Sheet.
4. Search for the fact sheet that you want to link to the issue and select it. Once the fact sheet is linked, you will see the fact sheet under Linked Fact Sheets in Jira.

👍

Tip

To unlink a fact sheet from an issue, open the Glance view, hover over the fact sheet name, and choose Unlink.

Creating Synchronization Mappings

📘

Note

You can only map text fields from your fact sheets. These correspond with the SAP LeanIX field type "string," including fields like name, description, or alias. Read more about field types in the article Fact Sheet Fields.

Synchronization mappings allow you to synchronize Jira with your SAP LeanIX meta model. You can sync each fact sheet type with one Jira issue type. However, a single Jira issue type can be synced with multiple fact sheet types.

To create a synchronization mapping, follow these steps:

1. In the top navigation bar in Jira, go to Apps > SAP LeanIX Synchronization Mappings.
2. Choose Add project.
3. Search the name of the project you want to sync and select it.
4. Choose Add to sync a new fact sheet type and issue type.
   1. Select the fact sheet type (for example, project) and the issue type (for example, epic).
   2. Choose Add Field Mapping.
   3. Select the SAP LeanIX text field (for example, name).
   4. Select the direction (for example, bidirectional).
   5. Select the Jira issue type (for example, summary).
5. Repeat these steps for all text fields that you want to sync and choose Add. The synchronized fact sheet type will appear in the synchronization mappings list.

To display the details of a synchronization mapping, choose the expand arrow.

👍

Tip

To delete a synchronization mapping, choose Delete. This removes all synced fact sheets from the corresponding Jira issues. This can’t be undone.

📘

Note

Only Jira admins can create synchronization mappings.

Syncing Jira Issues with SAP LeanIX Fact Sheets

Sync the fact sheet type defined in the synchronization mappings for a project to the corresponding Jira issue type. This allows you to view the Jira issue name, status, and assignee of synced Jira issues on the Resources tab of the corresponding fact sheet in SAP LeanIX.

To sync a Jira issue with an SAP LeanIX fact sheet, follow these steps:

1. Open the Glance view in a Jira issue.
2. Choose Sync a Fact Sheet.
3. Search for the fact sheet that you want to sync and select it. After the sync is complete, you will see the synced fact sheet under Synced Fact Sheet.

👍

Tip

To unsync a fact sheet from an issue, open the Glance view, hover over the fact sheet name, and choose Unlink. Alternatively, you can remove the Jira issue listed on the Resources tab of the respective fact sheet.

Viewing Issues on Fact Sheets

After you link a Jira issue to a fact sheet, you can view the details for the linked Jira issue on the Resources tab of the corresponding fact sheet.

Creating Fact Sheets in Jira

You have the option to create new fact sheets on the fly in Jira. When you create a fact sheet from an issue in Jira, it will be synced or linked to the Jira issue accordingly.

To create a fact sheet in Jira, follow these steps:

1. In the Glance view, choose the SAP LeanIX fact sheet icon.
2. In the Select box type the name of the new fact sheet and choose Create new Fact Sheet [Name]. Your search term automatically becomes the name for the new fact sheet. If a synchronization mapping is defined for the issue type, the corresponding type is selected as the fact sheet type.
3. Choose Save. The created fact sheet will appear in the list of synced or linked fact sheets.

Searching for Fact Sheets in Jira Advanced Search Using JQL

The SAP LeanIX for Jira integration adds some properties to Jira issues that let you filter with JQL. You can use the following properties:

• factSheetCount
• linkedFactSheetCount
• syncedFactSheetCount
• syncFactSheetId
• syncFactSheetType

You can use these properties in JQL queries to extract specific information about fact sheets and related Jira issues. Here are some examples: