Xeku.Triggers 0.0.0.7

Xeku.Triggers

A DevExpress XAF module that provides object change detection and webhook triggering capabilities.

繁體中文文檔

Features

• Trigger Rules: Define rules to monitor specific object types and CRUD events.
• Webhook Delivery: Automatically send JSON payloads to remote endpoints.
• Script Actions: Execute internal C# scripts (via Xeku.Scripts) as an alternative to webhooks. Support for both Action and Validator (judgment-based) modes.
• Criteria Filtering: Use XAF criteria string to filter when triggers fire.
• Execution Logging: Detailed logs for every trigger event (Webhook or Script) with retry options.
• Admin Tools: Built-in actions to test triggers and clean up old logs.

Architecture

graph TD
    User[User / System] --> DB[Database Change]
    DB --> Hook[ObjectSpace Events]
    Hook --> Engine[Trigger Engine]
    Engine --> Rule{Rule Matches?}
    Rule -- Yes --> ActionType{Action Type?}
    
    ActionType -- Webhook --> HTTP[HttpClient / External API]
    ActionType -- Script --> ScriptEngine[Xeku.Scripts Engine]
    
    HTTP --> Log[Trigger Execution Log]
    ScriptEngine --> Log
    
    Rule -- No --> End[Skip]

Installation

1. NuGet Package

dotnet add package Xeku.Triggers

Configuration

Core Module

Register the module in your platform-agnostic module:

public sealed class MyModule : ModuleBase {
    public MyModule() {
        RequiredModuleTypes.Add(typeof(Xeku.Triggers.TriggersModule));
    }
}

Blazor Integration

The Blazor module enables script code editing with the Monaco editor.

// Startup.cs ConfigureServices
services.AddTriggers(); // Includes Scripts.Blazor

// ApplicationBuilder
builder.Modules.Add<Xeku.Triggers.Blazor.TriggersBlazorModule>();

Features

Script Actions (v2.0)

Triggers can now execute dynamic C# scripts instead of webhooks. Scripts support:

• Action: Fire-and-forget logic (e.g., background processing).
• Validator: Synchronous logic that can block/log failures.
• Transformer: Data conversion before processing.

Usage

Creating a Trigger Rule

1. Navigate to Trigger Rule.
2. Set Target Type and select events (Created, Modified, Deleted).
3. Provide the Webhook URL and optional HTTP Headers.
4. (Optional) Set Criteria to refine trigger conditions.

AI Agent Integration

Suggested Context

• Performance: Webhooks are sent asynchronously; however, avoid heavy logic in trigger evaluation.
• Security: Always use HTTPS for webhook URLs.

Common Tasks

• "Create a trigger to notify Slack when a new high-priority Task is created."
• "Show me all failed webhook deliveries from the last hour."

Related Modules

• Xeku.DataMirror - Mirrored data receiver.

License

MIT License