Overview

Configuring a Data Connector

Prior to setting up a new Key Result data connector, your organization’s IT Administrator may need to approve the connector if there is an approval configuration. Once enabled, any user can have their Key Results measure progress from that specific connector. 

1. Create a new Key Result by selecting the kebab menu (3 dots) next to the applicable Objective.
   • If the Objective hasn't been created, simply select Create > Team Objective or Personal Objective, then enter your Key Result name.
2. Select Edit Settings from the dropdown. 
3. Click Add another key result and enter your Key Result name.
4. Select Advanced options, then Pull data from external applications. 
5. Choose the applicable data source from one of the options:
6. Log in to the application by inputting your credentials. 
   • Please note that for some applications, you will also need to create an API key or provide OAuth2 information. This information is Read Only. 
7. Once enabled, your Key Results will automatically update based on the update cadence specified in the Key Result's configuration.
8. If you need to manually sync an update, use the Sync Integration Data option from the kebab menu (three dots) in the upper right-hand corner of the Key Result details page.

Setting up a Key Result from GitLab

After following steps 1-3 above, select whether issues should be specified using the Query builder or Dora metrics.  

For issues specified using Query builder:

1. Select a project or group. To refine your search, use the dropdown selections to add additional filters on your selected project including milestones, iterations, labels, and assignees. 
   
   
2. Select a timeframe option from the dropdown: All time, This OKR's timeframe, or a Custom timeframe.
   
   
3. Select how the progress should be calculated from the dropdown options: Number of completed issues, Number of all issues, or Sum of weights of completed issues (Available for GitLab Premium only).
   
   
4. Select Preview Results for real-time validation of data before connecting.
5. Choose Connect to set up the GitLab integration. 
6. Enter the remaining Key Result details, then select an Update Cadence to determine how often WorkBoard will sync to pull the latest value for your Key Result.
   Note: Update cadence has the same options you would find for Key Results updated by a person (i.e., Daily, Weekly, Monthly, and Quarterly).
   
7. When finished, select Save to lock in the settings for your Key Result, then Done to apply these changes to your Objective.

For issues specified using Dora metrics:

1. Select a project or group.
   
2. Select a metric option from the dropdown menu: Deployment frequency, Lead time for changes, Time to restore service, or Change failure rate.
   
   
3. Select an environment tier from the dropdown menu.
   
   
4. Select a timeframe option from the dropdown: All time, This OKR's timeframe, or a Custom timeframe.
   
   
5. Select how the progress should be calculated from the dropdown options: Number of completed issues, Number of all issues, Sum of weights of completed issues (Available for GitLab Premium only), or Sum of weights of all issues (Available for GitLab Premium only).
   
   
   
6. Select Preview results for real-time validation of data before connecting. 
7. Choose Connect to set up GitLab integration. 
8. Enter the remaining Key Result details, then select an Update Cadence to determine how often WorkBoard will sync to pull the latest value for your Key Result.
   Note: Update cadence has the same options you would find for Key Results updated by a person (i.e., Daily, Weekly, Monthly, and Quarterly).
9. When finished, select Save to lock in the settings for your Key Result, then Done to apply these changes to your Objective.

Synchronize Data from GitLab

WorkBoard will effortlessly sync Key Result updates directly from the data connector based on the specified update cadence. You can manually sync Key Result updates, if needed, in two ways:

Force a Sync on a Single Key Result:

1. Select Key Result to navigate to the Key Results Details page.
2. Click the kebab menu (3 dots) in the upper right-hand corner of the page.
3. Select Sync Integration Data.
   

Force a Sync for all Key Result Integrations:

1. From the My Objectives Page, select the kebab menu in the upper right-hand corner.
2. Select Sync Integration Data.

Frequently Asked Questions

What are the scopes of access that WorkBoard receives when I integrate a Key Result connector?

The scope of access is Read Only, which is bounded by the user integrating with the service.

Will the Key Result connector pull in historic updates?

No, the connector does not have the automated ability to post historic updates to Key Results. The update always goes to the present interval due for the Key Result.

• Please note that KPI integrations will only deliver updates that are currently due, meaning data pulled in Month X will have the timestamp 'Month X'.
  • As a workaround, multi-target KRs can divide a Key Result into distinct named intervals such as 'August', 'September', 'October', etc. The 'July' interval, for instance, would encompass the start/end dates for data collection (August 1st - August 31st). Despite being named 'July', the data collection would actually occur within the timeframe of August.
  • 

When will the connector update my Key Result?

The integration will update based on the update frequency set up for the Key Result (e.g. weekly updates weekly, daily updates daily, etc.). The integration scheduler operates on a twice-daily basis, offering two opportunities for updates to ensure data accuracy. To optimize efficiency, the scheduler skips updates for Key Results (KRs) that are not due for updates, to prevent redundant data updates and maintaining a streamlined process.

When does GitLab update?

7:45am PST and 7:45pm PST.