Administrator's Guide - 1.0

The Agile Board Template Builder for JIRA add-on allows you to define one or more templates that define how an Agile Board is to be configured and then allow users to create boards themselves using these templates. You can also provide users with 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:

  1. Configure global settings
  2. Create Agile Board templates




Configuring Global Settings

While on the Add-ons administration page, select Global Settings in 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. Then, click Save to save your changes.




Creating Agile Board Templates

While on the Add-ons administration page, select Board Template Settings in the sidebar to define configurations and then the board templates that will use those configurations. The Board Template Settings page is divided into 4 sections: 3 relating to configurations of a board and 1 relating to the templates.

Since an Agile board's configuration includes settings for swim lanes, columns and quick filters, you must define those configurations (shown above as , and ) before defining any board templates (shown above as  above).

1 - Swim Lane Scheme configuration

To create a new Swim Lane Scheme configuration, supply a name and then click the  icon. You will then see the new configuration listed below the "add" box. 

Click Add Swim Lanes to be presented with a page in which you can define each swim lane.

Type a name for the new swim lane and the JQL query that defines the issues to appear within the swim lane. Then, 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 will be shown on any Agile Board built with that configuration, click the grabber bar () and drag a swim lane to the desired position.

 When you have finished defining each desired swim lane, click Close to return to the Board Template Settings page. Now the page shows 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 will then see the new configuration listed below the "add" box.

Click Add Columns to be presented with a page in which you can define the column configuration.

Type a name for the new column and select one or more statuses to appear in that column. Then, 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 will be shown on any Agile Board built with that configuration, click the grabber bar () and drag a column to the desired position.

 When you have finished defining each desired column, click Close to return to the Board Template Settings page. Now the page shows a list of the columns within that 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, supply a name and then click the  icon. You will then see the new configuration listed below the "add" box.
 

Click Add Quick Filters to be presented with a page in which 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. Then, 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 will be shown on any Agile Board built with that configuration, click the grabber bar () and drag a quick filter to the desired position.
 

When you have finished defining each desired 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 which define how a board created from this template should be configured.
 

To add a new Board Template, supply the following and then click the  icon to add it.

FieldDescription
NameThis is the name of the template, which users will see. This should be as descriptive as possible.
Board/Filter name prefix

This defines an optional prefix that will be added to each board and filter created when a user chooses to create an Agile board based on this template.

(tick) Be sure to add a space or some other delimiter like a colon or dash at the end of the prefix so the prefix will be 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 TypeThis indicates whether to create a Scrum or Kanban board from this template.
SwimlanesSelect the Swimlane Scheme configuration you want to use for the Board Template. If you do not supply one, then the user will have to configure the Swimlanes.
Quick FiltersSelect the Quick Filter Scheme configuration you want to use for the Board Template. If you do not supply one, then the user will have to configure the Quick Filters.
ColumnSelect the Column Scheme configuration you want to use for the Board Template. If you do not supply one, then the user will have to configure the Columns.

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've created configurations and an Agile Board Template, your users can create an Agile Board using this template! Read the User's Guide for more information.