Entities in VS Code

Model a Data Fabric entity in VS Code alongside your flows, then consume it from the built-in Data Fabric nodes.

Note:

This is a Preview capability.

Data Fabric's integration with Flow in VS Code has two parts:

• A new Data Fabric Entity project type for UiPath solutions — the same way Maestro BPMN and Maestro Flow are project types. VS Code is the first canvas to support it. Support for Studio Desktop and Studio Web is planned for a later release. Model an entity's schema without leaving VS Code, then consume it from your flows.
• Four new native nodes — Query entity records, Create entity record, Update entity record, and Delete entity record — for consuming entities from a flow. These are native Flow nodes, not Integration Service (IS) connector activities: they don't require an IS connection, and their output is a live-reference variable to the affected record, except Delete entity record, which doesn't produce one. For node details, refer to Data Fabric entity nodes.

For Flow GA, entity projects are scoped to native (folder) entities only. Federated entities, tenant entities, and extending an existing entity's schema aren't supported yet.

In the project type selector, Data Fabric Entity appears alongside the Flow project types.

Create an entity project

To create an entity project:

1. In the Solution Explorer title bar, select Create New Project, then choose Data Fabric. The command is also available from the Command Palette as UiPath: Create New Project.

2. Select + Add field.

3. For each field, set a Display name, Name, and Type, and optionally mark it Required or Unique. For the available types, refer to Supported field types.

   

4. Save the entity.

Result: VS Code creates a .entity file for the project. Opening it in a text editor shows its underlying JSON.

A solution that contains only an entity project (no Flow project) can be packaged, but deploying it fails today — Studio Web doesn't yet support deploying an entity-only project, so your solution needs at least one Flow project before you deploy.

Supported field types

Type	Stores
Text	A single line of text.
Number	A numeric value, with optional decimal places and minimum and maximum bounds.
Yes-No	A true or false value.
Date	A calendar date.
Date-Time	A date and a time.
Auto-number	A number the platform increments for each new record, from a starting value you set.
Multi-line Text	Text across multiple lines.
Multi-line (Max)	Multi-line text with the largest size the platform allows.

Known limitations

An entity created in VS Code can't be edited in Studio Web. You can import and open a solution containing a Flow project and a Data Fabric entity project in Studio Web, but Studio Web can't make changes to the entity itself. Editing an entity's schema is only possible in VS Code.

An entity isn't listed in a connector-based Data Fabric activity. Entities created inside a VS Code solution don't appear in the entity picker of existing Integration Service (IS) connector-based Data Fabric activities. For Flow GA, these entities can only be read, created, updated, or deleted using the built-in entity nodes. Support for consuming them through connector-based activities is planned for a release after Flow GA.

Commands

Run these from the Command Palette, or from the Solution Explorer as noted.

Command	What it does
UiPath: Create New Project	Creates the entity project. Choose Data Fabric when prompted for the project type. Also in the Solution Explorer title bar.
UiPath: New File	Adds a file to a project. Choose Entity File to add an entity. Also in the Solution Explorer title bar.
UiPath: Add Entity File	Adds another entity to an existing entity project. Appears only once the solution has one, and is also on the right-click menu of an entity project.

Entity creation has no default keyboard shortcut. For the extension's full command list, refer to Flow in VS Code.

Related pages

• Flow in VS Code
• Data Fabric entity nodes
• Deploying a flow