- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip rpa data-fabric-entities install
Syntax and options for `uip rpa data-fabric-entities install`, which applies an add/remove delta to the Data Fabric entity bindings of a project.
uip rpa data-fabric-entities install applies an add/remove delta to the Data Fabric entity bindings of the active project. Names listed in --add are installed (and any entities they reference are pulled in transitively); names in --remove are dropped. If the resulting selection is empty the project's entity bindings are uninstalled entirely. Entities that no longer exist server-side are silently skipped, and the response reports what is actually installed at the end.
Studio rewrites the project bindings, so the verb requires a Windows runner. Run it after uip rpa data-fabric-entities list (to know what is available) and before any build or validation step that depends on the generated entity types.
Synopsis
uip rpa data-fabric-entities install [--add <array>] [--remove <array>] [--service-document <string>] [--namespace <string>]
uip rpa data-fabric-entities install [--add <array>] [--remove <array>] [--service-document <string>] [--namespace <string>]
Options
| Flag | Description |
|---|---|
--add <array> | Entity names to add to the installed set, e.g. ["Customer", "Invoice"]. Defaults to an empty array. |
--remove <array> | Entity names to remove from the installed set, e.g. ["LegacyOrder"]. Defaults to an empty array. |
--service-document <string> | Optional project-relative service document path. If omitted, the project's default service document is used. |
--namespace <string> | Optional .NET namespace for the generated entity types. If omitted, Studio reuses the previous namespace or derives one from the project name. |
For the complete option list on your installed tool version, run:
uip rpa data-fabric-entities install --help
uip rpa data-fabric-entities install --help
Examples
# Add two entities, leave the rest of the binding set alone
uip rpa data-fabric-entities install \
--add '["Customer", "Invoice"]'
# Swap one entity for another in a single call
uip rpa data-fabric-entities install \
--add '["NewOrder"]' \
--remove '["LegacyOrder"]' \
--namespace MyOrg.DataFabric
# Add two entities, leave the rest of the binding set alone
uip rpa data-fabric-entities install \
--add '["Customer", "Invoice"]'
# Swap one entity for another in a single call
uip rpa data-fabric-entities install \
--add '["NewOrder"]' \
--remove '["LegacyOrder"]' \
--namespace MyOrg.DataFabric
Related
uip rpa data-fabric-entities list— discover available entity names before installing.