Skip to content

Commit a8ca045

Browse files
Merge pull request #11536 from olaf-joppe/development
Update jira-connector.md
2 parents a97b84d + 3faf712 commit a8ca045

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

content/en/docs/developerportal/project-management/jira-connector.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you are a Scrum Master of a Mendix app, you can link your app to Jira if you
2323
* For a team-managed board, the **Stories** pane shows all stories from your board, which may include your backlog. If you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog, and using a separate board to manage your backlog.
2424

2525
* Allows you to change the status of a story or mark a task as **Done** from the [Stories pane](/refguide/stories-pane/) in Studio Pro.
26-
* Converting your [feedback items](/developerportal/app-insights/feedback/) in App Insights will result in a story in Jira.
26+
* Converting your [feedback items](/developerportal/app-insights/feedback/) in App Insights results in a story in Jira.
2727

2828
## Limitations
2929

@@ -32,15 +32,16 @@ As we further develop this feature, we may lift these limitations with future re
3232
{{% /alert %}}
3333

3434
* Feedback issues, and stories from Epics are not migrated to Jira.
35-
* When a feedback item is being converted to an issue, the story type, title, and description of the issue will be set. If your Jira configuration requires additional mandatory fields, this process might not work.
35+
* When a feedback item is being converted to an issue, the story type, title, and description of the issue are set. If your Jira configuration requires additional mandatory fields, this process might not work.
3636

3737
## Prerequisites
3838

3939
* You need to have the [Scrum Master](/developerportal/general/app-roles/#team-roles) role for the app.
4040
* You need to have an active subscription to Jira Software Cloud.
41+
{{% alert color="info" %}} Local or on-premises installations are not supported.{{% /alert %}}
4142
* You need to have a project in Jira with a Scrum board, a Kanban board, or a team-managed board.
42-
* You need to have a user account and API token with administration rights to the project in Jira. For more information on how to get this API token, see [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
43-
* To convert feedback items to stories in Jira, your project in Jira must have the issue types "Story" and "Bug". For more information on how to set up issue types for your project, see [Associate issue types with projects](https://support.atlassian.com/jira-cloud-administration/docs/associate-issue-types-with-projects/).
43+
* You need to have a user account and API token with administration rights to the project in Jira. For more information on how to get this API token, refer to [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
44+
* To convert feedback items to stories in Jira, your project in Jira must have the issue types **Story** and **Bug**. For more information on how to set up issue types for your project, refer to [Associate issue types with projects](https://support.atlassian.com/jira-cloud-administration/docs/associate-issue-types-with-projects/).
4445

4546
## Procedure
4647

@@ -55,10 +56,10 @@ To connect your app to Jira, perform the following steps:
5556
4. Click **Connect Jira**. The **Set Up Jira Configuration** dialog box opens.
5657
Fill in the information as follows:
5758

58-
* **URL Jira Environment**: This is the URL of your company’s environment within the Jira platform, as provided by Jira. This URL usually looks like this: `https://my-company.atlassian.net`.
59-
* **Project Key**: This is the unique key of your project within the Jira platform.
60-
* **Admin User**: This is the login name of a user on the Jira platform with project administration rights.
61-
* **API Token**: This is a valid API token issued by the Jira platform and assigned to the above-mentioned admin user. For more information on how to get this API token, see [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
59+
* **URL Jira Environment** This is the URL of your company’s environment within the Jira platform, as provided by Jira. This URL usually looks like this: `https://my-company.atlassian.net`.
60+
* **Project Key** This is the unique key of your project within the Jira platform.
61+
* **Admin User** This is the login name of a user on the Jira platform with project administration rights.
62+
* **API Token**This is a valid API token issued by the Jira platform and assigned to the above-mentioned admin user. For more information on how to get this API token, refer to [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
6263

6364
5. Click **Next**.
6465

@@ -72,7 +73,7 @@ Once the activation is completed, your app is connected to Jira. You can see the
7273

7374
* If you connect your app to a Scrum board in Jira, the **Stories** pane shows all stories from all your active Sprints.
7475
* If you connect your app to a Kanban board, the **Stories** pane shows all stories from your board, taking the filter and sub-query of the board settings into account, ordered by story key.
75-
* You can find the filters and sub-query in the board settings in Jira (for more information, see [Configure a company-managed board](https://support.atlassian.com/jira-software-cloud/docs/configure-a-company-managed-board/)).
76+
* You can find the filters and sub-query in the board settings in Jira. For more information, refer to [Configure a company-managed board](https://support.atlassian.com/jira-software-cloud/docs/configure-a-company-managed-board/)).
7677
* If you connect your app to a team-managed board, the **Stories** pane shows all stories from your board, which may include your backlog.
7778
* If you do not wish to see backlog stories in Studio Pro, consider setting up your board without a backlog, and using a separate board to manage your backlog.
7879
* The list of stories is ordered by the Jira story key.
@@ -90,6 +91,6 @@ After you activated the Jira connector, you can review the configuration details
9091

9192
If you need to connect to a different Jira environment, or need to rotate the API key used by the Jira connector, click **Edit Connection Details**. If you want to switch to a different Jira board within the same environment, click **Change Board**.
9293

93-
In order for the Jira connector to work, Mendix caches some information from your Jira board in our system. This include the name of the estimation field that you use to set story points, as well as the status schema that you use in your board. If this information changes in Jira, you may need to refresh the cache by clicking **Reconnect**.
94+
In order for the Jira connector to work, Mendix caches some information from your Jira board in our system. This includes the name of the estimation field that you use to set story points, as well as the status schema that you use in your board. If this information changes in Jira, you may need to refresh the cache by clicking **Reconnect**.
9495

95-
If you no longer wish to use the Jira connector, simply click **Deactivate Connection**. This will revert your project management tool automatically to [Epics](/developerportal/project-management/epics/).
96+
If you no longer wish to use the Jira connector, simply click **Deactivate Connection**. This reverts your project management tool automatically to [Epics](/developerportal/project-management/epics/).

0 commit comments

Comments
 (0)