- 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 rules
Syntax and options for `uip rules`, which scaffolds, validates, and debugs UiPath Business Rules (DMN) projects and reads the rules deployed to Orchestrator.
uip rules is the Business Rules tool. It creates and maintains Business Rules projects on disk, where each rule is a DMN decision table in a .dmn file, and reads the business rules deployed to Orchestrator folders. Install it with uip tools install rules, or invoke uip rules … and let auto-install run. Refer to Tools (plugins) for the install model.
A Business Rules project is one project inside a solution. Packing, publishing, and deploying it goes through uip solution.
Commands
| Command | Operates on | Purpose |
|---|---|---|
init | Local filesystem | Create a Business Rules project seeded with one decision table and register it in the enclosing solution. |
refresh | Local filesystem | Regenerate entry-points.json and bindings_v2.json from the project's .dmn files. |
validate | Local filesystem | Check the project's .dmn files and its entry-points.json for what Studio Web blocks publish and debug on. |
debug | Studio Web | Upload the project's solution to Studio Web and evaluate it once through the rules engine. |
list (Preview) | Orchestrator | List the business rules deployed to a folder. |
get (Preview) | Orchestrator | Get one deployed business rule by name. |
versions (Preview) | Orchestrator | List the versions of a deployed business rule. |
describe (Preview) | Orchestrator | Get the entry points of a deployed rule's active version, with their input and output argument schemas. |
list, get, versions, and describe are labeled Preview in the command help. Refer to Versioning for what the Preview label means.
Synopsis
uip rules init <name> [--force] [--skip-solution-registration]
uip rules refresh <project-path>
uip rules validate <project-path>
uip rules debug <project-path> [-i <json|@file.json>] [--explain] [--folder-path <path> | --folder-key <key>] [--timeout <seconds>] [--login-validity <minutes>]
uip rules list (--folder-path <path> | --folder-key <key>) [-l <number>] [--offset <number>]
uip rules get <rule-name> (--folder-path <path> | --folder-key <key>)
uip rules versions <rule-name> (--folder-path <path> | --folder-key <key>) [-l <number>] [--offset <number>]
uip rules describe <rule-name> (--folder-path <path> | --folder-key <key>)
uip rules init <name> [--force] [--skip-solution-registration]
uip rules refresh <project-path>
uip rules validate <project-path>
uip rules debug <project-path> [-i <json|@file.json>] [--explain] [--folder-path <path> | --folder-key <key>] [--timeout <seconds>] [--login-validity <minutes>]
uip rules list (--folder-path <path> | --folder-key <key>) [-l <number>] [--offset <number>]
uip rules get <rule-name> (--folder-path <path> | --folder-key <key>)
uip rules versions <rule-name> (--folder-path <path> | --folder-key <key>) [-l <number>] [--offset <number>]
uip rules describe <rule-name> (--folder-path <path> | --folder-key <key>)
All commands honor the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract.
Project layout
uip rules init creates a project directory with these files:
| File | Contents |
|---|---|
project.uiproj | Project name and ProjectType: "BusinessRules". |
Business rule.dmn | The seeded decision table. |
entry-points.json | The rule's entry points, derived from the .dmn files. |
bindings_v2.json | The rule's resource bindings, derived from the .dmn files. |
refresh, validate, and debug take the project directory as <project-path>. The directory must contain project.uiproj and at least one .dmn file at its top level.
Typical flow
- Scaffold the project with
uip rules init. - Edit the
.dmnfile, in Studio Web or in a local editor. - After editing a
.dmnfile outside Studio Web, regenerate the entry points withuip rules refresh. - Check the project with
uip rules validate. - Evaluate the rule with sample inputs with
uip rules debug. - Pack, publish, and deploy the solution with
uip solution. - Read the deployed rule and its argument schemas with
uip rules describewhen binding it from a BPMN process, RPA workflow, or case.
See also
uip solutionfor packing, publishing, and deploying the solution that holds the rules project.uip tracesfor reading the trace thatuip rules debug --explainpublishes.- Global options and Exit codes for the contracts shared by every command.