HQL add-on compatibility
Herzum Quick Linker add-on has the following compatibility
Add-on Version | 4.3 | 4.4 | 5.0 | 5.1 | 5.2 | 6.0 | 6.1 | 6.2 | 6.3 |
|---|---|---|---|---|---|---|---|---|---|
| 2.0 |  | | | | |  | | | |
| 2.1 | | | | | | | | | |
Installing HQL
The Herzum Quick Linker (HQL) can be installed from the Add-Ons panel within JIRA.
 |
| View of Quick Linker add-on from within JIRA |
1 | Navigate to the Add-Ons Panel within your JIRA installation. Administration → Add-ons → Find new add-ons |
Add-Ons nav. item within JIRA |
2 | In the "Search the Marketplace" box, type herzum |
Search Results for herzum |
3 | Click the Install button for the HQL plugin. |
Button to install the HQL plugin |
4 | Verify Successful Installation |
HQL should display within the Manage add-ons section |
Configure HQL Plugin
1 | Navigate to the Add-Ons Panel within your JIRA installation. Administration → Add-Ons → Herzum Quick Linker |
Navigational Item within Add-Ons |
Create a new Quick Link
By default, there are no quick links created when you first install the plugin. Your first configuration option will be to create a new quick link to display within the Issue Details Screen. To create a new quick link, follow the steps below.
1 | Click on the Add New Link button. |
Add New Link button |
2 | Configure the Quick Link via the Mapping Configuration Screen and Save. To view the details of these fields, view the Mapping Config. Screen. |
Quick Link Configuration Screen |
3 | Verify Successful Creation of the Quick Link. |
Quick Link overview screen |
4 | Add a new Custom Field for the Quick Link. Administration → Issues → Custom Fields To view the wizard steps, view the Custom Field Addition Wizard. |
Custom Field Addition Wizard |
5 | Choose the Screens that you want to add the new custom field Administration → Issues → Field Configurations → Screens link on <Quick Link Name>. |
Field Configuration Screen |
- You have the ability to create more than one quick link to be displayed for a single issue type within a given project. To accomplish this, just create a new quick link and choose the same project / issue type combination when configuring the quick link. Each quick link will have it's own button and will display within the Issue Details screen of the selected issue type.
Mapping Configuration Screen
The Configuration screen will allow you to setup the link that you want to add to the Issue Details Screen.
- Button Label
- This is the label that will be displayed on the quick link button on the Issue Details Screen.
- This is a required field.
- It cannot be longer than 256 characters.
- For aesthetics, I would limit the value to be < 20 characters.
- Source Project
- This is the project which has the issue type that you want the Quick Link to display.
- Source Issue Type
- This is the issue type that the Quick Link button will display.
- On this issue type, the button will display within the Issue Details screen.
- Destination Project
- This is the project that has the Issue Type that you want the Quick Link button to create.
- Destination Issue Type
- This is the Issue Type that will be created by clicking on the Quick Link button.
- Issue Link Type
- This is the type of association that will be created when the 2 tickets are linked to each other.
- For a default JIRA instance, the values will be Relates, Clones, Blocks, Duplicates.
- Issue Type Create View
- This is the screen that you want displayed when the user clicks on the Quick Link button.
- If you choose this option, the user will be displayed the Create Issue modal overlay to fill out the details of the ticket.
- If this option is not selected, they will be displayed a small section that will allow them to enter a Summary & Description of the ticket.
Custom Field Addition Wizard
This wizard will allow you to setup the new custom field that is required for the Quick Link plugin to work.
1 | Click on the Add Custom Field button. |
Add Custom Field button |
2 | Choose Advanced and click on Herzum Quick Linker Actions.
|
Quick Link Configuration Screen |
3 | Give a name and description to the new custom field. This will be the name that be used throughout JIRA. |
Custom Field Name & Description screen |
4 | Associate the new custom field to the screens you want it to show. You can also get to this screen by using the following: Administration → Issues → Field Configurations → Screens link on <Quick Link Name>. |
Screens you want to add the new Quick Link field |
Verify Successful Installation & Configuration
If everything went smooth, you will be able to see the new quick link action button within the Issue Details screen of the Source Issue Type that you selected when creating your Quick Link.
Issue Details Screen with Quick Link section displayed |
Configured with Issue Type Create View selected
With this option selected, the Create Issue modal overlay will be displayed when you click on any of the Quick Link buttons that you have created.
 |
| Quick Link with Issue Type Create View selected |
Configured with Issue Type Create View left blank
With this option left blank, the system will slide down a small subset of the fields for the ticket to be created.
 |
| Quick Link with Issue Type Create View left blank |
Ticket Creation and Link
Once you have used the quick link button to successfully create a new issue, you will be able to see the issue that was generated from the original issue as well as the link is associated between both issues.
- Both tickets will have the links that tie them together.
- The type of link is dependent on the value that you selected in the Issue Link Type field during the configuration of the quick link
 |
| Issue Link Created via Quick Link |