Issue Tracking Tools (Azure DevOps/Jira)
Overview
Users can create, link and update Azure DevOps issues or Jira Tickets from the TODO items in vFunction Server.
After meeting the Prerequisites, follow the Configuration Steps below to set up the integration. Once configured, all vFunction users can Create Tickets From TODOs via the configured issue tracking tool.
Configuration Prerequisites
Azure DevOps (ADO)
- An Azure DevOps Account. This can be a standard user and does not need to be an administrator. It is recommended but not mandatory to create a special Service Account user for vFunction since this user will be assigned as the reporter of all issues
- The Azure DevOps Organization’s Base URL such as
https://dev.azure.com/{yourorganization}
- An Azure DevOps Token to authenticate the Azure DevOps user. Follow the instructions to create a Personal Access Token in the Azure DevOps support page. Note that, if setting the Scope of permissions with specific permissions granted, then the Graph Scope with Read permissions is required
Jira Cloud
- A Jira Cloud Account. This can be a standard user and does not need to be an administrator. It is recommended but not mandatory to create a special Service Account user for vFunction since this user will be assigned as the reporter of all issues
- The Jira Base URL for the organization, such as https://mycompany.atlassian.net
- A Jira Token to authenticate the Jira user. Follow the instructions to create an API token in the Manage API Tokens Atlassian support page
Jira Software
- On-Premise or Self-Hosted Jira v9.12 and later
- A Jira Account. This can be a standard user and does not need to be an administrator. It is recommended but not mandatory to create a special Service Account user for vFunction since this user will be assigned as the reporter of all issues
- The Jira Base URL for the organization, such as https://jira.mycompany.net. There cannot be any network routing or firewall restrictions between the vFunction Server and this Jira site
- A Jira Token to authenticate the Jira user. Follow the instructions to create an API token in the Manage API Tokens Atlassian support page
Central Configuration Steps for all Apps on the vFunction Server
Beginning in vFunction Server v4.3, organizations have the option to configure the Ticket Management System for each vFunction Application independently or for all of the vFunction Application centrally. This distinct provides Access Control for an organization. If configured Centrally, one user’s Ticket Management Access becomes available to all vFunction Applications. If configured Per Application, independent users can be configured for Ticket Management Access to be more limited. The steps below are for a Central configuration.
- As a vFunction Administrator, log into the vFunction Server UI in a browser
- Select Account Settings (the Person icon) in the top-right corner
- Select Settings in the dropdown menu
- Select Configure Integrations in the left-hand sidebar
- Toggle the Task Management System slider in the Configure Apps popup
- Toggle the Manage Integration to Centrally
- In the Workspace Type dropdown, select Jira Cloud, Jira Software or Azure DevOps
- Fill in the following subitems
Azure DevOps
- Token: An Azure Personal Access Token (PAT) used to authenticate the Azure DevOps Account user
- Org: Your organization name (e.g., MyOrg)
Jira Cloud
- User Name: the email address of the Jira Cloud Account user
- Token: A Jira Token used to authenticate the Jira Cloud Account user
- Base Url: The base Url to your Jira cloud site
Jira Software
- Token: A Jira Token used to authenticate the Jira Cloud Account user
- Base Url: The base Url to your On Premise or Self-Hosted version of Jira v9.12 and later
- Click the Integrate Jira or Integrate Azure button on the bottom-right of the Configure Apps popup. This will perform an API call to your Jira Cloud, Jira Software, or Azure DevOps instance to check the access and if successful the dialog will be closed
Per-Application Configuration Steps for each App on the vFunction Server
Beginning in vFunction Server v4.3, organizations have the option to configure the Ticket Management System for each vFunction Application independently or for all of the vFunction Application centrally. This distinct provides Access Control for an organization. If configured Centrally, one user’s Ticket Management Access becomes available to all vFunction Applications. If configured Per Application, independent users can be configured for Ticket Management Access to be more limited. The steps below are for a Per-Application configuration.
- As a vFunction Administrator, log into the vFunction Server UI in a browser
- Select Account Settings (the Person icon) in the top-right corner
- Select Settings in the dropdown menu
- Select Configure Integrations in the left-hand sidebar
- Toggle the Task Management System slider in the Configure Apps popup
- Toggle the Manage Integration to Per Application
- Select Apps from the left-hand sidebar
- Click Add Integration for the desired Application from the center pane
- In the Workspace Type dropdown, select Jira Cloud, Jira Software or Azure DevOps
- Fill in the following subitems
Azure DevOps
- Token: An Azure Personal Access Token (PAT) used to authenticate the Azure DevOps Account user
- Org: Your organization name (e.g., MyOrg)
Jira Cloud
- User Name: the email address of the Jira Cloud Account user
- Token: A Jira Token used to authenticate the Jira Cloud Account user
- Base Url: The base Url to your Jira cloud site
Jira Software
- Token: A Jira Token used to authenticate the Jira Cloud Account user
- Base Url: The base Url to your On Premise or Self-Hosted version of Jira v9.12 and later
- Click the Integrate Jira or Integrate Azure button on the bottom-right of the Configure Apps popup. This will perform an API call to your Jira Cloud, Jira Software, or Azure DevOps instance to check the access and if successful the dialog will be closed
Create Tickets From TODOs
- Log into the vFunction Server UI and select the relevant application.
- Open the TODO List for the application and hover over a specific TODO
- Select Open Ticket
- Select the Project and Issue from Open Ticket popup (Summary and Description are auto filled but you can modify them)
- Fill in the rest of the ticket form (mandatory fields are marked with *) and Click Open Ticket
Once the Ticket is created, you will see details of it in the TODO, including a hyperlink to open the ticket in a new window.