Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2.0.0

Installation


Section


Column
  1. Log in to your Jira instance as an administrator.

  2. Select the user icon.

  3. From the dropdown drop-down menu which appears, choose Atlassian Marketplace.
     The 'Find new apps' screen will be displayed.

  4. Use the search function to locate vLinksThe correct app version will be shown in the search results.

  5. Click on 'Install' to download and install vLinks.


Column




Introduction

vLinks provides two three new custom field types, which allow the user to select issues (single, multiple or multiple 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


Column
  • Select Custom fields in Under the Issues section in the administration area and choose Custom fields, continue by clicking on 'clicking Add custom field'.
  • Search for vLinks in the Advanced fields.
Column

Image Removed

  • vLinks offers
two
  • three field types: Multiple Issue PickerSingle Issue Picker and Linked Issue Field.
  • Select one of the options and click on 'Next'.
  • Name your vLinks custom field and provide a description, if required.
  • Select a screen in which you want the vLinks field to appear (Click on gear icon and select Screens).


Column
width50%

Image Added




Configuring the custom field
width

In the newly created field,

 
Section
Column
5%
Column
width95%

Image Removed

the

 the user has to select "Configure" and then

to

click on

the

"Add vLinks Context Config" link. 

Installation

Image Added



  • Issue Link Type (required field) - you can select any of the existing Jira issue link types.

Section

There are four five options available:

Column
width25%
Column
width65%

Image Removed

  • Synchronise Issue Links - if checked, vLinks will create issue links between issues selected in the vLinks field and the issue where you are using the field. 
  • JQL filter - you can insert a desired

jql
  • JQL filter in the textfield. On the right side you can see either a green icon if the filter is valid or a red icon if the filter isn't.

  • Set Permission - while checked,

custom field dropdown will show
  • all the issues that are corresponding to the JQL filter will be shown, regardless of

user
  • the users permissions. 

  • View Template - you can decide how the template will look. By clicking on the field, a handful of options will show up, like:

$key
  • $issuekey, $summary, $reporter, $assignee, $status, $priority

,
  • and $customfield_

XXXXX
  • .

By
  • In the $customfield_

XXXXX
  • option, you have to insert the correct ID of the desired custom field, for example $customfield_10200. Otherwise, the value of the option will be set to "N/A".

Activating the custom field in a Service Desk project

Section
Column
width35%

Go to Project settings → Request types → choose a request type → Edit fields → Add a field and check vLinks. Click on the "Apply" button.

Column
width65%

Image Removed

Image Removed

Image Removed

Inline dialog

After choosing an issue an icon will


Image Added

Section
Column
width35%



Enable Inline Issue Creation
Section

The issue you are looking for in the vLinks Custom field doesn't exist yet?
Now it is possible to create issues out of the Issue View as inline creation.

Image Added



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.

Image Added



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.

Image Added



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.

Image Added



Section

The configured issue types can be directly chosen through the panel.

Image Added



Image Removed

Image Added

Section

In the newly configured vLinks field, choose an issue. After choosing an issue an icon will appear right next to the content. 
By clicking on it an inline dialog containing all the relevant issue information will appear. 

Column
width65%



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.




JQL function

There is a built-in JQL function called "customFieldValueFromIssue("", "")". The function 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 and the specified issue.

Example: vLinks = customFieldValueFromIssue("TEST-2", "10300")

or 

cf[10300] = customFieldValueFromissue("TEST-2", "10300")


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.