Subscribe

UiPath Studio

The UiPath Studio Guide

Importing Entities

Entities enable you to use records from the UiPath Data Service, a centralized data modelling and storage service. Entities are available for import in Studio v2020.8 and up, and can be used in automation processes that collect, update, and pass data to other processes. All project types can be used for importing and working with such business objects.

📘

Note:

A modern robot must be created in the Orchestrator instance on the tenant where the Data Service is enabled.

To import an entity:

  1. Click the Manage Entities ribbon button to open the Manage Entities window and view all available entities. If no entities have been added yet, all the entities are selected by default.
    Alternatively, you can drag an entity from the Resources panel and drop it on the Project panel. If no entities have been added yet, this opens the Manage Entities window with only that entity selected.
  1. Select the entity you want to import. To find a specific entity, use the Search Entities bar and type the entity name, display name, or description.
    You can hover over the entries in the Fields column to see all the defined fields of each entity, or click the number of fields or records for an entity to navigate to the corresponding page in the Data Service.
  2. Enter a namespace for the imported entity. The default namespace is the same as the project name. The namespace can only be edited the first time you import an entity.
  3. Click Save to import the entity in your project.

📘

Note:

If you make any changes to the entity at the level of the tenant, use the Refresh button inside the Manage Entities window before actually importing it.

Imported entities are visible in the Project panel as objects part of your project.

The imported entities can now be used locally in your project as objects. If you want to perform CRUD operations on them in the Data Service as well, you need to install the UiPath.DataService.Activities pack.

After installing the UiPath.DataService.Activities pack, drag and drop an entity on top of a plus sign in the Designer panel to use the recommended activities from the pack.

Drag and drop an entity from the Project panel into the Variables or Arguments panel to create a variable or argument with the entity type.

Namespaces for Entities

After you import an entity in your workflow, its namespace is imported as well. You can find it when you browse for types under Referenced assemblies.

All fields part of an imported entity are available as properties for the entity namespace. Thus, when working with entities the number of variables or arguments for managing data is reduced.

In the below example, the argument is of the type defined by the entity StockPortfolio, its properties visible in the Resources panel are the same as the fields defined in the entity and available as properties for the argument.

Check out the Using Entities in Projects page to see how to use them.

Updated 2 months ago

Importing Entities


Suggested Edits are limited on API Reference Pages

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