Skip to content

Error Messages

When a validation fails, DAQS shows an error message to the user directly in the Revit plugin. The message is the final step in the rule — it tells the user what is wrong and what to do about it.

A technically correct rule with a poor error message is still a bad rule. Users triage issues by reading messages. If the message is vague, the issue gets ignored.

Where error messages appear

Error messages are shown in the DAQS Assist panel inside Revit. Users see them while working in the model — not in a separate report tool.

This means: - Messages must be immediately actionable - Users cannot look up additional context unless a Help URL is provided - The message competes with everything else the user is doing

The required structure

Every error message must follow this structure:

#### Issue

Describe what is wrong with this specific element.

---

#### Solution

Describe what the user must do to fix it.

---

#### Explanation

Explain why this requirement exists.

All three sections are mandatory. Skipping "Explanation" leaves users without context for why they should fix it. Skipping "Solution" leaves them without direction.

Using filter output in error messages

Any field returned by the filter can be referenced in the error message using {{fieldName}} syntax.

#### Issue

The element **{{name}}** has an invalid Assembly Code.

The current value is **{{assemblyCode}}**, which is not in the allowed list.

The placeholder is replaced with the actual value for each failing element. Double curly braces are required.

For the full reference, see Using Filter Output in Error Messages.

Dynamic content with Scriban

When an error message must show a list or table — for example, all missing parameters for an element — use Scriban template syntax.

| Missing parameter |
|---|
[[~ for $p in {{missingParams}} ~]]
| **`[[ $p ]]`** |
[[~ end ~]]

For the full reference, see Dynamic Tables with Scriban.

Pages in this section