Gearset allows you to connect your releases in pipelines to Change Requests in ServiceNow, but first you need to configure an OAuth integration between ServiceNow and Gearset.
Initial ServiceNow setup
First, your ServiceNow administrator will need to create a new Application Registry
for Gearset within your ServiceNow instance. When prompted for what kind of OAuth application, select the option that says Create an OAuth API endpoint for external clients
.
This should show you the following page:
β
You can name the OAuth application whatever you want, but for clarity it will make sense to include Gearset in the name. You can create your own client secret or let ServiceNow auto generate one for you if you wish. Both the Client Id and Secret will be needed in the next step. Both the Redirect URL
and the Logo URL
should be copied from the Add ServiceNow connection
modal in Gearset as shown below:
You can choose to make any further changes to the OAuth settings that you wish as long as the redirect URL and logo URL are populated as above. Once you are happy, submit the changes and open the newly created application registry so that you can see the Client Id and Client Secret.
Setup in Gearset
In Source control and services, under Connect to ServiceNow
, you will see the modal from the screenshot above.
For the instance URL, enter the URL of the ServiceNow instance that you want to connect to (it should be the same one that you just created the application registry on).
The Client Id and Client Secret should be directly copied from the application registry you created in the previous step. Gearset needs this information to perform the OAuth Handshake with ServiceNow and allow you to access relevant ServiceNow information through Gearset. When you click save, you should see the following screen (or a login page if you are not logged into ServiceNow).
Click Allow
and it should redirect you back to Gearset with the connection all set up. You should be all set up to start using ServiceNow in Gearset.
β
Note: This connection only needs to be done once. Once the connection to the instance is created, all other team members can simply click the Connect to ServiceNow
button and login to the ServiceNow instance with their own credentials.
Warning: As a team owner, deleting the ServiceNow connection will delete the connection for everyone else in the team that has a connection since it deletes the information about the instance from Gearset.
Next Steps
Now that you've connected Gearset and ServiceNow, you can now connect releases in Pipelines to Change Requests. See Getting started with ServiceNow and Gearset releases for more information.