Entities in Solutions

Data Fabric entity lifecycle in Solutions, covering automatic dependency inclusion, install, upgrade, and uninstall management, and entity overrides at debug and runtime.

Data Fabric entities can be included as resources in a Solution. When you use a folder-level entity in a workflow that belongs to a Solution, the entity and its dependencies are packaged, deployed, and managed as part of the Solution lifecycle.

This page covers how entities behave at each stage — from modeling through deployment, runtime, upgrade, and uninstall.

How an entity becomes a Solution resource

When you add a Data Service activity to a workflow inside a Solution and select a folder-level entity, that entity is automatically registered as a Solution resource. You do not need to add it manually.

Automatic dependency inclusion

Adding an entity as a Solution resource also includes all of its dependencies. The included dependencies differ based on entity type.

Native entities

• Related entities — If Entity A has a relationship field pointing to Entity B, both entities are added as Solution resources.
• Choice sets — Any choice set used as a field type in the entity is included.
• Nested dependencies — If Entity B itself references Entity C, that entity is included as well. The full dependency chain is resolved automatically.

Federated entities

• Connections — Integration Service connections used by the federated entity are included.
• Native source entities — If a federated entity references a native entity as a data source, that native entity and its full dependency chain are included.

Note:

Tenant-level entities used in a workflow are not automatically packaged. They must already exist in the target environment for the deployed workflow to function. Only folder-level entities are included as Solution resources.

Supported surfaces

Data Fabric entities in Solutions are supported across the following workflow types:

Surface	Folder-scoped entities	Notes
RPA (Studio Web)	✅	Full support for build, debug, deploy
RPA (Studio Desktop 26.10 LTS)	✅	Solutions context only. Classic activities require UiPath.DataService.Activities v26.10.0
Maestro BPMN	✅
Maestro Case	✅
API Workflows	✅
Agents	✅ (Preview)
Maestro Flow	Via native entity nodes	Uses built-in nodes, not connector activities
Coded Apps	✅
Coding Agents	✅
Standalone VB Apps	❌
RPA (UB) Apps	❌

Note:

Local Workspace is not supported for folder-scoped entities via Data Service connector activities. Folder scope is available in cloud workspaces only.

Lifecycle

1. Create and model entities

Create folder-level entities in the Data Fabric UI. Set the Location to Folder and select the target Orchestrator folder. You can create both native entities and federated entities. Add fields, relationships, and choice sets as needed.

For relationship scoping rules, refer to Creating relationships. For federated entity setup, refer to Virtual entities.

2. Build a workflow

In Studio Web or Studio Desktop (26.10 LTS), add Data Service activities to your workflow. Each activity has a scope selector — choose Folder to work with folder-scoped entities.

Folder scope in the classic activities requires UiPath.DataService.Activities v26.10.0 or later, where it is generally available. For more information, refer to Classic activities.

Only entities from folders where you have access are displayed.

3. Debug

When you debug a workflow inside a Solution, the Debug configuration window shows all Solution resources, including entities.

For each entity, you can:

• Use the existing entity — Debug runs against the entity in its current folder.
• Override with a different entity — Select a compatible entity from another folder.
• Remove the selection — A new entity is created in a debug folder in your Personal Workspace, along with its dependencies.

Override is available only for entities directly referenced from an activity. A related entity (for example, Entity B referenced by Entity A through a relationship field) is not overridable unless you add a separate activity that references it directly from under Platform resources.

Note:

When overriding, ensure the replacement entity has a compatible schema. Mismatched relationships or missing fields can cause errors during execution.

4. Publish

Publish the Solution from Studio Web or Studio Desktop. The package includes the workflow, entity schemas, choice sets, and relationships. Only the schema is packaged — no data is included.

5. Deploy (install)

Deploy the package to a target folder from Orchestrator or from Studio Web.

During deployment:

• Folder-level entities are created automatically in the target folder.
• Choice sets and relationships are recreated.
• The workflow is bound to the newly created entities.

Only the schema is created. Existing data is not copied. Each environment maintains its own data.

Important:

Inline entity creation during deployment is not supported. Entities are created from the schema defined in the Solution package. If you need to create entities outside of a Solution, use the Data Fabric UI.

6. Run (runtime)

After deployment, run the workflow from Orchestrator. The automation interacts with the entities in the target folder, exactly as it did during development.

Runtime overrides via Package Requirements

After a Solution is deployed, you can change which entity a workflow uses without republishing. In Orchestrator, navigate to the deployed process and open the Package Requirements tab. Replace an entity with another compatible entity from the same or a different folder.

The replacement entity must have a compatible schema. The workflow runs using the overridden entity while all logic remains unchanged.

Only entities directly referenced from an activity appear in Package Requirements for override.

Note:

Deploy-time override is not supported. Entity overrides are available during debug and at runtime via Package Requirements.

7. Upgrade

When you modify the entity schema (for example, add a new field), republish the Solution and upgrade the deployment in Orchestrator.

During upgrade:

• The entity schema is updated in the target folder to match the new version.
• Existing data is preserved — no records are deleted or overwritten.
• New fields are added to the schema. Removed fields are dropped from the schema but underlying data is retained.
• If the entity already contains data, you can review what changes are applied before confirming the upgrade.
• If schema changes are incompatible (for example, a field type change), the upgrade displays a conflict. Navigate to the Data Fabric UI to review and resolve the conflict between the source and destination entity schemas before retrying the upgrade.

8. Uninstall

Uninstalling a Solution removes the workflow and associated resources from the target folder.

Entity behavior during uninstall depends on whether the entity contains data:

• Entities with no data — Removed along with their choice sets and relationships.
• Entities with data — Preserved to prevent accidental data loss. The entity remains in the folder and can be managed directly in the Data Fabric UI, unless the folder is deleted.

Lifecycle behavior summary

Operation	Entity schema	Entity data	Choice sets	Relationships
Install	Created in target folder	Not copied — starts empty	Recreated	Recreated
Upgrade	Updated to match new version	Preserved	Updated	Updated
Uninstall (no data)	Removed	N/A	Removed	Removed
Uninstall (has data)	Preserved	Preserved	Preserved	Preserved

Schema refresh

When an entity schema changes in Data Fabric after you have already selected it in an activity, use the Refresh button next to the entity selector in Studio Web. The Refresh button updates the schema of the selected entity and all of its related entities in a single action.

• Connector activities (Data Fabric connector) — The Refresh button is always enabled. To see newly added or removed fields, first open the Solution resource for the entity and select Update Configuration, then return to the activity and select Refresh Schema.
• Legacy activities (Data Service classic package) — For Native entities, the Refresh button is enabled only when a schema change is detected for the selected entity. Selecting it updates the schema directly. Schema refresh for Federated entities is not supported in these activities.

Cloning entities across scopes

You can copy an entity schema from one scope to another using export and import. For example, to use a tenant-level entity design in a folder, you export the schema from the tenant level in the Data Fabric UI, which exports all tenant-level native entity schemas at once. You then import that file at the target folder level, choosing which of the exported entities and choice sets to bring into the folder.

The selected entities are created in the target folder with the same schema. No data is copied. For the detailed export and import procedure, refer to Schema export and import.

Known limitations

Folder-level entities in Solutions carry limitations on deploy-time overrides, cross-scope relationships, entity naming, and unsupported surfaces. For the full list, refer to Known limitations.