How to create and configure a new Button?

Configure Jira buttons with custom design, display rules, actions, templates, and behaviors.

1. How to create a new Button using the App Configuration Panel ?

Required Jira Role: Jira Software Administrator

  • Click on Setting > Apps
  • Navigate to the Create and Link App

Click on the following Button to create a new Issue Picker

2. How to configure the Button - Look & Feel  ?

Required Jira Role: Jira Software Administrator

During the creation Phase of the Button, the following Look & Feel parameters should be completed:

Parameter Syntax Description
Label Text
Mandatory
Provide a name for your Button.
Description Text
Optional
Describe your Button.
Enabled Checkbox
Default: Yes
Toggle the Button between enabled, usable by Jira users, and disabled, temporarily removed from view screens.
Text Color Hex Color Codes
Default: #43536e
Use the Color picker to configure the Button Text Color.
Color picker example
Background Color Hex Color Codes
Default: #f5f6f7
Use the Color picker to configure the Button Background Color.
Highlight Text Color Hex Color Codes
Default: #43536e
Use the Color picker to configure the Button Highlight Text Color.
Highlight Background Color Hex Color Codes
Default: #f5f6f7
Use the Color picker to configure the Button Highlight Background Color.
Round Checkbox
Default: No
Toggle between round and normal Buttons.
Icon Default: No Icon On the left side of the Button Text, you can add an Icon.

The App provides the following Icons:
Icon dropdown list
i
If you need another Icon, please check this page and let us know which Icon we should add:
https://atlassian.design/components/icon/icon-explorer

3. How to configure the Button - Display Settings  ?

Required Jira Role: Jira Software Administrator
Please switch to the second Tab “Display Settings” to define where and when the button should be displayed:

ParameterSyntaxDescription
Source ProjectsProject Picker
Mandatory
Please select the projects where you want to place your button on the view screen.
Source Issue TypesIssue Type Picker
Mandatory
Please select the issue types where you want to place your button on the view screen.
The list of issue types is restricted to only those relevant to the previously selected projects.
Filter (JQL)JQL Expression
Optional
You can add an optional condition for displaying the button by defining a JQL (Jira Query Language) statement. Please make sure the JQL statement is correct and that, together with the selected source projects and source issue types, it leads to meaningful results.
The JQL statement syntax is checked by the app.
Filter (JQL)
asasasasas
Error in the JQL Query: Expecting operator before the end of the query. The valid operators are =, !=, <, >, <=, >=, ~, !~, IN, NOT IN, IS and IS NOT.
PermissionsPicker
Optional
You can add an optional condition for displaying the button by defining specific permissions. Please select first the permission type:
Permissions
Select...
Groups
Users
Project Roles
The app will list you all valid parameters, and you can select one or several values:
Permissions
Project Roles
Administrators ×atlassian-addons-project-access ×
i
All configured display settings must be true before the button is displayed. The app checks your Jira instance in real time using the Atlassian standard API. Atlassian sometimes shows changes (e.g., in user groups) with minor latencies. Additionally, the response time of the Atlassian API impacts when the button is checked and can be displayed, which can take several seconds.

4. How to configure the Button - Action Settings  ?

Required Jira Role: Jira Software Administrator
Please switch to the second Tab “Action Setting” to complete the Button Configuration, and configure which issue type should be created and linked:

ParameterSyntaxDescription
Target ProjectProject Picker
Mandatory
Please select the project from which you want to create and link issues.
Target Issue TypeIssue Type Picker
Mandatory
Please select the issue type from which you want to create and link issues.
The list of issue types is restricted to only those relevant to the previously selected project.
Template IssueIssue Picker
Optional
Select an existing issue as a template. The fields of this issue will be prefilled automatically in the creation screen.

You can select the issue by entering the exact issue key:
Template Issue
Exact key ⌄
Template Fields
Select...
 
TEMP-1
TEMP-1 Bug-Template: Please enter a clear Bug Summary:
What is exactly is wrong
Or by searching the issue summary and selecting one result:
Template Issue
Summary ⌄
Template Fields
Select...
 
Bug-Template
TEMP-1 Bug-Template: Please enter a clear Bug Summary:
What is exactly is wrong
CL-47 Bug-Template: Please enter a clear Bug Summary:
What is exactly is wrong
Template FieldsField Picker
Optional

Default: All relevant fields will be copied if they exist in the template issue.
Once a template issue has been selected, you can narrow down the fields to be copied in the creation process to a subset. We will list exactly the fields that will be used in the creation screen of the configured target project and target issue type.
Template Fields
Components ×Test Repository Path ×
Assignee
Test Type
Cucumber Test Type
Cucumber Scenario
Generic Test Definition
Manual Test Steps
Test Sets association with a Test
Pre-Conditions association with a Test
Test Plans associated with a Test
Link TypeLink Picker
Optional

Default: No Link
Choose the type of link that should be established between your source issue and the target issue after the creation action.
i
Our Issue Template Feature leverages the capabilities of the Atlassian Forge Platform, providing full support in Software and Work Management projects. However, when used in Service Management or Product Discovery projects, some limitations may arise, such as restrictions on custom fields and UI modifications. See Atlassian Forge Platform Limitations.

4. How to configure the Button - Create Behaviours  ?

Required Jira Role: Jira Software Administrator
Please switch to the second Tab “Create Behaviours” to complete the Button Configuration, if you want to add Behaviours to the Create Screen and refer to the documentation here:
 

Jump to: