📑 LegalDashboardUpdate.cs Documentation


📖 Table of Contents

  1. 🔍 Overview & Purpose
  2. 🏗️ Class Structure & Dependencies
    2.1. UML Class Diagram
    2.2. Constructor & DI
  3. ⏰ Quartz.NET Integration
    3.1. Execute Method
    3.2. Registration & Trigger Example
  4. 🔄 PopulateDashboardCharts() Workflow
    4.1. Configuration Retrieval
    4.2. DbContext & Manager Initialization
    4.3. Manager Update Methods
  5. 📦 Dependencies & Technologies
  6. 👀 View Models & Data Models
  7. ⚙️ Error Handling & Return Types
  8. 🛠️ Usage & Integration
  9. 🤝 Third‑Party Integrations
  10. 🏁 Conclusion

🔍 Overview & Purpose

LegalDashboardUpdate is a Quartz.NET job that periodically refreshes legal‑dashboard analytics by running a series of complex SQL pivots and summary queries. It delegates the heavy lifting to a LegalDashboardManager, storing fresh aggregates for:

  • Contracts by type
  • Properties by director/state
  • Detailed lease and contract breakdowns

This job ensures that UI dashboards and reports remain up‑to‑date without manual intervention.


🏗️ Class Structure & Dependencies

📐 UML Class Diagram

+----------------------------------------------------------+
| <<job>> LegalDashboardUpdate : Quartz.IJob               |
+----------------------------------------------------------+
| - _provider:               IServiceProvider              |
| - _factory:                IServiceScopeFactory          |
| - _configuration:          IConfiguration                |
| - _httpContextAccessor:    IHttpContextAccessor          |
+----------------------------------------------------------+
| + Execute(context: IJobExecutionContext): Task           |
| + PopulateDashboardCharts(): void                        |
+----------------------------------------------------------+
                             |
                             v
              +-------------------------------------+
              | LegalDashboardManager               |
              +-------------------------------------+
              | + UpdateContractTypeNumber(connStr) |
              | + UpdateDirectorLeaseResults(connStr)|
              | + ...                               |
              +-------------------------------------+

🛠 Constructor & Dependency Injection

The job leverages constructor injection for configuration, DI factory, and HTTP context access:

public LegalDashboardUpdate(
    IServiceProvider provider,
    IConfiguration configuration,
    IHttpContextAccessor httpContextAccessor,
    IServiceScopeFactory factory)
{
    _provider              = provider;
    _configuration         = configuration;
    _httpContextAccessor   = httpContextAccessor;
    _factory               = factory;
}
Parameter Type Purpose
provider IServiceProvider Resolve scoped/transient services
configuration IConfiguration Access appsettings.json (e.g. connection strings)
httpContextAccessor IHttpContextAccessor Multi‑tenant or per‑user context (if needed)
factory IServiceScopeFactory Create service scopes for background operations

⏰ Quartz.NET Integration

🏃 Execute Method

Implements Quartz.IJob. Quartz will invoke Execute(...) according to the configured trigger.

public Task Execute(IJobExecutionContext context)
{
    PopulateDashboardCharts();
    return Task.CompletedTask;
}
  • Synchronous Core: Invokes PopulateDashboardCharts() and immediately returns a completed task.
  • Exception Handling: Any exception bubbles up to Quartz and can be logged by your scheduler configuration.

⚙️ Registration & Trigger Example

Register the job and its trigger within your Startup.cs or Program.cs:

services.AddQuartz(q =>
{
    // Use Microsoft DI for job creation
    q.UseMicrosoftDependencyInjectionJobFactory();

    // Define job
    var jobKey = new JobKey(nameof(LegalDashboardUpdate));
    q.AddJob<LegalDashboardUpdate>(opts => opts.WithIdentity(jobKey));

    // Define trigger: daily at 2 AM
    q.AddTrigger(opts => opts
      .ForJob(jobKey)
      .WithIdentity("LegalDashboardUpdate-trigger")
      .WithCronSchedule("0 0 2 * * ?"));
});

// Hosted service that starts Quartz
services.AddQuartzHostedService(q => q.WaitForJobsToComplete = true);
Cron Expression Schedule
0 0 * * * ? Every hour
0 0 2 * * ? Daily at 2 AM
0 0 0 ? * MON Weekly at Monday midnight

🔄 PopulateDashboardCharts() Workflow

This method orchestrates connection setup, context creation, and a chain of manager calls:

public void PopulateDashboardCharts()
{
    // 1️⃣ Get connection string
    var sqlConnectionString = _configuration["ConnectionStringsDev"];

    // 2️⃣ Create EF Core DbContext
    var context = new IrbyContext(_configuration, _httpContextAccessor);

    // 3️⃣ Instantiate business‑logic manager
    var manager = new LegalDashboardManager(context);

    // 4️⃣ Execute each data aggregation step
    manager.UpdateContractTypeNumber(sqlConnectionString);
    manager.UpdateDirectorLeaseResults(sqlConnectionString);
    manager.UpdatePropertyResults(sqlConnectionString);
    manager.UpdateNumberOfProperties(sqlConnectionString);
    manager.UpdateLeaseDetails(sqlConnectionString);
    manager.UpdateDirectorDetails(sqlConnectionString);
    manager.UpdateContractTypeDetails(sqlConnectionString);
    manager.UpdateContractsByLead(sqlConnectionString);
}

1. Configuration Retrieval

var sqlConnectionString = _configuration["ConnectionStringsDev"];
  • Source: appsettings.json
  • Key: "ConnectionStringsDev"

2. DbContext & Manager Initialization

var context = new IrbyContext(...);
var manager = new LegalDashboardManager(context);
  • IrbyContext: EF Core context for database access
  • LegalDashboardManager: Contains SQL scripts and EF mappings for dashboard updates

3. Manager Update Methods

Method Description
UpdateContractTypeNumber() Counts documents by contract type
UpdateDirectorLeaseResults() Summarizes lease metrics per director
UpdatePropertyResults() Aggregates financials at property level
UpdateNumberOfProperties() Tallies properties by criteria (type/state/etc.)
UpdateLeaseDetails() Extracts detailed lease records
UpdateDirectorDetails() Builds director‑level rollups
UpdateContractTypeDetails() Detailed breakdown by contract category
UpdateContractsByLead() Contracts sorted/grouped by business lead

Tip: Each method typically uses EF Core’s .FromSqlRaw() or .FromSqlInterpolated() to execute complex pivot queries with temporary tables.


📦 Dependencies & Technologies

Package/Library Usage
Quartz.NET Job scheduling
Microsoft.Extensions.Configuration Config access (appsettings.json)
Microsoft.AspNetCore.Http HTTP context access
Microsoft.EntityFrameworkCore ORM & raw SQL integration
Microsoft.Data.SqlClient & SMO Low‑level SQL Server management (imported)
CsvHelper (Imported—unused in this class)
SkiaSharp (Imported—unused in this class)

👀 View Models & Data Models

This job itself does not define View Models or API Data Models. However, the underlying LegalDashboardManager maps query results to DTOs such as:

DTO Class Purpose
DirectorLeaseInfo Lease summary by director
StatePropertyCosts Property costs aggregated by state
LeasePropertyDetails Detailed per‑property lease data
LeaseDetails Comprehensive lease attributes
DirectorProperties Director property counts & metrics
ContractTypeDetails In‑depth contract type statistics
ContractTypeNumber Simple counts by contract type
ContractsByLead Contracts grouped under business leads

(Actual classes live in the Business Logic or Data Access layers.)


⚙️ Error Handling & Return Types

  • Execute(...)

    • Returns Task.CompletedTask.
    • Exceptions bubble up to the Quartz host—configure Quartz logging to capture failures.
  • PopulateDashboardCharts()

    • No return value (void).
    • Recommendation: Wrap each manager.Update… call in its own try/catch to isolate and log individual failures.

🛠️ Usage & Integration

  1. Configure your appsettings.json:

    {
      "ConnectionStringsDev": "Server=...;Database=Irby;User Id=...;Password=..."
    }
    
  2. Register Quartz in Startup.cs (see section 3.2).

  3. Run your application—Quartz will invoke LegalDashboardUpdate on schedule.


🤝 Third‑Party Integrations

  • Quartz.NET: Robust, clustered job scheduling
  • EF Core: Leverage LINQ plus raw SQL
  • SMO (SQL Management Objects): (imported) advanced server scripting
  • CsvHelper, SkiaSharp: Available for future CSV exports or image generation

🏁 Conclusion

🎯 LegalDashboardUpdate is the heartbeat of your legal dashboard reporting pipeline. By coordinating configuration, EF Core contexts, and a suite of raw‐SQL pivot operations, it automates:

  • 🔢 Counts & summaries by contract type
  • 👤 Lease performance by director
  • 🏘️ Financial breakdowns by property/state

Integrate it into your Quartz schedule, and let the job keep your legal analytics fresh, accurate, and ready for your next board meeting or executive dashboard.


End of Documentation 🚀