With the Data Connection manager, Admins can connect Plandek to a number of different workflow, repo and pipeline tools that teams use.

  • Ticket & Workflow management: Jira, Azure

  • Repositories: Github, Bitbucket, Gitlab

  • Pipelines: Jenkins, CircleCI & Github Actions

* To capture your deployment data in Plandek and enhance your metrics by including deployment time as part of Lead Time, Cycle Time and Code Cycle Time, you will need to integrate with our Pipeline API.

Set up a new Data Connection

Navigate to the Data Connections manager in the admin menu. In the top right, click "Add Data Connection" and follow the simple instructions for the respective integration.

New Jira connections

You will need an account with (at least) read-only permissions to integrate with Plandek. Please ensure that this account has access to the projects and boards that you want Plandek to gather.

If you are using Atlassian Cloud, you will need to enter the URL of your instance (e.g. myjira.atlassian.net), the username (typically the full email of your user) and the token (you can generate a token here).

If you have a self-hosted instance of Jira, you will need to enter the host of your instance (e.g. jira.mycompany.com), the username and the password of the user. Should you need to whitelist Plandek, our IPs are 35.187.3.213 and 35.205.219.45.

New Github connections (repos and pipelines)

Plandek integrates with Github via an oauth app, which will manage all required scopes. You will need to create a Github account and ensure that account has access to your org(s).

Before connecting Plandek to your Github, please ensure that you are logged in as the account you wish to use for the integration (otherwise it will integrate with the account you're currently logged into). You can then follow the simple oauth flow to grant permission for Plandek to access your org(s).

Important: an admin will need to approve the Plandek app within each respective org. If you do not see any repos showing after you connect Github, it is likely that the app itself has not yet been approved within each org. Double check with an admin, and once approved you should see the repos (you will need to refresh the page).

Manage your existing connections

On the right side of each live connection, you can click through to the Settings where you can manage the following configurations:

  • Boards: add and remove the Jira boards that you want see in Plandek

  • Custom fields: add any custom fields that you want to include in the metrics. If it's a numeric value, you can also include it as a "Unit of Measurement", which means Plandek can sum this data on the y-axis (e.g. total hours remaining on unresolved tickets or time spent on tickets completed).

  • Story Point Override: each client will be allocated a default Story Point field based on your Jira set up. However, some teams may use a different field for story points. If you notice that there are no story points showing in the metrics on Plandek but you use story points, chances are that you use a different field than other teams in your organisation. You can override that here so we collect the right field to populate story points for your team/board.

  • Credentials: you can update the password or token associated with the user with which you've set up the integration. If you need to change the user, please contact our support team at support@plandek.com.

Repositories (Github, Bitbucket, Gitlab)

  • Repositories: add and remove the repos that you want see in Plandek

  • Credentials: you can update the password or token associated with the user with which you've set up the integration. If you need to change the user, please contact our support team at support@plandek.com.

Azure DevOps

  • Teams: add and remove the Azure Teams that you want see in Plandek

  • Repositories: add and remove the repos that you want see in Plandek

  • Custom fields: add any custom fields that you want to include in the metrics. If it's a numeric value, you can also include it as a "Unit of Measurement", which means Plandek can sum this data on the y-axis (e.g. total hours remaining on unresolved tickets or time spent on tickets completed).

  • Story Point Override: each client will be allocated a default Story Point field based on your Azure set up. However, some teams may use a different field for story points. If you notice that there are no story points showing in the charts on Plandek but you use story points, chances are that you use a different field than most teams in your organisation. You can override that here so we collect the right field to populate story points for your team.

  • Credentials: you can update the password or token associated with the user with which you've set up the integration. If you need to change the user, please contact our support team at support@plandek.com.

Pipelines (Jenkins, CircleCI)

  • Projects/Pipelines: add and remove the projects or pipelines that you want see in Plandek. For CircleCI, you must follow the project with the user that's integrated with Plandek in order for it to appear in the list.

  • Credentials: you can update the password or token associated with the user with which you've set up the integration. If you need to change the user, please contact our support team at support@plandek.com.

Delete a Data Connection

You can remove a data connection at any point by clicking the three dots to the right of the live connection you want to remove (same location as the Settings link). This will remove the integration and immediately start to delete the data that was previously gathered.

Multiple Data Connections of the same type

We are often asked whether Plandek supports multiple types or instances of tools (e.g. various Jira instances, Jira + Azure, or multiple Git products like Github and Gitlab). Absolutely! You can add as many data connections as you need and we will gather the data without any issue. Just follow the directions above for each instance and we'll take care of the rest.

Did this answer your question?