The Agile Board Template Builder for Jira app allows you to define one or more templates that determine how an Agile Board is to be configured to allow users to create boards using these templates. You can also provide users the ability to request a board be created from a template, and then have certain users or groups process the request and create a board (or reject the request).
The typical steps you would follow to define templates and make them available for use are:
You also have /wiki/spaces/ABTB/pages/60817443 in the configuration that helps you migrate content from Delegated Project Creator for Jira Agile to Agile Board Template Builder.
Configure Global Settings
While on the Manage apps page, select Global Settings from the sidebar to configure the settings that affect all Agile boards created from an Agile board template.
By default, a user can create Agile Boards from an Agile Board Builder template that has the same name as an existing board. Select the Prevent duplicate board names checkbox if you want to prevent this from happening. Click Save to save your changes.
Create Agile Board Templates
While on the Manage apps page, select Board Template Settings from the sidebar to define configurations and then the board templates that use those configurations. The Board Template Settings page is divided into four sections: three configure a board and one to create templates.
Since an Agile board's configuration includes settings for swim lanes, columns and quick filters, you must define those configurations (shown above as 1, 2, and 3) before defining any board templates (shown above as 4 above).
1 - Swim Lane Scheme configuration
To create a new Swim Lane Scheme configuration, enter a name and then click the icon. You see the new configuration listed below the "add" box.
Click Add Swim Lanes to navigate to the window in which you can define each swim lane.
Change the Base Edit Swimlanes drop down to select other swimlanes like Stories, Assignees, Epics, and Project.
When you finished selecting other Swimlanes apart from Queries., click Close to return to the Board Template Settings page. Now the page displays swim lanes within that configuration.
When selecting Queries swimlanes type a name for the new swim lane and the JQL query that defines the issues to appear within the swim lane. Click Add. If you determine that you created a swim lane in error, just click Delete next to that swim lane. If you want to change the sequence in which the swim lanes are shown on any Agile Board built with this configuration, click the grabber bar () and drag a swim lane to the intended position.
When you have finished defining each desired swim lane, click Close to return to the Board Template Settings page. Now the page displays a list of the swim lanes within that configuration.
With the newly created Swim Lane Scheme configuration, you can:
- Rename it by hovering over its name and then clicking the pencil icon () that appears. When you are through, click the icon to save your changes or the icon to discard your changes.
- Edit it by clicking Edit.
- Remove it by clicking the icon.
2 - Column Scheme configuration
To create a new Column Scheme configuration, supply a name and then click the icon. You see the new configuration listed below the add box.
Click Add Columns to navigate to the window, where you can define the column configuration.
Type a name for the new column and select one or more statuses to appear in that column. Click Add. If you determine that you created a column in error, just click Delete next to that column. If you want to change the sequence in which the columns are displayed on any Agile Board built with this configuration, click the grabber bar () and drag a column to the intended position.
When you have finished defining each intended column, click Close to return to the Board Template Settings page. Now the page displays a list of the columns within the configuration.
With the newly created Column Scheme configuration, you can:
- Rename it by hovering over its name and then clicking the pencil icon () that appears. When you are through, click the icon to save your changes or the icon to discard your changes.
- Edit it by clicking Edit.
- Remove it by clicking the icon.
3 - Quick Filter Scheme configuration
To create a new Quick Filter Scheme configuration, enter a name and click the icon. You see the new configuration listed below the add box.
Click Add Quick Filters to navigate to the window where you can define the quick filters configuration.
Type a name for the new quick filter and the JQL query that defines the issues to appear within that quick filter. Click Add. If you determine that you created a quick filter in error, just click Delete next to that quick filter. If you want to change the sequence in which the quick filters are displayed on any Agile Board built with this configuration, click the grabber bar () and drag a quick filter to the intended position.
When you have finished defining each intended quick filter, click Close to return to the Board Template Settings page.
With the newly created Quick Filter configuration, you can:
- Rename it by hovering over its name and then clicking the pencil icon () that appears. When you are through, click the icon to save your changes or the icon to discard your changes.
- Edit it by clicking Add Quick Filters.
- Remove it by clicking the icon.
4 - Board Templates
Now that you have defined your configurations, you can establish a Board Template. A Board Template is a collection of items that define how a board created from this template should be configured.
To add a new Board Template, enter the following and click the icon to add it.
Field | Description | Default |
---|---|---|
Name | This is the name of the template that the users see. This should be as descriptive as possible. | |
Board/Filter name prefix | This defines an optional prefix that is added to each board and filter created when a user chooses to create an Agile board based on this template. Ensure to add a space or some other delimiter like a colon or dash at the end of the prefix so the prefix is separated from the rest of board or filter name. For example, if you specify "StdKanban: " as the prefix, then a board named "My Board" created using this template would end up being named "StdKanban: MyBoard." | |
Board Type | This indicates whether to create a Scrum or Kanban board from this template. | Scrum |
Swimlanes | Select the Swimlane Scheme configuration to be used in the board template. If you do not provide one, the user has to configure the Swimlanes. | |
Quick Filters | Select the Quick Filter Scheme configuration to be used in the board template. If you do not provide one, the user has to configure the Quick Filters. | |
Column | Select the Column Scheme configuration to be used in the board template. If you do not provide one, the user has to configure the Columns. | |
Estimation | Select the estimation statistic configuration to be used in the board template. You can choose from the following estimation options:
| Story Points |
With the newly created Board Template, you can:
- Edit any field by hovering over its name and then clicking the pencil icon () that appears. When you are through making your changes to any field, click the icon to save your changes or the icon to discard your changes.
- Remove it by clicking the icon.
Next steps
Once you have created configurations and Agile Board Template, your users can create an Agile Board using this template! Read the User's Guide for more information.
Data Migration Utility
This section explains in detail the migration of configuration details from the Jira Software Schemes tab in Delegated Project Creator for Jira Agile to Agile Board Template Builder. To help the administrators with the migration process, Data Migration Utility is added to the Agile Board Template Builder configuration.
Before starting the migration process, ensure that the Delegated Project Creator for Jira Agile app is enabled in your Jira instance.
Steps
Log into your Jira instance as an administrator.
- Navigate to JIRA ADMINISTRATION > Manage apps > search for Delegated Project Creator for Jira Agile > upgrade the app with the latest version (v1.2) from Marketplace.
Navigate to JIRA ADMINISTRATION > Manage apps > search for Agile Board Template Builder > install/upgrade the app to the latest version from Marketplace. Notice that you have a third tab as a part of the configuration in the AGILE BOARD TEMPLATE BUILDER section in the left sidebar.
If you do not see this tab, it can be because you have disabled Delegated Project Creator for Jira Agile in your Jira instance.
Click the Data Migration Utility tab from the left sidebar to navigate to the Data Migration Utility page. This page lists all the Board templates and scheme configurations including Column, Swimlane, and Quick filter from Delegated Project Creator for Jira Agile that are ready to be migrated.
Click Migrate now! to start the migration process. You see a success message after the migration is complete.
Navigate to AGILE BOARD TEMPLATE BUILDER > Board Template Settings from the sidebar to see all the migrated templates, swimlanes, columns, and quick filters migrated into the Board Template Settings page.
It is recommended to disable Delegated Project Creator for Jira Agile once the migration is complete. To do so, navigate to Manage apps > search and expand the Delegated Project Creator for Jira Agile section > click Disable.
- Any new board template(s) or a scheme configuration(s) added to Delegated Project Creator for Jira Agile post migration can be migrated to Agile Board Template Builder by following the same process from step 2 to 4. In such a scenario, the Data Migration Utility page is displayed as:
- New board templates added in Agile Board Template Builder are now automatically available for use with project templates from the Board templates drop-down field in Edit project template dialog.
Notice that the Jira Software field is displayed when Delegated Project Creator for Jira Agile is enabled in your Jira instance and disappears when the app is disabled.