Administration Guide





Installation & Licensing


  1. Log in to your Jira instance as an administrator.
  2. Select the user icon.
  3. After a dropdown menu appears, choose Atlassian Marketplace. The 'Find new add-ons' screen will be displayed.
  4. Use the search function to locate vLinks. The correct app version will be shown in the search results.
  5. To start a new trial version, click 'Try free' to purchase a license for vLinks click on 'Buy now'. You will be asked to log in to MyAtlassian. The vLinks app starts downloading.
  6. After entering your data on MyAtlassian, click on 'Generate license'.
  7. Then click on 'Apply license'If you're using an older version of UPM, you have the option to copy and paste the license into your Jira instance.

                                                                                                             




Introduction

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




Creating a custom field


  • Select Custom fields in the administration area and continue by clicking on 'Add custom field'.
  • Search for vLinks in the Advanced fields.
  • vLinks offers two field types: Multiple Issue Picker and Single Issue Picker.
  • Select one of the options and click on 'Next'.
  • Name the user-defined field and provide a description, if required.
  • Assign the field to a screen to which you want the linked field to appear.





Configuring the custom field

In the newly created field, the user has to select "Configure" and then to click on the "Edit Custom Field Selected Options" link. 






There are four options available:

  • Issue Link Type (required field) - you can select any of existing Jira issue link types
  •  JQL filter - you can insert a desired filter in the textfield. On the right side you can see a green icon, if the filter is valid, and a red icon, if the filter isn't valid
  • Set permission - while checked, custom field dropdown will show all issues regardless of user permissions.
  • View Template - you can decide how the template will look like. $key is always presented. Upon clicking on the field, other options will show up, like: $key (if you need it multiple times), $summary, $reporter, $assignee, $status, $customfield_XXXXX. By the $customfield_XXXXX option, you have to insert the correct ID of the other vLinks 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

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






Inline dialog

Upon hovering on the issue key, an inline dialog containing additional information (summary, type, status, priority, assignee, reporter) will show up. 

There are two additional options:

  • Assign to me - will assign the issue to the current user
  • More by reporter - will display all issues by the same reporter in the in the issue navigator area




JQL function

There is a built-in JQL function named "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 is returning the value of the custom field in the specified issue.

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

or 

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




Further Information

venITure provides a new custom field type 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 by 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.