4. Configuration Options Description
- Jonathan Muse
- Iryna Ihnatiuk
Template configuration
Template name
The template name is the name that users will see when they create a project from a Gaia Template. Template names must be unique and alpha numeric.
Template description
The template description is shown in the list of templates in the administrative section of Gaia. Use it to describe the purpose of the template.
Issue File configuration
Issues template
1. Do not import a Jira issues file
Select this option if you don't want to import issues when creating projects from the template. This is the default option when creating a template.
2. Import your own Jira issues file
Specify an XML Jira issues file in your template. This file is a set of predefined issues that will be instantiated with a new project. The Jira issues file will be stored on the server.
If an issue type in the Jira Issue file is not in the issue type scheme you've selected, Gaia will choose the default issue type from the default issue type scheme. If no default issue type is set,
- for Jira 7.x/8.x: the missing issues will be created and added to the Default Issue Type Scheme. If you feel this is not what you want, then create, then add the issue type "Task" in the selected issue type scheme, then associate all unknown issue types with "Task"
Supported Custom Fields
Supported Jira native custom fields :
- Checkboxes;
- Date Picker;
- Date Time picker;
- Group Picker (multiple groups);
- Group Picker (single group);
- Labels;
- Number Field;
- Radio Buttons;
- Select List (cascading)
- Select List (multiple choices);
- Select List (single choice);
- Text Field (multi-line);
- Text Field (single line);
- URL Field;
- User Picker (multiple users);
- User Picker (single user);
- Version Picker (multiple versions);
- Version Picker (single version).
Supported Apps custom fields :
- Okapya Checklist;
- Tempo Team;
- Portfofio Team.
Please know that third party and apps custom fields are not supported per se. Contact us if you need them to be imported.
Issues comments
Tempo Teams
Tempo Teams
This setting is only present if the Tempo plugin is installed and is enabled. If enabled, this setting will make the option to create a tempo link appear when the template is selected while configuring a new project to create.
Project Configuration
Project description
In this field, add the default project description to add to the Jira project. This description is visible in the summary when you select the project.
More info on Project descriptions can be found here https://confluence.atlassian.com/adminjiraserver/defining-a-project-938847066.html
Project Type
Select if you wish this project to be categorized as a Business (Jira Core), a Software (Jira Software) project or a Service Desk project.
Project category
Projects can have categories to help with sorting and other Jira features. The default category for each created project can be set.
More info on Project categories can be found here: https://confluence.atlassian.com/adminjiraserver/defining-a-project-938847066.html
Issue Type Scheme
Select the issue type scheme to apply when new projects are created. An issue type scheme determines which issue types will be available for a set of projects.
Jira Agile (for Jira 6 and previous)
If you plan to create a Jira Agile Scrum board with your project, it is HIGHLY recommended to use the Agile Scrum Issue Type Scheme or any Issue Type Scheme based on it, since this Scheme includes all the issue types needed by Jira Agile.
Jira Core
In Jira Core, the Default Issue Type Scheme is empty by default. To avoid badly created projects, it is recommended that you create your own Issue Type Schemes for all your projects, and associate them with Gaia templates.
More info on Issue Type Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/associating-issue-types-with-projects-938847092.html
Workflow Scheme
Select the workflow scheme to apply when new projects are created. A workflow scheme determines which workflow is used for each issue types in the project.
JIRA Agile
If you plan to create a Jira Agile board with your project, be aware that if you are not using the Default Workflow Scheme with Jira Agile, the issues might not show up on your Jira Agile board. In this case, you might have to manually configure the board to map any unmapped workflow status to Jira Agile. See https://www.atlassian.com/agile/tutorials/creating-your-agile-board
More info on Workflow Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/managing-your-workflows-938847410.html
Issue Type Screen Scheme
Select the issue type screen to apply when new projects are created. An Issue Type Screen Scheme allows you to choose which Screen Scheme is used for each issue type in the project.
More info on Issue Type Screen Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/associating-screen-and-issue-operation-mappings-with-an-issue-type-938847305.html
Field Configuration Scheme
Select the field configuration scheme to apply when new projects are created. Field Configuration Schemes determine which Field Configurations apply to issue types in the project.
More info on Field Configuration Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/associating-field-behavior-with-issue-types-938847262.html
Issue Security Scheme
Select the security scheme to apply when new projects are created. Issue Security Schemes allow you to control who can and cannot view issues. They consist of a number of security levels that can have users/groups assigned to them.
More info on Issue Security Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/configuring-issue-level-security-938847117.html
Notification Scheme
Select the notification scheme to apply when new projects are created. Notification Schemes allow you to control who to notify when a given event fires.
More infos on Notification Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/configuring-issue-level-security-938847117.html
Permissions Scheme
Select the permission scheme to apply when new projects are created. Permission Schemes allow you to create a set of permissions for users and apply this set of permissions to any project.
More infos on Permission Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html
Priority Scheme
This option will only appear if you have Jira Server 7.6 or above.
Select the priority scheme to apply when new projects are created. Priority Schemes allow you to create a set of priorities for issues and apply this set of priorities to any project.
More infos on Priority Schemes can be found here: https://confluence.atlassian.com/adminjiraserver/associating-priorities-with-projects-939514001.html
Scheme Duplication
Under each scheme selection dropbox, there is an "Enable scheme duplication" option. When checked, this enables that scheme to be duplicated at the project creation. However, the user creating the project using that template must choose to create a copy of the schemes at that moment. Only the schemes with the "Enable scheme duplication" option checked will be duplicated and applied to the newly created project.
In the case of the Workflow scheme and the Issue type screen scheme, you also have to option to include their child objects in the duplication.
Filters
This option, when enabled, creates a project-specific filter for each issue type found in your project and a filter for all issues in the project. These filters are shared with all users. This can be useful to quickly create dashboards with custom filters to help your team use the system.
Components
This option lets you add a list of components that will be added at the creation of a project.
About Components
Please note that if you are importing issues (configured in the Issues Template setting) that are associated with components, and that you have not defined those components in your Gaia template, the missing components will be automatically created and associated with the issues being imported.
Versions
This option let you add a list of versions that will be added at the creation of a project.
About Versions
Please note that if you are importing issues (configured in the Issues Template setting) that are associated with versions, and that you have not defined those versions in your Gaia template, the missing versions will be automatically created and associated with the issues being imported.
Dashboard
This option automates the creation of a pre-defined dashboard when creating a project. As of this writing, there are three pre-defined dashboards in Gaia for Jira :
- A checklist dashboard to display the relations between Tasks and their associated Sub-tasks. This is based on the default template "Checklist for Product Owner".
- A software development dashboard to keep project leads up to date with their project progress in a single view (this dashboard is partially based on this post https://www.atlassian.com/blog/jira-software/5-steps-to-build-a-killer-dashboard).
- Agile Dashboard to show content that’s relevant for agile teams. The Jira Dashboard for Agile projects is based on this post https://www.atlassian.com/blog/jira-software/7-steps-to-a-beautiful-and-useful-agile-dashboard.
To enable the automated adding Dashboards and Filters when creating a project, confirm if the Sharing with anyone on the web functionality is on.
Jira Agile Board
This option is only enabled when you have Jira Agile or Jira Software installed and enabled on your system. You can find more information on Jira Agile here.
This option automates the creation of Jira Boards when creating a project.
Space configuration
Space template
Note
Please note that using a template that needs to create a Confluence space requires that you have an application link setup between your Jira and your Confluence instance.
1. Do not import a Confluence space template
Choose this option if you don't want to associate a Confluence space to your template. Therefore, no Confluence space will be created when creating new projects from this Gaia template. You should check this option if you don't have Confluence installed.
2. Import your own Confluence space template
Choose this option to import your own Confluence space template when you create new Gaia projects.
See how to create my own Confluence template file for the complete procedure.
Project Roles
This setting lets you select the roles you want to associate with the project that will be created. You can include multiple choices.
Project Roles
Please note that you are to provide the username of the user and not its full name. When the project is created using a template that contains Project Roles, only existing and active users and groups will be taken into consideration. All invalid users and groups will be omitted at the time of the project creation.
Knowledge level | MEDIUM |
---|---|
Access level required | NONE |
Table of contents