The license could not be verified: License Certificate has expired!
1. Table of Content
2. Basic information
2.1. Purpose of the add-on
Forms for JIRA add-on (hereinafter referred to as JFs) enable quick and easy JIRA issue creation from within the Confluence page (page embedded form).
2.2. Macros
Macro | Description |
---|---|
jiraforms | define form's fields with JFs attribute pool |
2.3. Prerequisites
There are some elementary preconditions to be met:
- Application links are to be set properly on both sides (JIRA and Confluence).
- Create Issue permission has to be set correctly in JIRA project's permission scheme (according to use of project attribute, see below).
- Assign Issues and Modify reporter permissions are to be set correctly in JIRA (according to use of assignee and reporter attributes, see below).
- Usernames in JIRA and Confluence are to be matching if using reporter attribute.
2.4. Licensing
2.4.1. Free Trial
Take the benefits of a free trial period first. The add-on is fully functional, however it is time-limited to 1 month from installation. At the cessation of that period, functionality of JFs will be partially locked (see below) and a message will be displayed linking to the Atlassian marketplace where a full license can be purchased.
2.4.2. Full license
The license is valid for one year. After that, some JFs functionality will be inaccessible (see below), hence license renewal is necessary.
2.4.3. Differences between licensed and unlicensed version
Functions | Unlicensed | Licensed |
---|---|---|
Creating issues from Confluence | ||
Working with standard JIRA fields | ||
Issue Linking | ||
Attachment | ||
Working with JIRA Custom fields |
3. Working with JFs
There are two roles defined to work with JFs. These roles are derived from user groups in Confluence.
3.1. Confluence Administrator
The user is a member of the group confluence-administrators and has the correct permissions
- to install the plugin (Confluence Administration > Manage Add-ons ),
- to insert a valid license key,
- to set up trusted connection between JIRA and Confluence and
- to select the proper Application links that will be used.
3.1.1. Installation
Easily install the add-on via Confluence UPM or by manual download from the Atlassian Marketplace. Installation and basic configuration fall within Confluence administrator's authority only.
3.1.2. License key
Trial license can be obtained via Atlassian Markeplace or within standard UPM functionality (Confluence admin > Manage Add-ons > Forms for JIRA > Free Trial ).
Full license can be ordered from the Atlassian Marketplace ( or directly from within the Confluence via standard UPM functionality: Confluence Admin > Manage Add-ons > Forms for JIRA > Buy Now) .
3.1.3. Add-on configuration
1. Check / define Application Links
A working connection between JIRA and Confluence instances has to be made on both sides via Administration > Application links.
Check the Application links and set up Outgoing authentication / Trusted applications (see Troubleshooting). |
2. Use the existing application link
Choose from existing connections in Confluence Administration > Manage Add-ons > Forms for JIRA > Configure.
3.2. End user
The end user defines JIRA issues-creating form and embed it directly within the desired Confluence page using Jiraforms macro and the pool of proper attributes (see below). Form's functionality depends on the target JIRA project's permission settings.
You must specify at least one parameter "config" or "id".
3.2.1. Form definition (the proper use of attributes pool)
Set of attributes, which can be used for the issue-creating form macro configuration (the config parameter).
Each field's definition is ended by a semicolon (see samples below). Particular field attributes are comma separated. |
Attribute | Description | Example |
---|---|---|
TITLE | Field label (displayed to the left of the field) | title=Task Purpose |
KEY | JIRA issue field mapping
Keys needed for issue linking:
|
key=project
key=reporter
|
TYPE | Defines the field’s data (value) type. Green items represents dynamic JIRA sources for obtaining the list-of-values (mostly based on single project selection via key attribute, see above).
Source of issues to link with (KEY=LINKS)
| type=checkbox
key=links, key=links, type=filter_result:10301 |
DEFAULT | Implicit field value (static or dynamic)
Issue Linking
Set current (logged in) Confluence user as a (JIRA issue) reporter dynamically
|
key=description, default=some description goes here...
key=reporter, default=$currentUser |
VISIBILITY | visibility of the field
|
visibility=hidden |
MULTIPLE | Possibility to set multiple choice (multi-select from lists of values), if applicable. Allowable values:
|
multiple=true |
MANDATORY | Possibility to set mandatory form fields.
|
mandatory=true |
3.2.2. Enabled combinations of keys and types
For every key is a set of types enabeled. It is not possible to combine every key with every type. Table of enabled options is bellow.
Note: meaning of symbols used in the table:
x - preferred combination
o - possible combination
Key \ Type | T E X T F I E L D | T E X T A R E A | D A T E P I C K E R | F I L E | I S S U E T Y P E | C O M P O N E N T S | V E R S I O N S | P R I O R I T Y | S E C U R I T Y | A S S I G N A B L E | U S E R | F I L T E R _ R E S U L T | L I N K _ T Y P E | E N U M | N U M B E R |
project | cannot be edited, must be hidden | ||||||||||||||
summary | x | x | o | ||||||||||||
issuetype | x | o | |||||||||||||
assignee | x | o | |||||||||||||
reporter | x | o | x | x | |||||||||||
priority | x | o | |||||||||||||
labels | x | x | x | ||||||||||||
originalEstimate | x | x | |||||||||||||
security | x | o | |||||||||||||
versions | x | o | |||||||||||||
environment | x | x | x | ||||||||||||
description | x | x | o | ||||||||||||
duedate | x | o | |||||||||||||
fixVersions | x | o | |||||||||||||
components | x | o | |||||||||||||
attachment | x | ||||||||||||||
links | x | x | x | ||||||||||||
parentKey | x | x | x | ||||||||||||
linkType | x | o | |||||||||||||
watchers | x | x | x | o | |||||||||||
custom | x | x | x | x | x | x | x | x | x | x | x | x | x |
Table: Enabled combination of atributes and types
3.2.3. Sample form definitions
The following are some examples of JIRA issue creation form definitions.
3.2.3.1. Example A - basic issue fields (incl. multiple selection and customfield)
3.2.3.2. Example B - Issue linking
There is a possibility to link newly created issues to existing issues during creation. The example below shows how this can be achieved.
4. Troubleshooting
4.1. Application link was not found (No application link with name ...)
Issue
Instead of embedded form, Confluence displays the error message "No application link with name .................".
Solution
Choose the right application link (see chapter 3.1.3) or configure the new one to be (Confluence Admin -> Administration -> Application Links):
Edit proper application link:
Outgoing Autentization -> Trusted Applications. Probably there is no configured connection, there:
Scroll down and click to Enable.
The connection was configured, check again:
Form should be displayed:
Add Comment