You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/developerportal/maia-plan.md
+34-11Lines changed: 34 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,6 @@ After you click **Start Building**, the **Start Development** window is displaye
123
123
124
124
***Mendix Planning Board (default)** – Use the Mendix planning board, where you can reorganize the sprints as needed.
125
125
***Jira** – Use Jira to organize and prioritize your work. To do that, follow the steps in the [Connecting to Jira](#connect-jira) section.
126
-
Make sure that the [prerequisites for using Jira](/developerportal/project-management/jira-connector/#prerequisites) are met.
127
126
128
127
{{% alert color="info" %}}
129
128
If you start prioritizing your work before Maia is done [finding recommendations](#recommender), recommended components are not displayed in the **Planning** window.
@@ -135,29 +134,53 @@ After you click **Start Building**, the **Start Development** window is displaye
135
134
136
135
#### Connecting Maia Plan to Jira {#connect-jira}
137
136
138
-
Follow these steps to connect Maia Plan to Jira.
137
+
Follow these steps to connect Maia Plan to Jira:
139
138
140
-
##### New Jira Projects
139
+
1. In the **Connect Planning Tool** window, select **Jira**.
140
+
2. Fill in the information as follows:
141
141
142
-
1. Create a new Jira project.
142
+
***Base URL Jira Environment** – 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.
143
+
***Project Key** – The unique key of your project within the Jira platform.
144
+
***Board ID** – The unique number which identifies a specific board in your Jira project/space.
145
+
***Jira Account** – The login name of a user on the Jira platform with project administration rights.
146
+
***API Token**: 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/).
147
+
148
+
Make sure that the [prerequisites for using Jira](/developerportal/project-management/jira-connector/#prerequisites) are met.
149
+
150
+
##### Configuring Jira for Maia Plan
151
+
152
+
Follow these steps to configure Jira for use with Maia Plan.
153
+
154
+
New Jira projects/spaces:
155
+
156
+
1. Create a new Jira project/space.
143
157
2. Ensure that the default board has the correct project filter. To do that, follow these steps:
144
158
145
-
1. Find your **Project key**. The project key is the short code that Jira assigns to your project. You can find it next your project name, in the top left corner of your Jira project. It is also available in the **Project Settings** window, which you can access from the context menu of your project.
159
+
1. Find your **Project key** or **Space key**. The project key is the short code that Jira assigns to your project. You can find it next your project name, in the top left corner of your Jira project. It is also available in the **Project Settings** window, which you can access from the context menu of your project.
160
+
{{< figure src="/attachments/developerportal/maia/space-key.png" alt="Board key field in Jira" max-width="30%" >}}
146
161
2. Click **Board Settings** in the context menu of your board.
147
-
{{< figure src="/attachments/developerportal/maia/board-settings-option.png" alt="Board Settings button in Jira" >}}
148
-
3. Set the filter to *project = <ProjectKey>*.
162
+
{{< figure src="/attachments/developerportal/maia/board-settings-option.png" alt="Board Settings button in Jira" max-width="30%" >}}
163
+
3. Set the filter to *project = "your project key"*.
149
164
150
-
##### Existing Jira Projects
165
+
Existing Jira projects/spaces:
151
166
152
-
1. Open your existing Jira project.
167
+
1. Open your existing Jira project/space.
153
168
2. Select the board you want to use with Maia Plan, or create a new one.
154
169
3. Ensure the board includes a filter for the project's Jira key:
155
170
156
171
* For an existing board:
157
172
158
173
1. Open **Board Settings**.
159
-
2. Confirm that the filter is set to *project = <ProjectKey>*.
174
+
2. Confirm that the filter is set to *project = "your project key"*.
160
175
161
176
* For a new board, select **All work items from your space**.
162
-
{{% alert color="warning" %}} When you select **All work items from your space**, a consolidated backlog view is created. This view includes work items from all boards in the project, not just those managed through Maia Plan. {{% /alert %}}
177
+
{{% alert color="info" %}} When you select **All work items from your space**, a consolidated backlog view is created. This view includes work items from all boards in the project, not just those managed through Maia Plan. {{% /alert %}}
178
+
179
+
#### Using Jira with Maia Plan
180
+
181
+
Once you have connected Maia Plan to Jira, you can start using Jira as your project management tool, as follows:
163
182
183
+
1. In Maia Plan, in the **Start Development** window, set the planning tool to Jira, as previously indicated.
184
+
2. Open the Jira board from Maia Plan. Your epics and stories are displayed in the Jira backlog.
185
+
3. Create an active sprint in Jira, if one does not already exist.
186
+
4. Move the stories you want to work on from the backlog into the active sprint. The stories in the active sprint are now also available in Studio Pro.
0 commit comments