uipath-cli
latest
false
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
Last updated May 7, 2026
uip rpa add-test-data-entity wires a UiPath Data Service entity into a test case as its data source. Studio adds an argument of the entity type to the test case file, named after the entity, so each test invocation receives a strongly-typed entity record.
The verb is driven by Studio, so it requires a Windows runner. A Data Service-enabled tenant in Automation Cloud is also required — discover the entity name and its full type name there before calling this verb.
Synopsis
uip rpa add-test-data-entity --test-case-path <string> --entity-name <string> --entity-type-name <string>
uip rpa add-test-data-entity --test-case-path <string> --entity-name <string> --entity-type-name <string>
Options
| Flag | Description |
|---|---|
--test-case-path <string> | Relative path to the test case file (.xaml or .cs) within the project directory. |
--entity-name <string> | Name of the Data Service entity. |
--entity-type-name <string> | Full type name of the entity (e.g. MyEntity or a namespace-qualified type). |
For the complete option list on your installed tool version, run:
uip rpa add-test-data-entity --help
uip rpa add-test-data-entity --help
Examples
# Bind the Customer entity as a data source to a XAML test case
uip rpa add-test-data-entity \
--test-case-path Tests/CustomerOnboarding.xaml \
--entity-name Customer \
--entity-type-name Customer
# Bind a namespace-qualified entity to a coded test case
uip rpa add-test-data-entity \
--test-case-path Tests/InvoiceFlow.cs \
--entity-name Invoice \
--entity-type-name MyOrg.Finance.Invoice
# Bind the Customer entity as a data source to a XAML test case
uip rpa add-test-data-entity \
--test-case-path Tests/CustomerOnboarding.xaml \
--entity-name Customer \
--entity-type-name Customer
# Bind a namespace-qualified entity to a coded test case
uip rpa add-test-data-entity \
--test-case-path Tests/InvoiceFlow.cs \
--entity-name Invoice \
--entity-type-name MyOrg.Finance.Invoice
Related
uip rpa add-test-data-queue— bind an Orchestrator Test Data Queue instead of a Data Service entity.uip rpa add-test-data-variation— bind a CSV or Excel variation file.uip rpa create-project— scaffold the test project before adding data sources.uip tm testcase— manage the matching test case in Test Manager.