If your Atlan admin has enabled the governance workflows and inbox module in your Atlan workspace, you can create a ServiceNow integration to allow your users to grant or revoke data access for governed assets in Atlan or any other data source.
This is only applicable if you:
To integrate ServiceNow and Atlan, follow these steps.
Create an OAuth application in ServiceNow
You will need to create an OAuth application endpoint for Atlan to access your ServiceNow instance.
To create an OAuth application, from within ServiceNow:
- Log in to your ServiceNow instance as a System Administrator with a security_admin role.
- From the address bar at the top of your browser window, copy the ServiceNow instance URL — for example,
https://<instance_name>.service-now.com
. This will be required to connect Atlan to your ServiceNow instance. - From the top header of your ServiceNow instance, click All. From the dropdown, search for and select System OAuth and then click Application Registry.
- In the top-right corner of the Application Registries page, click New to create a new OAuth application.
- In the corresponding screen, for What kind of OAuth application?, click Create an OAuth API endpoint for external clients.
- In the Application Registries New record form, enter the following details:
- For Name, enter
Atlan OAuth App
. - For Redirect URL, enter the redirect URL in the following format —
https://<atlan_instance_name>/oauth-callback
. Replace<atlan_instance_name>
with the name of your Atlan instance. - For Logo URL, copy and paste
https://assets.atlan.com/assets/atlan-primary-logo-png.png
. - Click Submit to create the OAuth application in ServiceNow.
- For Name, enter
- From the Application Registries page, select the OAuth application you created above. Copy the values for Client ID and Client Secret and store them in a secure location.
Connect Atlan to ServiceNow
To connect Atlan to ServiceNow, you will need the following:
- ServiceNow instance URL — for example,
https://<instance_name>.service-now.com
- Client ID and client secret of the OAuth application you created in ServiceNow
To connect Atlan to ServiceNow, from within Atlan:
- Log in to your Atlan instance as an admin user.
- From the left menu, click Admin.
- Under Workspace, click Integrations.
- In the ServiceNow tile, click the Connect button.
- In the corresponding Add to ServiceNow dialog, for ServiceNow URL, enter the URL of your ServiceNow instance — for example,
https://<instance_name>.service-now.com
. - Click Next to proceed.
- This step requires the creation of an OAuth application in ServiceNow, follow the steps to do so. If you have already created it, in the Create OAuth app section, for Copy the Client ID and Secret from the new OAuth app and paste below, enter the following:
- For Client ID, enter the client ID you copied from ServiceNow.
- For Client Secret, enter the client secret you copied from ServiceNow.
- Click Next to proceed.
- In the Commit update set section, click Atlan Update Set.xml to download the update set XML file from Atlan to import and commit in ServiceNow.
Configure the Atlan integration in ServiceNow
To configure the Atlan integration in ServiceNow, your ServiceNow System Administrator with a security_admin role will need to complete the following two steps:
- Import and commit the update set XML file downloaded from Atlan to create an Atlan data access catalog and business rule in ServiceNow.
- Create a new user in ServiceNow for the Atlan integration.
Import and commit the update set XML file
To import and commit the update set XML file, from within ServiceNow:
- Log in to your ServiceNow instance as a System Administrator with a security_admin role.
- From the top header of your ServiceNow instance, click All. From the dropdown, search for and select System Update Sets and then click Retrieved Update Sets.
- On the Retrieved Update Sets page, under Related Links, click the Import Update Set from XML link.
- On the Import XML page, to upload the update set XML file downloaded from Atlan:
- For Step 1: Choose file to upload, click Choose file to upload the Atlan Update Set.xml file.
- For Step 2: Upload the file, click the Upload button.
- In the top-left corner of your screen, click the back button to return to the Retrieved Update Sets page. The Atlan update set will appear on the Retrieved Update Set list in a Loaded state. Once the XML file has successfully loaded, select the Atlan Update Set.
- Click Preview Update Set to preview the update set and address any issues. The update set includes the following:
- Atlan Data Access catalog — Atlan will create data access requests in this catalog.
- Atlan Business Rule — this is required for Atlan to receive events from your ServiceNow instance to detect any changes in the status of data access requests created in Atlan and automatically update governance workflow requests.
- Atlan service role and access control list (ACL) updates — the Atlan service account requires a role with write access on the
sc_request
table to update specific fields such asdescription
,short_description
, and more. This operation especially requires the security_admin role to commit the update set from Atlan in ServiceNow. -
Scripted REST API — this is initially required to retrieve the username and sys_id of the Atlan user completing the ServiceNow integration. Atlan creates a Scripted REST API
/api/snc/oauth_userinfo
that returns the username and sys_id for an authenticated user. Once the integration has been completed, Atlan will have the access token required for the integration to continue working.
- Click Commit Update Set.
If the commit action fails, contact Atlan support.
Create a new user
To create a new user, from within ServiceNow:
- Log in to your ServiceNow instance as a System Administrator with a security_admin role.
- From the top header of your ServiceNow instance, click All. From the dropdown, search for and select User Administration and then click Users.
- In the top-right corner of the Users page, click New to create a new user.
- In the User New record form, enter the following details:
- For User ID, enter
atlan.service
. - For First name and Last name, enter
Atlan
andService
, respectively. - Click Submit to create the new user.
- For User ID, enter
- From the Users page, search for and select the
atlan.service
user you created. - On the User atlan.service page, scroll down to the table at the bottom of the screen. In the table, change to the Roles tab and then click the Edit button.
- On the Edit Members page, configure the following:
- In the Collection list, search for and select atlan_service_account_role.
- Click the greater than icon to add the role to the
atlan.service
user you created. - Click Save to save your role assignment for the new user.
- In the User atlan.service page, click the Set Password button to create a password for the new user.
- In the Set Password dialog, click the Generate button to generate a password. Once a password has been generated, click the clipboard icon to copy the value and store it in a secure location. Click Save Password. This password will be required to configure the ServiceNow integration in Atlan.
Configure the ServiceNow integration in Atlan
To configure the ServiceNow integration in Atlan, from within Atlan:
- Log in to your Atlan instance as an admin user.
- From the left menu, click Admin.
- Under Workspace, click Integrations.
- Expand the ServiceNow tile.Â
- In the Commit update set section, for Password, enter the password you copied from ServiceNow for the new user.
- Click the Connect and test button to test the ServiceNow integration. This ensures that the update set was committed successfully in ServiceNow and Atlan can receive webhook events. To test the latter, Atlan will create a sample request in ServiceNow, wait for a few seconds to receive a webhook event, and then display the status of the connection as CONNECTED.
- (Optional) Under the Configurations tab, for Test Connection, click the Run test button to verify that the ServiceNow integration is working properly in Atlan at any time.
- (Optional) At any future time, you can review the Overview tab to see the number of linked issues between ServiceNow and Atlan.
Atlan is now connected to ServiceNow! 🎉