@prorigo/protrak-forge 0.3.5 → 0.4.0

package/data/patterns/scheduler.md

@@ -1,77 +0,0 @@
-# Scheduler Program Pattern
-
-## When to Use
-Use this pattern for background jobs that run on a schedule (cron). Common uses:
-- Send daily reminder notifications
-- Auto-close overdue instances
-- Compute/recalculate aggregate values from related instances (see [Aggregate Related Instances](./aggregate-related-instances.md) for the canonical roll-up shape)
-- Sync data with external systems
-
-## Program Types
-Applies to: `Scheduler`
-
-## Services Used
-- `IInstanceService` — to query and update instances
-- `INotificationService` — to send scheduled notifications
-- `IQueryBuilderService` — to filter instances
-
-## Code Example
-
-```csharp
-using Prorigo.Protrak.API.Contracts;
-using System;
-using System.Linq;
-using System.Threading.Tasks;
-
-namespace MyProject.Customization
-{
-    public class SendDailyOverdueReminders : ISchedulerProgramAsync
-    {
-        public IInstanceService InstanceService { get; set; }
-        public INotificationService NotificationService { get; set; }
-        public IQueryBuilderService QueryBuilderService { get; set; }
-
-        public async Task RunAsync()
-        {
-            var today = DateTime.UtcNow.Date;
-            var filter = QueryBuilderService.CreateAttributeFilterExpression(
-                "DueDate", today.ToString("yyyy-MM-dd"), FilterOperator.LessThanOrEqual);
-
-            var query = new InstanceQuery
-            {
-                TypeName = "WorkOrder",
-                Filter = filter,
-                StateName = "Open",
-                Take = 500
-            };
-
-            var overdueItems = await InstanceService.GetInstancesAsync(query);
-            if (overdueItems?.Data == null || overdueItems.Data.Length == 0)
-                return;
-
-            foreach (var item in overdueItems.Data)
-            {
-                var assignee = item.Attributes?
-                    .FirstOrDefault(a => a.Name == "AssignedEngineer")?.Value?.ToString();
-
-                if (string.IsNullOrEmpty(assignee)) continue;
-
-                await NotificationService.SendNotificationAsync(
-                    new[] { assignee },
-                    "Overdue Work Order",
-                    $"Work Order {item.TrackingId} is overdue. Please take action.",
-                    item.Id
-                );
-            }
-        }
-    }
-}
-```
-
-## Key Rules
-- The `Run()` / `RunAsync()` method takes no parameters
-- Use `ISchedulerProgramAsync` for async operations
-- Avoid long-running loops — use `Take` to limit batch sizes
-- Log or notify on errors so failures are visible
-- Consider idempotency: what happens if the scheduler runs twice?
-- When the scheduler walks parent → related instances and reads attributes off each child, use `RelatedQueryBuilder.Select(...)` in a single `GetRelatedInstancesAsync` call. **Do not** fan out to `GetInstanceAsync` per related id — that's an N+1 anti-pattern. See [Aggregate Related Instances](./aggregate-related-instances.md).