Centeva.InterfaceRecord 1.0.0

Centeva.InterfaceRecord

Centeva.InterfaceRecord provides a standardized way to track and manage Hangfire execution records within .NET applications. It is designed to help consuming applications record Hangfire job runs, their success/failure, and related metadata for auditing and operational purposes.

Features

• Track Hangfire job execution status, errors, and notes.
• Log start/end times and success state for each job run.
• Query last successful run and all job execution records.
• Entity Framework Core configuration for persistence.
• Extensible via repository interface.

Getting Started

1. Installation

Add a reference to the Centeva.InterfaceRecord project or NuGet package in your application.

2. Dependencies

Ensure your project targets .NET 8.0 or higher and includes the following packages:

• Centeva.DomainModeling
• Centeva.DomainModeling.EFCore
• Microsoft.Data.SqlClient
• Microsoft.Extensions.Caching.Memory

3. Database Setup

The solution uses Entity Framework Core for persistence. The main tables are:

• InterfaceRecord
• InterfaceLog

Your application's DbContext must include the following sets to enable tracking and querying:

public DbSet<InterfaceRecord> InterfaceRecords { get; set; }
public DbSet<InterfaceLog> InterfaceLogs { get; set; }

Configure your DbContext to include the provided InterfaceLogConfiguration for table mapping:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.ApplyConfiguration(new InterfaceLogConfiguration());
    // ... other configurations
}

4. Usage

Real-World Example: Logging an Hangfire Job Run

Below is a simple example from Dashboard.Data.DataAccess.InspectionsSyncRepository.cs showing how to use InterfaceLog and the repository to record a Hangfire job run:

public async Task SendAdamsLERsToInspectionsAsync(string code) {
    var r = new InterfaceLog(code);
    try
    {
        // ... business logic to send LERs ...
        r.Success = true;
    }
    catch(Exception ex)
    {
        r.ErrorMessage += ex.ToString();
    }
    finally
    {
        r.Complete();
        await _interfaceRecordRepo.UpdateInterfaceRecordAsync(r);
    }
}

Key points:

• Create an InterfaceLog at the start of your process.
• Update its properties (Success, Notes, ErrorMessage) as your logic executes.
• Call .Complete() before saving.
• Persist the log using your repository's UpdateInterfaceRecordAsync method.

Querying Records

var lastSuccess = await _repository.GetLastSuccessDateAsync("MY_INTERFACE");
var records = await _repository.GetInterfaceRecordsAsync();

5. Customization

• Use the InterfaceRecordTypeAttribute to annotate methods with interface record type names.
• Extend or implement IInterfaceRecordRepository for custom data access logic.

Exception Handling

InterfaceRecordException is thrown for failures during record updates.

Contributing

• Ensure code follows .NET 8+ standards.
• Add tests for new features.
• Submit pull requests via your repository workflow.

License

See repository for license details.