A card that displays data exceptions filtered by a specific exception message. The component shows all exceptions from the parent data object that match the configured message, displaying both the exception message as a header and detailed exception information in markdown format.
Type
Properties
Required Properties
| Property | Type | Description |
|---|
| exceptionMessage | string | The message to filter exceptions by |
Optional Properties
None
Layout
- Default Width: 12 columns
- Default Height: 4 rows
- Supports Children: No
Configuration Example
- type: exceptions
id: validationErrors
properties:
exceptionMessage: "Validation Failed"
layout:
x: 0
y: 0
w: 12
h: 4
Advanced Usage
Exception Filtering
The component filters the parent data object’s exceptions to show only those with a message exactly matching the exceptionMessage property. This allows you to create multiple exception cards displaying different categories of exceptions.
Markdown Support
Exception details are rendered using the KodexaMarkdown component, which means exception details can include:
- Formatted text
- Lists
- Code blocks
- Links
- Other markdown features
Parent Data Object Requirement
This component requires a parent data object to function. It’s typically used within a card panel or similar container that provides the data object context. If no parent data object is available, the component displays an empty state.
Multiple Exceptions
If multiple exceptions match the filter criteria, each exception is displayed in its own section with:
- The exception message as a heading
- The detailed exception information below
Example: Multi-Category Exception Display
- type: cardPanel
id: invoicePanel
properties:
groupTaxon: "invoice"
title: "Invoice Processing"
layout:
x: 0
y: 0
w: 12
h: 12
children:
# Data entry fields...
# Validation exceptions
- type: exceptions
id: validationErrors
properties:
exceptionMessage: "Validation Failed"
layout:
x: 0
y: 8
w: 6
h: 4
# Processing exceptions
- type: exceptions
id: processingErrors
properties:
exceptionMessage: "Processing Error"
layout:
x: 6
y: 8
w: 6
h: 4
Example: Exception Details with Markdown
When your processing pipeline creates exceptions like:
exception = {
"message": "Validation Failed",
"details": """
## Missing Required Fields
The following required fields are missing:
- **Invoice Number**: Must be present
- **Date**: Must be in YYYY-MM-DD format
- **Total Amount**: Must be a positive number
### Recommended Actions
1. Review the source document
2. Add missing information
3. Re-run validation
"""
}
Notes
- This component is view-only and does not support editing or dismissing exceptions
- Exceptions are typically generated by validation rules or processing pipelines
- The white card with shadow styling provides clear visual separation
- Exception details support rich markdown formatting for better readability
- Each exception has a unique ID for proper Vue key tracking
- The component automatically updates when parent data object exceptions change
- Empty state is handled gracefully when no exceptions match the filter
Use different exception messages to categorize errors (e.g., “Validation Failed”, “Data Quality Issue”, “Processing Error”) and display them in separate exception cards for better organization.
