Partager via

ServiceNow actions in Microsoft Purview workflows

  • Article

Important

This feature is currently in preview. The Supplemental Terms of Use for Microsoft Azure Previews include additional legal terms that apply to Azure features that are in beta, in preview, or otherwise not yet released into general availability.

You can use ServiceNow actions in Microsoft Purview workflows to manage and update your ServiceNow records during your data catalog and data governance workflows.

For a list of all available workflow actions, see our workflow actions page. To connect to your ServiceNow instance, follow the instructions below.

Set up authentication

Microsoft Purview uses Azure Key Vault to securely store the credentials it uses to connect to other services. Before we can connect to ServiceNow we need to create our ServiceNow credential in the Azure Key vault. Follow these steps:

  1. If you don't have an Azure Key Vault, you can follow this documentation to create one.
  2. Create a secret in your key vault. The value will be your ServiceNow basic authentication password.
  3. Grant Microsoft Purview access to your Azure Key Vault.
  4. Create a connection in Microsoft Purview to your Azure Key Vault.
  5. Create a new basic authentication credential in Microsoft Purview, providing your ServiceNow username and your key vault secret.

Now we have all the authentication pieces in place to connect to your ServiceNow instance.

Connect to ServiceNow

To access to your ServiceNow instance from Microsoft Purview workflows, first we'll create a connection. This allows Microsoft Purview to authenticate with ServiceNow.

Microsoft Purview uses basic auth credentials to connect to ServiceNow.

  1. In the Microsoft Purview governance portal, select the Management menu, and then select Connections.

    Screenshot of connections button in the management menu.

  2. Select the + New button to create a new connection.

  3. Select the ServiceNow data source.

  4. Name your connection, select the credential you created when you set up authentication, and provide your ServiceNow instance in this format:

    <instance>.service-now.com

    Screenshot of a new ServiceNow connection with the instance and credential provided.

  5. Select Save

Create ServiceNow action

When you're authoring any workflow (for example an approval workflow for business terms), you can add a ServiceNow action by following these steps.

  1. Add an action to your workflow by selecting the + button on the arrow between actions, select the Add an action button, or the + New Step button at the end of the flow. Where you add the action is where it will be executed in the workflow.

    Screenshot of a workflow, highlighting the various buttons that can be used to add an action.

  2. In the Choose an action menu, select ServiceNow.

    Screenshot of the choose an action menu, with the ServiceNow tab selected.

  3. Select the ServiceNow action you'd like to use, and fill out the parameters. For more information about each action, see the available ServiceNow actions list.

  4. Select Save to save your additions to the workflow.

Available actions

Connector Type Functionality Parameters Customizable Workflow templates
Create record Create a record for a ServiceNow object type. -Connection (your ServiceNow connection)
-Record type
-Record body
-Display system references toggle
-Exclude reference links toggle		 - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates
Delete record Delete a record for a ServiceNow object type. -Connection (your ServiceNow connection)
-Record type
-System ID		 - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates
Get record Get a record for a ServiceNow object type. -Connection (your ServiceNow connection)
-Record type
-System ID
-Display system references toggle
-Exclude reference links toggle		 - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates
Get record types List available record types. -Connection (your ServiceNow connection) - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates
List records Get records of a ServiceNow object type. -Connection (your ServiceNow connection)
-Record type
-Display system references toggle
-Exclude reference links toggle
-Query
-Limit (default is 10000)
-Offset		 - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates
Update record Updates a record for a ServiceNow object type. -Connection (your ServiceNow connection)
-Record type
-System ID
-Record body
-Display system references toggle
-Exclude reference links toggle		 - Renamable: Yes
- Deletable: Yes
- Multiple per workflow		 All workflows templates

Next steps

For more information about workflows, see these articles: