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 .dmn file at the top level of the project. Their codes start with DMN_.
• RULES_ENTRY_POINTS_STALE when entry-points.json does not match the .dmn files. Run uip rules refresh to fix it.

Diagnostics with severity error fail the command. Diagnostics with severity warning are reported only. The command does not write any file.

Zusammenfassung

uip rules validate <project-path>

Argumente

Name	Erforderlich	Zweck
<project-path>	ja	Path to the Business Rules project directory. The directory must contain project.uiproj.

Beispiel

uip rules validate ./LoanEligibilitySolution/LoanEligibility

Datenform (--output json)

{
  "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:

Feld	Beschreibung
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 oder warning.
Message	The diagnostic message.
Instructions	How to fix the issue, when available.
Target	The element of the document the diagnostic points to.

Exitcodes

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").

Zugehörige Befehle

• uip rules refresh fixes RULES_ENTRY_POINTS_STALE.
• uip rules debug evaluates the rule with sample inputs.

Siehe auch

• uip rules for the tool overview and project layout.