- 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 validate
Syntax and options for `uip rules validate`, which checks a Business Rules project for the errors Studio Web blocks publish and debug on.
uip rules validate checks a Business Rules project for what Studio Web blocks publish and debug on. It reports two kinds of diagnostics:
- The Studio Web designer's diagnostics for each
.dmnfile at the top level of the project. Their codes start withDMN_. RULES_ENTRY_POINTS_STALEwhenentry-points.jsondoes not match the.dmnfiles. Runuip rules refreshto fix it.
Diagnostics with severity error fail the command. Diagnostics with severity warning are reported only. The command does not write any file.
Synopsis
uip rules validate <project-path>
uip rules validate <project-path>
Arguments
| Name | Required | Purpose |
|---|---|---|
<project-path> | yes | Path to the Business Rules project directory. The directory must contain project.uiproj. |
Example
uip rules validate ./LoanEligibilitySolution/LoanEligibility
uip rules validate ./LoanEligibilitySolution/LoanEligibility
Data shape (--output json)
{
"Code": "RulesValidate",
"Data": {
"Status": "Valid",
"ProjectPath": "/workspace/LoanEligibilitySolution/LoanEligibility",
"DmnFiles": ["Business rule.dmn"],
"Diagnostics": []
}
}
{
"Code": "RulesValidate",
"Data": {
"Status": "Valid",
"ProjectPath": "/workspace/LoanEligibilitySolution/LoanEligibility",
"DmnFiles": ["Business rule.dmn"],
"Diagnostics": []
}
}
When the project has at least one error, the command returns a failure envelope with Code: "RulesValidate", ErrorCode: "invalid_argument", and Data.Status: "Invalid". Instructions lists each diagnostic on its own line.
Each entry in Diagnostics has these fields:
| Field | Description |
|---|---|
File | The file the diagnostic applies to: a .dmn file, or entry-points.json. |
Code | The diagnostic code, for example RULES_ENTRY_POINTS_STALE. |
Severity | error or warning. |
Message | The diagnostic message. |
Instructions | How to fix the issue, when available. |
Target | The element of the document the diagnostic points to. |
Exit codes
Refer to Exit codes for the shared contract. The command exits 1 when any diagnostic has severity error, or when the project has no .dmn file at its top level (ErrorCode: "not_found").
Related commands
uip rules refreshfixesRULES_ENTRY_POINTS_STALE.uip rules debugevaluates the rule with sample inputs.
See also
uip rulesfor the tool overview and project layout.