Overview
Requirements
-
The ServiceNOW connector works as is out-of-the-box with basic username and password.
-
In order to enable OAuth, each user will need to have the client ID, client Secret, and redirect URL used for the OAuth setup. These assets are available from a ServiceNow admin.
Add a ServiceNow Key Result
- Hover over your Objective and click the Kebab.
- Select Edit Settings.
- Select Add another Key Result.
- Select Advanced Options.
- Choose Pull data from external applications.
- Pick ServiceNow from the list of integrations.
- Sign in using OAuth or a Personal Access Token.
Basic Auth → Basic authentication requires that users know their ServiceNOW URL and username and password. The ServiceNOW URL will be in the URL bar of your ServiceNOW home screen and will follow the format given in the form field.
OAuth → In order to leverage OAuth you will need to have security admin permissions within ServiceNOW. If you are a security administrator, follow the on-screen setup instructions to walk through the setup of app approval. Note that because the OAuth approval flow requires credentials that only admins have, other users will need to rely on username and password for access. - Once signed in, select the Scorecard that you want to pull data from. Scorecards are searchable by name. If the Scorecard you are searching for does not appear right away, try adjusting your search terms and make sure that you are spelling the scorecard name correctly. If that doesn’t work, make sure that the credentials you have entered have access to the scorecard that you are attempting to pull data from.
- (Optional) For real-time validation of data before connecting, select Preview results.
- Choose Connect to set up ServiceNow integration.
- Fill out or edit the remaining Key Result details such as Start Value, Result Value, Target Value, Committed Result, Unit of Measurement and how to Calculate Overall Progress.
- Choose your Update Cadence, which determines when or how often WorkBoard will sync with ServiceNOW 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). - Click Save.
Synchronize Data from ServiceNow
WorkBoard will pull data for the KR directly from ServiceNow following the cadence specified. The Business Result Owner also has the ability to “sync data now” to pull data in real-time.
There are two ways to sync data for your Key Results.
Force a Sync on a Single ServiceNow Key Result:
- Select Key Result to go to the Key Results Details page.
- Choose the Kebab menu in the upper right-hand corner.
- Select Sync Integration Data.
Force a Sync for all Key Result Integrations:
- From the My Objectives Page, select the Kebab icon in the upper right-hand corner.
- Select Sync Integration Data.