Add AICL example: 36_erp_system.aicl

data/aicl/examples/36_erp_system.aicl

@@ -0,0 +1,339 @@
+# AICL Example: Enterprise Resource Planning System
+# Full-spectrum ERP platform spanning finance, procurement, manufacturing, HR, and supply chain with cross-module data orchestration, compliance controls, and adaptive optimization
+
+Goal: Provide a unified enterprise resource planning platform that integrates financial management, procurement, manufacturing operations, human resources, and supply chain logistics into a single coherent system with real-time visibility, automated compliance, and intelligent resource allocation
+
+Constraint: All financial transactions must maintain double-entry bookkeeping integrity with immutable audit trails
+Constraint: System must support multi-currency operations with real-time exchange rate synchronization
+Constraint: Module interfaces must be loosely coupled via event-driven architecture to prevent cascading failures
+Constraint: All personal data processing must comply with GDPR, CCPA, and applicable regional privacy regulations
+Constraint: Manufacturing resource planning must honor capacity constraints and material availability before committing production orders
+
+Risk: Financial posting inconsistency across modules during concurrent transaction processing
+Recovery: Implement distributed transaction coordinator with two-phase commit protocol; on failure, roll back all partial postings and queue for manual reconciliation
+
+Risk: Procurement fraud via vendor collusion or phantom invoicing
+Recovery: Trigger automated vendor verification cross-check; freeze flagged purchase orders; escalate to compliance officer with full audit evidence package
+
+Risk: Manufacturing schedule disruption due to unplanned equipment downtime
+Recovery: Activate preventive maintenance alert system; reroute production to alternate work centers; adjust delivery commitments with real-time ATP recalculation
+
+Risk: Supply chain bullwhip effect causing inventory distortion across distribution network
+Recovery: Enable demand smoothing algorithm; impose order rate limits; propagate actual demand signal upstream with collaborative forecasting override
+
+Risk: HR payroll calculation errors from incorrect tax table or benefit deduction configuration
+Recovery: Revert to last validated payroll configuration snapshot; flag affected payroll runs; generate correction adjustments with full audit trail
+
+Risk: Data migration corruption during module upgrade or system consolidation
+Recovery: Execute automated data integrity checksums against pre-migration baseline; restore corrupted records from versioned backup; log all discrepancies for review
+
+Layer: Finance
+    SubLayer: GeneralLedger
+    SubLayer: AccountsPayable
+    SubLayer: AccountsReceivable
+    SubLayer: FixedAssets
+    SubLayer: CashManagement
+
+Layer: Procurement
+    SubLayer: PurchaseRequisitions
+    SubLayer: VendorManagement
+    SubLayer: ContractManagement
+    SubLayer: GoodsReceipt
+
+Layer: Manufacturing
+    SubLayer: ProductionPlanning
+    SubLayer: BillOfMaterials
+    SubLayer: WorkOrderManagement
+    SubLayer: QualityControl
+
+Layer: HumanResources
+    SubLayer: EmployeeRecords
+    SubLayer: PayrollProcessing
+    SubLayer: BenefitsAdministration
+    SubLayer: TimeAttendance
+
+Layer: SupplyChain
+    SubLayer: DemandPlanning
+    SubLayer: InventoryManagement
+    SubLayer: OrderFulfillment
+    SubLayer: LogisticsCoordination
+
+Validation: All journal entries must balance (debits equal credits) before posting to general ledger
+Validation: Purchase orders must reference an approved requisition and validated vendor record
+Validation: Production orders must pass material availability and capacity feasibility checks
+Validation: Payroll runs must complete tax calculation verification before disbursement
+Validation: Inventory adjustments must include reason codes and supervisory approval for values exceeding threshold
+Validation: Cross-module document references must resolve to existing and non-voided source documents
+
+Entity GeneralLedgerAccount
+    accountId: string
+    accountName: string
+    accountType: string
+    normalBalance: string
+    parentAccount: string
+    currencyCode: string
+    isActive: boolean
+    costCenter: string
+    reportingSegment: string
+    lastPostedDate: datetime
+
+Entity PurchaseOrder
+    poNumber: string
+    vendorId: string
+    requisitionRef: string
+    orderDate: datetime
+    deliveryDate: datetime
+    totalAmount: float
+    currencyCode: string
+    status: string
+    approvalChain: list
+    lineItems: list
+    paymentTerms: string
+    taxAmount: float
+
+Entity ProductionOrder
+    workOrderId: string
+    bomReference: string
+    plannedQuantity: float
+    actualQuantity: float
+    startDate: datetime
+    endDate: datetime
+    workCenter: string
+    status: string
+    materialAllocations: dict
+    qualityInspections: list
+    costVariance: float
+
+Entity Employee
+    employeeId: string
+    firstName: string
+    lastName: string
+    department: string
+    jobTitle: string
+    hireDate: datetime
+    employmentType: string
+    salary: float
+    currencyCode: string
+    taxProfile: dict
+    benefitsEnrollment: list
+    managerId: string
+
+Entity InventoryItem
+    sku: string
+    productName: string
+    category: string
+    warehouseLocation: string
+    quantityOnHand: float
+    quantityReserved: float
+    quantityAvailable: float
+    reorderPoint: float
+    safetyStock: float
+    unitCost: float
+    leadTimeDays: integer
+    abcClassification: string
+
+Entity Vendor
+    vendorId: string
+    vendorName: string
+    taxId: string
+    paymentTerms: string
+    currencyCode: string
+    creditLimit: float
+    performanceRating: float
+    complianceStatus: boolean
+    bankingDetails: dict
+    contactList: list
+    certificationExpiry: datetime
+
+Entity JournalEntry
+    entryId: string
+    journalType: string
+    postingDate: datetime
+    period: string
+    sourceModule: string
+    sourceDocument: string
+    description: string
+    debitTotal: float
+    creditTotal: float
+    lineItems: list
+    reversalRef: string
+    isReversed: boolean
+
+Behavior PostJournalEntry
+    Input: entry: JournalEntry, approverId: string
+    Output: postingConfirmation: dict
+    Action: Validate debit-credit balance; verify period is open; check account existence; apply approval workflow; post to general ledger; update account balances; emit posting event for downstream modules; generate audit log entry
+
+Behavior CreatePurchaseOrder
+    Input: requisitionRef: string, vendorId: string, lineItems: list, deliveryDate: datetime
+    Output: purchaseOrder: PurchaseOrder
+    Action: Validate requisition approval status; verify vendor compliance and active status; calculate taxes and totals; apply approval chain based on amount thresholds; reserve budget allocation; persist purchase order; emit procurement event; notify vendor via integration
+
+Behavior ScheduleProduction
+    Input: bomReference: string, quantity: float, requestedDate: datetime, priority: string
+    Output: productionOrder: ProductionOrder
+    Action: Parse bill of materials; check material availability against inventory and existing allocations; verify work center capacity; calculate production duration; generate work order; allocate materials; create quality inspection checkpoints; emit manufacturing event; update ATP quantities
+
+Behavior ProcessPayroll
+    Input: payPeriod: string, department: string, processingMode: string
+    Output: payrollRunResult: dict
+    Action: Load employee roster for period; calculate gross compensation; apply tax withholdings per jurisdiction; deduct benefits contributions; calculate employer contributions; validate net pay against tolerance thresholds; generate payment file; create journal entries for payroll expense; emit payroll completion event; archive payroll register
+
+Behavior ReconcileInventory
+    Input: warehouseCode: string, skuList: list, adjustmentReason: string
+    Output: reconciliationResult: dict
+    Action: Retrieve system quantities; compare against physical count data; identify variances; flag variances exceeding threshold for approval; apply approved adjustments; update quantity on hand; recalculate available and reserved quantities; generate adjustment journal entry; emit inventory event; update demand planning signals
+
+Behavior EvaluateVendorPerformance
+    Input: vendorId: string, evaluationPeriod: string
+    Output: performanceReport: dict
+    Action: Aggregate on-time delivery metrics; calculate quality defect rates; compile pricing competitiveness scores; assess responsiveness ratings; compute composite performance score; update vendor performance rating; trigger vendor review if below threshold; emit vendor evaluation event; update procurement analytics
+
+Condition:
+    When purchaseOrder.totalAmount exceeds departmentBudget.remainingAllocation
+    Then escalate to CFO for budget override approval; hold purchase order in pending state; notify department head of budget constraint
+
+Condition:
+    When productionOrder.actualQuantity deviates from plannedQuantity by more than 10 percent
+    Then trigger variance analysis workflow; notify production manager; generate cost variance report; adjust standard cost if pattern persists over 3 consecutive runs
+
+Condition:
+    When inventoryItem.quantityAvailable falls below reorderPoint AND inventoryItem.leadTimeDays exceeds 14
+    Then auto-generate emergency purchase requisition with expedited shipping; flag for supply chain review; adjust safety stock calculation parameters
+
+Condition:
+    When employee.benefitsEnrollment has conflicting coverage selections
+    Then reject enrollment submission; notify HR coordinator and employee; provide conflict resolution guidance; hold enrollment in pending status until resolved
+
+Condition:
+    When journalEntry.debitTotal does not equal journalEntry.creditTotal
+    Then reject posting attempt; generate imbalance notification; log discrepancy in error queue; prevent any partial ledger updates
+
+Event:
+    On JournalEntryPosted
+    Action: Update real-time financial dashboards; refresh account balance caches; trigger reconciliation checks; propagate to reporting subsystem; update cash flow projections
+
+Event:
+    On PurchaseOrderApproved
+    Action: Transmit order to vendor via EDI or portal; reserve inventory for expected goods receipt; update procurement pipeline analytics; schedule goods receipt inspection; notify accounts payable for future invoice matching
+
+Event:
+    On ProductionOrderCompleted
+    Action: Post production receipts to inventory; close work order; calculate actual vs standard cost variance; update capacity utilization metrics; generate quality certificate if inspection passed; trigger shipment scheduling for sales orders
+
+Event:
+    On PayrollRunCompleted
+    Action: Submit payment file to banking integration; post payroll journal entries; update employee year-to-date totals; generate payslip documents; sync with benefits providers; archive payroll register in compliance vault
+
+Event:
+    On InventoryThresholdBreached
+    Action: Trigger replenishment workflow; notify procurement and warehouse managers; update demand forecast with actual consumption data; recalculate safety stock parameters; log threshold event for analytics
+
+Parallel:
+    - Financial period close processing across all ledgers
+    - Procurement vendor payment batch generation
+    - Manufacturing capacity planning simulation
+    - HR payroll tax calculation engine
+    - Supply chain demand signal aggregation
+
+Optimize: Cross-module resource allocation and transaction throughput
+    Priority: Financial integrity and compliance over performance throughput
+    Priority: Real-time visibility over batch processing efficiency
+    Priority: Manufacturing schedule adherence over cost minimization
+    Priority: Employee data privacy over analytics granularity
+
+Learn: Demand forecasting accuracy
+    Goal: Reduce forecast mean absolute percentage error below 12 percent
+    Adapt: Safety stock levels
+    Based: Historical demand variance, seasonal patterns, and forecast error trends
+
+Learn: Vendor payment term optimization
+    Goal: Maximize working capital while maintaining vendor satisfaction scores above 85
+    Adapt: Payment scheduling
+    Based: Discount opportunity analysis, vendor relationship tier, and cash position forecasts
+
+Learn: Production schedule efficiency
+    Goal: Reduce manufacturing lead time variance by 20 percent
+    Adapt: Work center scheduling algorithms
+    Based: Historical throughput data, maintenance patterns, and changeover time analytics
+
+Learn: Tax calculation accuracy
+    Goal: Achieve zero tax calculation errors per payroll cycle
+    Adapt: Tax table update verification procedures
+    Based: Error rate trends, jurisdiction change frequency, and validation effectiveness
+
+Security:
+    Encrypt: All financial transaction amounts and account balances at rest and in transit
+    Encrypt: Employee personal data including salary, tax identification, and banking details
+    Encrypt: Vendor banking details and payment instructions
+    Protect: Journal entry posting endpoints with multi-factor approval authentication
+    Protect: Payroll processing initiation with role-based access and segregation of duties
+    Protect: Vendor master data modification with dual-authorization workflow
+    Protect: Production order cost data from unauthorized cross-department visibility
+
+Native: python
+{
+import datetime
+from decimal import Decimal
+from typing import Dict, List, Optional
+
+class ERPTransactionCoordinator:
+    """Distributed transaction coordinator for cross-module ERP operations."""
+
+    def __init__(self, module_registry: Dict):
+        self.registry = module_registry
+        self.transaction_log = []
+        self.lock_manager = DistributedLockManager()
+
+    def begin_transaction(self, modules: List[str], operation: str) -> str:
+        tx_id = f"TX-{datetime.datetime.utcnow().strftime('%Y%m%d%H%M%S%f')}"
+        participants = [self.registry[m] for m in modules]
+        prepared = []
+
+        # Phase 1: Prepare
+        for module in participants:
+            try:
+                self.lock_manager.acquire(tx_id, module.resource_key)
+                ack = module.prepare(tx_id, operation)
+                if ack.status == "READY":
+                    prepared.append(module)
+                else:
+                    self._rollback(tx_id, prepared)
+                    raise TransactionError(f"Module {module.name} not ready")
+            except Exception as e:
+                self._rollback(tx_id, prepared)
+                raise TransactionError(f"Prepare failed: {e}")
+
+        # Phase 2: Commit
+        for module in prepared:
+            module.commit(tx_id)
+
+        self.transaction_log.append({
+            "tx_id": tx_id,
+            "operation": operation,
+            "modules": modules,
+            "status": "COMMITTED",
+            "timestamp": datetime.datetime.utcnow().isoformat()
+        })
+        return tx_id
+
+    def _rollback(self, tx_id: str, prepared: List):
+        for module in prepared:
+            try:
+                module.rollback(tx_id)
+            except Exception:
+                self.transaction_log.append({
+                    "tx_id": tx_id, "module": module.name,
+                    "status": "ROLLBACK_FAILED"
+                })
+        self.lock_manager.release_all(tx_id)
+
+
+class DoubleEntryValidator:
+    """Validates journal entries for double-entry bookkeeping integrity."""
+
+    def validate(self, line_items: List[Dict]) -> bool:
+        total_debits = sum(Decimal(str(i["debit"])) for i in line_items if i.get("debit"))
+        total_credits = sum(Decimal(str(i["credit"])) for i in line_items if i.get("credit"))
+        return total_debits == total_credits and total_debits > 0
+}