Xeku.ESign.Forms 0.0.0.7

Xeku.ESign.Forms

Pre-built XAF forms for common HR and accounting workflows, built on the Xeku.ESign framework.

繁體中文文檔

Features

• Human Resource Forms:
  • Leave Application (請假單) - supports multiple vacation types
  • Travel Request (出差申請)
  • Overtime Application (加班申請)
  • Missed Clock-Out Report (忘刷卡申請)
• Accounting Forms:
  • Cash Request (現金請款)
  • General Approval (一般簽呈)
• Localization Ready: Traditional Chinese (zh-Hant-TW) translations included
• Automatic Subject Generation: Smart subject formatting based on form data

Architecture

graph TB
    subgraph "Service/Logic (#fff4e1)"
        Core["Xeku.ESign (Core)"]
    end
    
    subgraph "Data/Entity (#e8f5e9)"
        FormBase["FormBase"]
    end
    
    subgraph "Forms Module (#f3e5f5)"
        HR["Human Resource"]
        Accounting["Accounting"]
        General["General"]
    end
    
    subgraph "HR Forms"
        Leave["LeaveForm"]
        Travel["TravelForm"]
        Overtime["WorkOvertimeForm"]
        MissedClock["MissedClockOutForm"]
    end
    
    subgraph "Accounting Forms"
        Cash["CashRequestForm"]
        Approval["Approval"]
    end
    
    HR --> Leave
    HR --> Travel
    HR --> Overtime
    HR --> MissedClock
    Accounting --> Cash
    General --> Approval
    
    Leave --> FormBase
    Travel --> FormBase
    Overtime --> FormBase
    MissedClock --> FormBase
    Cash --> FormBase
    Approval --> FormBase
    
    FormBase --> Core
    
    style Core fill:#fff4e1
    style FormBase fill:#e8f5e9
    style HR fill:#f3e5f5
    style Accounting fill:#f3e5f5
    style General fill:#f3e5f5
    style Leave fill:#e8f5e9
    style Travel fill:#e8f5e9
    style Overtime fill:#e8f5e9
    style MissedClock fill:#e8f5e9
    style Cash fill:#e8f5e9
    style Approval fill:#e8f5e9

Installation

1. NuGet Package

dotnet add package Xeku.ESign.Forms

2. Add Module Reference

// In your module constructor
RequiredModuleTypes.Add(typeof(Xeku.ESign.Forms.ESignFormsModule));

Included Forms

LeaveForm (請假單)

Manages employee leave requests with automatic hour calculation.

Vacation Types Supported:

• Personal Leave (事假)
• Sick Leave (病假)
• Annual Leave (特休年假)
• Official Leave (公假)
• Marriage Leave (婚假)
• Maternity/Paternity Leave (產假/陪產假)
• Parental Leave (育嬰假)
• Funeral Leave (喪假)
• Menstrual Leave (生理假)
• Compensatory Leave (補休)

CashRequestForm (現金請款)

Handles cash advance and expense requests.

TravelForm (出差申請)

Manages business travel and field work requests.

Customizing Signing Steps

All forms implement IFixedSignStepObject. Override OnStepCreating to customize:

public class CustomLeaveForm : LeaveForm
{
    public CustomLeaveForm(Session session) : base(session) { }
    
    public override void OnStepCreating(ref CancelMessageEventArgs e)
    {
        // Custom approval chain
        SignStepManager.AddSingleSignStep(this, 1, "Direct Manager", 
            GetDirectManager());
        SignStepManager.AddSingleSignStep(this, 2, "HR Approval", 
            GetHRManager());
    }
}

AI Agent Integration

Use Cases

• Automated Form Generation: AI can create leave/travel requests based on natural language
• Workflow Automation: Trigger form submissions based on calendar events
• Status Reporting: Query and report on pending approvals

API Integration

// Create and submit a leave request programmatically
var leave = objectSpace.CreateObject<LeaveForm>();
leave.VacationType = VacationType.AnnualLeave;
leave.StartDate = DateTime.Today.AddDays(7);
leave.EndDate = DateTime.Today.AddDays(8);
leave.StartTime = TimeSpan.Parse("08:30");
leave.EndTime = TimeSpan.Parse("17:30");

objectSpace.CommitChanges();

// Submit for approval
var result = SignStatusManager.Approve(leave);

Best Practices

• Validation: Ensure all required fields are set before submission
• Date Handling: Consider working hours when calculating leave duration
• Localization: Use CaptionHelper.GetLocalizedText() for user-facing messages

Related Packages

• Xeku.ESign - Core signing module
• Xeku.ESign.Blazor - Blazor UI components

License

MIT License