Xeku.ESign.Blazor 0.0.0.7

Xeku.ESign.Blazor

Blazor Server UI components and controllers for the Xeku.ESign electronic signature module.

繁體中文文檔

Features

• SignAgent List View Controller: Enhanced UI for managing delegation records
• SignStep Nested List View Controller: Interactive step management in nested views
• ESign API Endpoint: RESTful API for external system integration

Architecture

graph TB
    subgraph "Presentation (#e1f5ff)"
        Controllers["View Controllers"]
        API["eSign API Endpoint"]
    end
    
    subgraph "Service/Logic (#fff4e1)"
        Core["Xeku.ESign"]
        StatusMgr["SignStatusManager"]
        StepMgr["SignStepManager"]
    end
    
    subgraph "Data/Entity (#e8f5e9)"
        SignStep["SignStep"]
        SignAgent["SignAgent"]
    end
    
    subgraph "External (#f3e5f5)"
        ExternalSys["External Systems"]
    end
    
    Controllers --> Core
    API --> StatusMgr
    API --> StepMgr
    ExternalSys --> API
    Core --> SignStep
    Core --> SignAgent
    
    style Controllers fill:#e1f5ff
    style API fill:#e1f5ff
    style Core fill:#fff4e1
    style StatusMgr fill:#fff4e1
    style StepMgr fill:#fff4e1
    style SignStep fill:#e8f5e9
    style SignAgent fill:#e8f5e9
    style ExternalSys fill:#f3e5f5

Installation

1. NuGet Package

dotnet add package Xeku.ESign.Blazor

2. Add Module Reference

// In your Blazor module constructor
RequiredModuleTypes.Add(typeof(Xeku.ESign.Blazor.ESignBlazorModule));

3. Configure API Endpoint (Optional)

In Startup.cs or Program.cs:

app.MapControllers(); // Ensures the eSign API endpoint is mapped

View Controllers

SignAgentListViewController

Provides enhanced UI for managing sign agent (delegation) records in list views.

Features:

• Bulk delegation management
• Quick filtering by date range
• Visual indicators for active/expired delegations

SignStepNestedListViewController

Optimizes the display of signing steps within nested list views.

Features:

• Compact step visualization
• Real-time status updates
• Inline step details

API Endpoint

The module exposes RESTful API endpoints for external integration:

Endpoints

Authentication

All endpoints require authentication via XAF's built-in security system.

AI Agent Integration

Use Cases

• External System Integration: Connect ERP, CRM, or other systems to the signing workflow
• Automated Approval Processing: Process approvals from external triggers
• Status Synchronization: Keep external systems in sync with signing status

API Integration Example

// External system submitting a form via HTTP
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = 
    new AuthenticationHeaderValue("Bearer", token);

var response = await client.PostAsJsonAsync("/api/esign/submit", new
{
    FormType = "LeaveForm",
    FormId = formGuid
});

Best Practices

• Authentication: Always use secure authentication tokens
• Error Handling: Handle API errors gracefully
• Rate Limiting: Implement appropriate rate limiting for bulk operations

UI Customization

Custom View Styling

The module uses standard DevExpress XAF Blazor styling. To customize:

/* wwwroot/css/custom.css */
.esign-step-pending {
    background-color: #fff3cd;
}

.esign-step-approved {
    background-color: #d4edda;
}

.esign-step-rejected {
    background-color: #f8d7da;
}

Related Packages

• Xeku.ESign - Core signing module
• Xeku.ESign.Forms - Pre-built HR and accounting forms

License

MIT License