Skip to end of metadata
Go to start of metadata


A ServiceNow Delete activity deletes an existing record from a ServiceNow connection and is intended to be used as a target to consume data in an operation. After configuring a ServiceNow connection, you can configure as many ServiceNow activities as you like for each ServiceNow connection.

Creating a ServiceNow Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the ServiceNow connection block to display activities that are available to be used with a ServiceNow connection:

ServiceNow activities

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a ServiceNow activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: Opens the activity configuration screen for you to configure the activity. For details, see Configuring a ServiceNow Delete Activity later on this page.

  • Delete: Permanently deletes the activity. A message asks you to confirm that you want to delete the activity.

  • Rename: Positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Removes the activity as a step in the operation without deleting it from the project. (This is available only from the actions menu on the design canvas.) When you remove an activity that is adjacent to a transformation and schemas are provided within that activity, the schemas are no longer referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: Deploys the activity and any components it is dependent on.

  • Configurable Deploy: Opens the deployment screen, where you can select project components to deploy.

  • Add to Group: Opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: Creates a copy of the activity as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a ServiceNow Delete Activity

Follow these steps to configure a ServiceNow Delete activity:

Step 1: Select an Object

ServiceNow Delete Activity Configuration Step 1

  • Name: Enter a name to use to identify the ServiceNow Delete activity. The name must be unique for each Delete activity and must not contain forward slashes (/) or colons (:).

  • Select an Object: This section displays objects available in the ServiceNow endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • Selected ServiceNow Object: After an object is selected, it will be listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the ServiceNow endpoint. This may be useful if you have recently added objects to the ServiceNow instance. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Select an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the ServiceNow endpoint:

      • Name: The object name from ServiceNow.

      • Description: The object description from ServiceNow.

    TIP: ServiceNow Personal Developer Instances are known to "go to sleep" if you haven't recently logged in to the ServiceNow UI. If the table does not populate with available objects, first ensure that the ServiceNow instance is active, and then ensure you are connected to it by reopening the ServiceNow connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to continue to the next step and temporarily store the configuration. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review Data Schema

ServiceNow Delete Activity Configuration Step 2

  • Data Schema: The request and response data schemas for ServiceNow will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The ServiceNow connector uses the ServiceNow API. Refer to the schemas documentation for information on the schema fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a ServiceNow Delete activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

ServiceNow Delete activities can be used as a target with these operation patterns:

Other patterns are not valid using ServiceNow Delete activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a ServiceNow Delete activity in the Two-Transformation Pattern.

In this example, the first transformation (ServiceNow Delete Request) creates a request structure that is passed to the ServiceNow Delete activity. The second transformation (ServiceNow Delete Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write ServiceNow Delete Response) and a message is then logged by the Write to Operation Log script:

ServiceNow Delete operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Nov 12, 2019

  • No labels