📄 ODSManager Class Documentation
Welcome to the comprehensive documentation for ODSManager, part of the IrbyImaging.BusinessLogic.Jobs namespace. This guide will walk you through the purpose, dependencies, methods, usage examples, and even a UML class diagram. Strap in! 🚀
📑 Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- Class Structure
- Key Functional Areas & Methods
- Data Models & Domain Classes
- Helper Methods & Utilities
- Error Handling & Return Types
- Usage Examples
- UML Class Diagram
- Conclusion
1. Overview & Purpose
ODSManager is a service responsible for synchronizing data from an external Oracle Data Service (ODS, implemented in SQL Server tables like EX_JDE_EMPLOYEE, EX_JDE_ASSET, etc.) into your local application's Entity Framework models (IrbyContext).
- 🔄 Synchronize employees, assets, purchase orders, work orders, jobs, and customers
- 💾 Insert new records or update existing ones
- 📜 Execute supplemental T-SQL scripts for bulk updates
Use ODSManager to keep your application's data in sync with your ERP system (JDE).
2. Dependencies & Technologies
| Layer / Package | Purpose |
|---|---|
| Microsoft.EntityFrameworkCore | ORM for database access (IrbyContext) |
| Microsoft.SqlServer.Management.Smo | Execute T-SQL scripts via SMO |
| Microsoft.Extensions.Configuration | Configuration support |
| Microsoft.Extensions.DependencyInjection | DI container integration |
| IrbyImaging.DomainClasses | Domain entities & EF DbSet<> definitions |
| IrbyImaging.Utility | Utility methods & enums (e.g., EmployeeStatus) |
| SkiaSharp | (Referenced, not used directly here) |
| System.Data.SqlClient | ADO.NET for raw SQL connections |
Note: Ensure your
appsettings.jsoncontains the correct connection strings for your ERP and local databases.
3. Class Structure
namespace IrbyImaging.BusinessLogic.Jobs
{
public class ODSManager
{
private IrbyContext context;
public ODSManager(IrbyContext irbyContext);
public void UpdateEmployee(string sqlConnectionString);
public void UpdateAsset(string sqlConnectionString);
public void UpdatePurchaseOrder(string sqlConnectionString);
public void UpdateWorkOrder(string sqlConnectionString);
public void UpdateJob(string sqlConnectionString);
public void UpdateCustomer(string sqlConnectionString);
}
}
-
Constructor
ODSManager(IrbyContext irbyContext): Accepts an EF Core context via dependency injection.
-
Methods
- UpdateEmployee: Syncs employee records.
- UpdateAsset: Syncs equipment assets.
- UpdatePurchaseOrder: Syncs purchase orders.
- UpdateWorkOrder: Syncs work orders.
- UpdateJob: Syncs job/project definitions.
- UpdateCustomer: Syncs customers.
4. Key Functional Areas & Methods
Below is a quick summary; subsequent sections dive deeper.
| Method | Purpose | Bulk Script? |
|---|---|---|
| UpdateEmployee | Insert/update employee data | No |
| UpdateAsset | Insert/update equipment assets | Yes (ODS_E_EquipmentUpdate.sql) |
| UpdatePurchaseOrder | Insert/update purchase orders | Yes (ODS_F_PurchaseOrderUpdate.sql) |
| UpdateWorkOrder | Insert/update work orders | Yes (ODS_G_WorkOrderUpdate.sql) |
| UpdateJob | Insert/update job/project data | No |
| UpdateCustomer | Insert/update customer master data | No |
UpdateEmployee
Signature:
public void UpdateEmployee(string sqlConnectionString)
Workflow:
- Build EF Core
DbContextOptionsusing external connection string. - Query ODS employees with
FromSql(...). - Map each ODS record to local
Employeeentity.- Determine
EmployeeStatusviaPAY_STATUS_CODE. - Insert new employee or update existing.
- Determine
- Maintain a
PayrollMatchtable mapping JDE to local employees.
Core Snippet:
var odsRecords = context.ODSEmployees
.FromSql($"SELECT e.*, m.NAME AS MANAGER_NAME, i.EmployeeId AS MANAGER_ID ...")
.ToList();
foreach(var rec in odsRecords) {
var payStatus = MapPayCode(rec.PAY_STATUS_CODE);
var employee = context.Employees.FirstOrDefault(e => e.JdeNumber == rec.EMPLOYEE_NUMBER.ToString());
if (employee == null) {
// Create
} else {
// Update
}
EnsurePayrollMatch(rec.EMPLOYEE_NUMBER.ToString());
}
UpdateAsset
Signature:
public void UpdateAsset(string sqlConnectionString)
Highlights:
- Retrieves top 10 assets from
EX_JDE_ASSETjoined to localEquipment. - Writes & executes the T-SQL script
wwwroot/Scripts/ODS_E_EquipmentUpdate.sqlvia SMO.
var odsRecords = context.Equipment.FromSql("select top 10 ...").ToList();
if (odsRecords.Any()) {
var script = File.ReadAllText("wwwroot/Scripts/ODS_E_EquipmentUpdate.sql");
var server = new Server(new ServerConnection(sqlConnectionString));
server.ConnectionContext.ExecuteNonQuery(script);
}
UpdatePurchaseOrder
Signature:
public void UpdatePurchaseOrder(string sqlConnectionString)
- Fetches top 10 purchase orders from
EX_JDE_PURCHASE_ORDER. - Executes
ODS_F_PurchaseOrderUpdate.sqlfor bulk updates.
UpdateWorkOrder
Signature:
public void UpdateWorkOrder(string sqlConnectionString)
- Queries
EX_JDE_WORK_ORDERjoined toirby.WorkOrder. - Executes
ODS_G_WorkOrderUpdate.sqlfor bulk persistence.
UpdateJob
Signature:
public void UpdateJob(string sqlConnectionString)
Key Steps:
- Pulls all jobs from
EX_JDE_JOB+ related employee/customer lookups. - Map JDE status codes to
JobStatusenum. - Insert new job or update fields on existing.
var odsRecords = context.ODSJobs.FromSql("SELECT j.*, ...").ToList();
foreach(var rec in odsRecords) {
var status = rec.JOB_STATUS_CODE == "CLO" ? JobStatus.Closed : JobStatus.Active;
var job = context.Jobs.FirstOrDefault(j => j.JdeNumber == rec.ORG_BU);
if (job == null) {
// Add new Job()
} else {
// Update fields
}
context.SaveChanges();
}
UpdateCustomer
Signature:
public void UpdateCustomer(string sqlConnectionString)
- Reads
EX_JDE_CUSTOMER. - Inserts or updates local
Customerrecords.
5. Data Models & Domain Classes
ODSManager utilizes several EF Core DbSet<> definitions in IrbyContext:
- ODSEmployees →
EX_JDE_EMPLOYEEview - Employees → Local business
Employeeentity - Equipment → Local
Equipmententity - PurchaseOrder, WorkOrder, Jobs, Customers, PayrollMatch, etc.
Check
IrbyImaging.DomainClassesfor full entity definitions.
6. Helper Methods & Utilities
- MapPayCode: Converts JDE pay status codes (
"0","T","U",…) toEmployeeStatusenum. - SMO Execution: Centralized logic to load & run
.sqlscripts viaServerConnection.
Consider extracting these into private helpers for reuse & unit testing.
7. Error Handling & Return Types
- All methods return
void. - Exceptions bubble up (no try/catch).
- Recommendation:
- Wrap DB calls in
try/catch - Log exceptions via your favorite logging framework (Serilog, NLog, etc.)
- Add retry logic for transient SQL errors.
- Wrap DB calls in
8. Usage Examples
8.1. Registering in DI (Startup.cs)
public void ConfigureServices(IServiceCollection services)
{
services.AddDbContext<IrbyContext>(options =>
options.UseSqlServer(Configuration.GetConnectionString("LocalDb")));
services.AddScoped<ODSManager>();
// ...
}
8.2. Invoking from a Background Service
public class OdsSyncService : IHostedService
{
private readonly ODSManager _odsManager;
private readonly IConfiguration _config;
public OdsSyncService(ODSManager odsManager, IConfiguration config)
{
_odsManager = odsManager;
_config = config;
}
public Task StartAsync(CancellationToken token)
{
string odsConn = _config.GetConnectionString("OdsSqlServer");
_odsManager.UpdateEmployee(odsConn);
_odsManager.UpdateAsset(odsConn);
_odsManager.UpdatePurchaseOrder(odsConn);
_odsManager.UpdateWorkOrder(odsConn);
_odsManager.UpdateJob(odsConn);
_odsManager.UpdateCustomer(odsConn);
return Task.CompletedTask;
}
public Task StopAsync(CancellationToken token) => Task.CompletedTask;
}
9. UML Class Diagram
classDiagram
class ODSManager {
- IrbyContext context
+ ODSManager(IrbyContext)
+ UpdateEmployee(string)
+ UpdateAsset(string)
+ UpdatePurchaseOrder(string)
+ UpdateWorkOrder(string)
+ UpdateJob(string)
+ UpdateCustomer(string)
}
class IrbyContext
ODSManager --> IrbyContext : uses
10. Conclusion
🎯 ODSManager is your one-stop service for importing and synchronizing JDE-based ODS data into your application. By leveraging EF Core for fine-grained CRUD and SMO for bulk script execution, it delivers both flexibility and performance.
Next Steps:
- Implement unit tests for each method.
- Externalize constant status code mappings.
- Add robust logging and error retry policies.
Happy syncing! 🔄✨
Document generated on: 2024-06-XX
Author: IrbyImaging Business Logic Team