Installation
Section | ||||
---|---|---|---|---|
|
Introduction
vLinks provides three new custom field types, which allow the user to select issues (single, multiple or linked issue picker) and create and/or remove issue links depending on the selection. These fields can be used in JQL queries. You can also use some variables or keywords to display data about the issue appearing in the custom field.
Custom field
Creating a custom field
Section | ||||||
---|---|---|---|---|---|---|
|
Configuring the custom field
Section |
---|
In the newly created field, the user has to select "Configure" and then click on "Add vLinks Context Config" link. |
Section |
---|
There are five options available:
|
Synchronization with Advanced Roadmaps
Section |
---|
vLinks is synchronized with Advanced Roadmaps for Jira. In configuration you can enable this option which allows you to use vLinks singlepicker field as a linking tool for Advanced Roadmaps. Enabling this feature gives you three options on how you wish to use it.
|
Enable Inline Issue Creation
Section |
---|
The issue you are looking for in the vLinks Custom field doesn't exist yet? |
vLinks Context Configuration
Section |
---|
You are now able to configure more than one configuration to the individual custom fields. Multiple JQLs and visual options can be configured to show exactly the needed information. |
Browse existing configurations
Section |
---|
We've added all configuration schemes from every vLinks field in one place. This makes it a lot easier to browse other schemes and copy them from other vLinks fields. You can now select a scheme you would like to take and edit it as you desire. Custom field configuration schemes have never been easier to connect and edit. |
Section |
---|
Issue link resync
Section |
---|
Got issue links that you would like to add to vLinks ? No problem. With issue link resync vLinks takes existing issue links and adds them to the existing vLinks custom field. You will have a chance to review changes before applying them. A screen will appear showing which issues will be affected and you can choose which link to remove or which ones to keep. "Issue" column represents the issue in which the links are found. "Found issue links" column represents the issue links that are found within the issue "Current value" column represents the current value the vLinks field has "New values" column represents the value the vLinks field will have after the resync is done Note: vLinks context configurations issue link type has to correspond to the existing issue link for the sync to work as intended. |
Inline dialog
Section |
---|
Just by typing the summary of an issue, the system automatically checks the already existing ones. If the search comes up empty, the option Create new will appear. Now you can create a new issue. |
Section |
---|
After the click on the Create new button a panel shows to the right of the custom field. It shows the summary and the issue type of the to-be-created issue. |
Section |
---|
The configured issue types can be directly chosen through the panel. |
Section |
---|
In the newly configured vLinks field, choose an issue. After choosing an issue an icon will appear right next to the content. |
Activating the custom field in a Service Desk project
Go to Project settings → Request types → choose a request type → Edit fields → Add a field and check vLinks. Click on the "Apply" button.
Issue linking scheme
Section |
---|
If you only want certain links between issues you can do that by heading over to Issue Linking Scheme under the Issues section in the administration area. By clicking on the Create new linking scheme you can select which types of links you want to use. After you have created a scheme, you need to associate that scheme with a project. To do this click on the Associate link and select which projects you want the scheme to be applied to. |
Enable editing by project admin
Section | |||||||
---|---|---|---|---|---|---|---|
By using this feature you can make editing linking schemes available to your project admins. This will enable them to edit the linking schemes that are associated with their projects.
|
Column | ||
---|---|---|
| ||
Editing the linking schemeClick on the Edit linking scheme button, a new page will be opened. Here you can specify which Issue Link Types you want to use. You will see ones that are already in use on the left, and available link types on the right. You can edit this by simply dragging and dropping the link type. |
Issue link display
Section |
---|
Now you can display link types in group and also show the direction of the link type. This is applied to each linking scheme created and works with default Jira issue linking. |
JQL functions
There are two built in JQL functions called customFieldValueFromIssue("", "") and customFieldValueListFromIssue("", "", "").
The JQL function called customFieldValueFromIssue("", "") takes two parameters. The first one is an issue key and the second one is the ID of the custom field. The function returns the value of the custom field in the specified issue.
Example: vLinks = customFieldValueFromIssue("TEST-2", "10300")
or
cf[10300] = customFieldValueFromissue("TEST-2", "10300")
The JQL function called customFieldValueListFromIssue("", "", "") takes three parameters. First two parameters are the same as in the function above. The third parameter can be true or false, meaning that the function will look at the field either as a CSV (comma-separated values) or as a regular list. – if you use true the result will be treated as CSV.
Example: vLinks (MutliPicker) = customFieldValueListFromIssue("TEST-1", "10300", "true")
Note |
---|
If you are using the function currentIssue() inside of these functions; customFieldValueFromIssue("", "") or customFieldValueListFromIssue("", "", ""), the currentIssue() mustn't be between quotation marks ( "" ). |
Further information
The App provides a new custom field type to Jira which enables the user to identify and select issues (single or multiple) easily and quickly. This user-defined field allows the user to create and remove issue links depending on the options selected. In addition, the linked custom issue field can be used in JQL functions and dashboard gadgets.
Searching using the linked issue custom field
In case of issues, you can use the linked custom field in JQL queries. This makes searching for linked topics a lot easier.
Easy management of issue links in a user-friendly field
All you have to do is to identify the issues to be linked and complete them automatically.
Configuration of the linked issue custom field
The custom field is assigned to the issue link type of your choice. Furthermore, you can restrict which issues are displayed by specifying a JQL request.