ServiceNow v2 (Beta) Update activity

Introduction

A ServiceNow v2 (Beta) Update activity, using its ServiceNow v2 (Beta) connection, updates existing records in ServiceNow and is intended to be used as a target to consume data in an operation.

Create a ServiceNow v2 (Beta) Update activity

An instance of a ServiceNow v2 (Beta) Update activity is created from a ServiceNow v2 (Beta) connection using its Update activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing ServiceNow v2 (Beta) Update activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a ServiceNow v2 (Beta) Update activity

Follow these steps to configure a ServiceNow v2 (Beta) Update activity:

• Step 1: Enter a name and select a ServiceNow object
  Provide a name for the activity and select a ServiceNow object.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and select a ServiceNow object

In this step, provide a name for the activity and select a ServiceNow object. Each user interface element of this step is described below.

• Endpoint menu: If you have multiple endpoints of the same connector type configured, a menu at the top of the screen displays the current endpoint name. Click the menu to switch to a different endpoint. For more information, see Change the assigned endpoint in Configuration screens.

  • Edit endpoint: Appears when you hover over the current endpoint name. Click to edit the currently selected endpoint's connection configuration.

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

• Select an object: This section displays objects available in the ServiceNow v2 (Beta) endpoint.

  • Selected object: After an object is selected, it is listed here.

  • Search: Enter any column's value 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 are 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 or the word Refresh to reload objects from the ServiceNow v2 (Beta) endpoint. This may be useful if objects have been added to ServiceNow. This action refreshes all metadata used to build the table of objects displayed in the configuration.

  • Selecting 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 v2 (Beta) endpoint:

    • Name: The object name from ServiceNow.

    • Description: The object description from ServiceNow.

  Tip

  If the table does not populate with available objects, the ServiceNow v2 (Beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Optional settings: Click to expand additional optional settings:

  • Use HTTP verb PUT: Select to use PUT instead of PATCH (default) for the update request.

    • PUT replaces entire object records with the data provided for the update. If a field is excluded from the PUT update, the object record field's value will be set to null or a defined default value in ServiceNow. Due to this behavior, all required fields for an object must be included in the update.
    • PATCH replaces object record data on a field-by-field basis, allowing for partial updates. If a field is excluded from the PATCH update, the object record field's value will remain unchanged in ServiceNow.

  • Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

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

• Next: Click to temporarily store the configuration for this step and continue to the next step. 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 the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The ServiceNow v2 (Beta) connector uses the ServiceNow REST API. Refer to the API documentation for information on the schema nodes and fields.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the ServiceNow v2 (Beta) endpoint. This action also regenerates a 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 v2 (Beta) Update activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

ServiceNow v2 (Beta) Update activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.