UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Insert ImportSet Records

The Insert ImportSet Records activity uses the ServiceNow ImportSet API to update existing or insert new records.

After completing the operation, the activity outputs the result of the insert in a DataTable object (Result) and the operation status (success/failure information) in in a ResponseStatus object (ServiceNowStatus) that you can use in subsequent activities (e.g., conditional logic).

Best Practice

This activities package provides four different methods to update and/or insert a record: Update ServiceNow Record, Insert ServiceNow Record, Upsert Records, or Insert ImportSet Records.

The Update ServiceNow Record, Insert ServiceNow Record, and Upsert Records activities use REST APIs to write directly to a production table. The Insert ImportSet Records activity uses the REST Import Set API to write to an import set table from which the data gets transformed into the target production table.

To avoid writing directly to production tables, it's recommended that you use the Insert ImportSet Records activity to update or insert a new record.

For detailed information, including troubleshooting import set performance, see the import sets in the ServiceNow documentation.

To learn more about using import sets, see Web Service Import Set and Importing Data into ServiceNow in the ServiceNow documentation.

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the ServiceNow Scope activity to your project.
  3. Add the Insert ImportSet Records activity inside the ServiceNow Scope activity.
  4. Click the Configure button inside the Insert ImportSet Records activity (this opens the Object Wizard).
  5. Select the Object that you want to use for your import set and enter your Input properties.
  6. Create and enter a DataTable variable and a ResponseStatus variable for the Output properties.
    • Your input property values are sent to the ImportSet API.
    • The API returns the DataTable andResponseStatus` values to your output property variables.

Configure

To select your import set, you must use the Object Wizard by clicking the Configure button.

To learn more about the Object Wizard, see the Business Activity Frameworks page.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Insert ImportSet Records

Allowed values

Enter a String or String variable.

Notes

N/A


Input

DataTable

The data that you want to insert.

Attributes
Details

Type

DataTable

Required

Yes

Default value

Empty

Allowed values

Enter a DataTable variable.

Notes

N/A


Object

The import set that you want to use.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Use the Object Wizard to select your Import Set.

Notes

  • The *Object Wizard drop-down list includes the import sets that you have in your ServiceNow application.

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

ServiceNowStatus

The status of the request (success/failure information).

Attributes
Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

  • The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.
  • The example image below shows some of the properties that you can return.

Result

The result data of the insert.

Attributes
Details

Type

DataTable

Required

Yes

Default value

Empty

Allowed values

Enter a DataTable variable.

Notes

N/A

Updated about a month ago


Insert ImportSet Records


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.