Manage integrations

Tags: Flow

Who can use this?

 Core
Plus
 
  
The Integrations page makes it easy to see and manage all of your connected accounts. Below is an overview of how to manage and add integrations and their data.


Permissions

The Manage Integrations permission is required to view, manage, or delete integrations.

back to top


Managing your integrations

To find your added integrations:

  1. Click Settings in the top navigation.
  2. In the left navigation, under Integrations, click Integrations.

Note: Learn more about Integrating hosts, including step-by-step walkthroughs for specific hosts.

On the Integrations page you can do the following: 

  1. Search or filter by integration: Using the advanced filtering you can narrow down your integrations list.
  2. Sort your integrations by using the columns Integration Name, Provider, Services, Added by and Last Updated.
  3. Delete an integration
  4. Add another integration
  5. View repos or ticket projects
  6. Select and view an integration
  7. Review and edit the Vendor URL for a commit

back to top


Deleting integrations

Deleting an integration removes all data associated with that integration. Deleting an integration should be rare and should not be used to edit an integration or solve data issues. You will not be able to add the integration back to Flow for 24 hours or more and you may have to merge your users again.

Important: Deleting an integration is an extreme option. If you are experiencing issues with your data and are unable to resolve them, please reach out to Pluralsight Support (opens email form) before attempting to delete integrations.

 To delete an integration:

  1. Select the integration you want to delete. 
  2. Click the Actions dropdown. 
  3. Click Remove Selected.
  4. A warning message appears asking you to confirm your selection. Click Delete integration.

You successfully deleted the integration. It no longer appears in your integrations list and Flow removed all of its associated data from your account.

back to top


Adding an integration

To add an integration:

  1. Click Add Integration in the top right corner of the Integrations page. 
  2. Select an integration from the Integration Provider list and Flow will guide you through the integration process. 

Important: New integrations may take up to 24 hours to ingest all your Repo, PR and ticket data into Flow.

back to top


Updating integrations

On the top right-hand side of the Integrations page, you’ll find the Integrations Update Actions dropdown menu. Depending on which button you press, this will trigger a full reprocess of either repos or background metrics calculations. 

Note: For best results, perform this update only when necessary to reduce reprocessing time.

The Update actions options have the following effects on your existing integrations:

  • Update all repos: This is useful when your credentials have expired and repos have been blocked. You can use this button to get repos through processing after updating your credentials.
  • Update background metrics: This is used when, for example, a comment exists on a PR, but isn’t being factored into a PR metric.

Important: These commands are only available to those users who have Manage Integrations: view, manage, and delete permissions.

The processing for each update option could take up to an hour or more. Once processing is completed, a green success banner appears on your screen.

If your integration has stopped updating because the owner of the integration credentials has left your organization, you must update the integration with a new set of credentials. To update credentials for an integration, click on an integration name, then click Edit. Update your integration method, then click Update.

back to top


Viewing repos and tickets

To view repo and ticket projects that were imported from an integration:

  1. Navigate to the Integrations page.
  2. Click View repos or View Tickets next to an integration.
  3. You are directed to the Repo page or Ticket page where you will see all of the repos or ticket projects that were imported from this integration.
  4. If you're viewing repos, select the Imported repos tab on the Repos page. You will see only the imported repos associated with that integration you selected. 

Tip: Click Clear all filters to remove the filter and view all imported repos or ticket projects. Learn more about managing repositories.

back to top


Viewing an integration

Click an integration name to view and manage the integration’s settings. 

On the individual Integration page you can:

  1. See the name of the integration set during the initial integration configuration.
  2. Click the Test connection button to test the integration connection.
  3. Click the Update now button to place all projects, repos, pull requests, and tickets associated with the connection into the queue to be updated.
  4. Click the Refresh all projects button to see new groups and new repos available for import.
  5. Manage the integration’s services. Depending on the connection, these services can vary. For Jira or ADO integrations, use the Tickets tab to view ticket projects and bulk edit investment layers:
    1. Check boxes next to the ticket projects you want to configure. Only configured and auto-configured ticket projects are selectable.
    2. Select Edit configurations from the Actions dropdown menu.

    3. Select the field you want Flow to use for investment layers.
    4. Click Apply to apply your changes. Learn more about configuring investment layers.
  6. Click the Edit button to configure the integration. Click the Trash can icon to delete the integration. 
  7. Toggle the Auto-import all projects toggle On to auto-import all groups in the integration. If you'd like to enable or disable the import of any group individually, toggle the Auto-import all groups toggle Off. Use the toggles in the Import column to select specific integrations to auto-import. 

Note: Auto-import all groups only imports the repos displayed under Groups for the specific integration you’re working with.

back to top


Managing an integration’s services

Each integration has associated services. Depending on the integration, these services can vary. Here is a general guideline:

Cloud Git Hosts (Bitbucket, GitHub, Git Lab, Azure)

  • Webhooks
  • Repos
  • Tickets
  • Pull Requests

Self-hosted or behind a firewall (services may vary)

  • Repos
  • Tickets
  • Pull Requests

Webhooks tab

Navigate to the Webhooks tab to install webhooks for each repo or for the account. Learn more about webhooks.

Repos tab

In the Repos tab:

  • Control which accounts and organizations you want to auto-import repos from.
  • Control which groups and organizations that are associated with your Integration, are visible on the Available tab of your repos page.

Auto Import

Toggle the Auto-import button On to automatically import all repos for that particular account. This includes all existing repos and any repos you add in the future. 

Services tab

Pause or delete all repos

Under Repo Services you have the option to:

  • Pause repo services. This stops all updating and importing, but all data will remain in your account. At any point you may Resume repo services. 
  • Turn off repo services. This deletes all imported repos, and any data previously processed, including PR and Ticket data. It also removes the integration from your available repos list. 

Tip: It does not delete the Integration itself, it only removes any associated data.

When turning off repo services, you will get the following warning: 

Ticket and Pull Requests Services

In the Services tab you will be able to enable and disable ticket/PR services for the Integration. Just like Repos, you can pause or turn off these services. In the images below we are using the Tickets tab as the example. 

  • Pause services. This toggle stops all updating and importing, but all data remains in your account. At any point you may Resume services. 
  • Delete all ticket data. This deletes all imported tickets and Pull Requests. 

When turning off ticket services, you will get the following warning: 

Review and edit the Vendor URL for your commits

Self-hosted git hosts and commits may not provide the correct commit URL to Flow. This prevents Flow from properly linking to that commit. 

Use the Vendor URL page to review and edit the vendor URL. 

From the Integrations page, click the Vendor URLs button.

On the Vendor URL templates page, review the vendor URLs and see which commits are not yet configured. Use this page to review, configure, and modify the Vendor URLs. 

  1. The Hostname column provides the name of the host for your commit. The hostname is used to populate the Host variable in the URL template. 
  2. The Commit URL column shows the URL template linking to the commit. If Flow does not have the URL template, you will see the Not yet configured alert. Use this column to make sure Flow has the correct URL template.
  3. The Integrations affected column shows the integrations that use the host name. Each of these integrations use this template to link to their commits. 
  4. The Last updated column shows the date the URL was last updated. 
  5. The Edit column allows you to edit the URLs.

How do I edit the Vendor URL?

  1. Navigate to the Vendor URLs page.
  2. Click the Edit icon next to the URL you want to edit. 
  3. You will see a pop up modal where you can edit the URL. When you are done, click Update

  1. Use the Hostname field to edit the host name of your commit. The hostname field is pre-populated based on the hostname provided to Flow. 
  2. Use the Commit URL template field to edit the commit URL. When you click inside the field, you will see URL template variables. Click the variable you want to edit.  
  3. The Variables and their meanings section provides the variable names for the URL and their definition. Click on a variable name to populate that variable field in the Commit URL template field.
  4. Use the provided URL to verify the URL is correct. The URL will update in realtime as you update the template. 

back to top


If you need help, please contact Pluralsight Support.