Governance, Audit & Compliance

// Query recent pipeline executions with stage-level detail:
List<PipelineExecution__c> execs = [
    SELECT Id, Pipeline_Id__c, Status__c, Input__c, Output__c,
           Total_Input_Tokens__c, Total_Output_Tokens__c, Total_Cost__c,
           CreatedById, CreatedDate, Duration_Ms__c
    FROM PipelineExecution__c
    WHERE Status__c IN ('Completed', 'Failed')
    AND CreatedDate = LAST_N_DAYS:7
    ORDER BY CreatedDate DESC
    LIMIT 100
];

// Drill into stage-level logs for a specific execution:
List<Pipeline_Stage_Log__c> stages = [
    SELECT Stage_Id__c, Stage_Type__c, Status__c,
           Input_Tokens__c, Output_Tokens__c, Duration_Ms__c,
           Error_Message__c
    FROM Pipeline_Stage_Log__c
    WHERE Execution__c = :execId
    ORDER BY Stage_Order__c
];

// Cost by pipeline (last 30 days):
SELECT Pipeline_Id__c,
       SUM(Total_Cost__c) totalCost,
       SUM(Total_Input_Tokens__c) totalInputTokens,
       SUM(Total_Output_Tokens__c) totalOutputTokens,
       COUNT(Id) runCount
FROM PipelineExecution__c
WHERE CreatedDate = LAST_N_DAYS:30
  AND Status__c = 'Completed'
GROUP BY Pipeline_Id__c
ORDER BY totalCost DESC

// Cost by user (last 30 days):
SELECT CreatedById,
       SUM(Total_Cost__c) totalCost,
       COUNT(Id) runCount
FROM PipelineExecution__c
WHERE CreatedDate = LAST_N_DAYS:30
GROUP BY CreatedById
ORDER BY totalCost DESC

// The Pipeline_Audit__c object records every pipeline execution event:
// Action__c        — 'run' | 'run_async' | 'cancel' | 'resume' | 'validate'
// Pipeline_Id__c   — which pipeline was involved
// User__c          — who triggered the action
// Execution_Id__c  — the PipelineExecution__c Id (when applicable)
// Timestamp__c     — when it happened
// Details__c       — JSON blob with action-specific context

// Query audit trail for a specific pipeline:
List<Pipeline_Audit__c> trail = [
    SELECT Action__c, User__c, Timestamp__c, Details__c, Execution_Id__c
    FROM Pipeline_Audit__c
    WHERE Pipeline_Id__c = 'account-summarize-v1'
    AND Timestamp__c = LAST_N_DAYS:30
    ORDER BY Timestamp__c DESC
];

// Retention: controlled by FM_Config__mdt.auditLogRetentionDays (default: 365)

// FLS and CRUD are enforced by default on all SOQL and DML stages.
// You can verify this by reading the stage config:
// "enforce_fls": true   — default, use FMSecurityUtil.stripReadable() on SOQL
// "enforce_fls": false  — opt-out for advanced scenarios (audit this in pipeline JSON)

// In Apex, all @AuraEnabled methods check object-level read access:
// FMSecurityUtil.checkObjectRead('PipelineExecution__c');
// FMSecurityUtil.checkFieldAccessible('Account', 'Description');

// Cross-user execution access is blocked by default:
// A user can only resume/cancel their own executions, UNLESS they hold
// the FlowMason_Execution_Admin custom permission.

// FlowMason_Admin_Audit__c records every admin configuration change:
// Action__c    — 'create' | 'update' | 'delete' | 'activate'
// Target_Id__c — the CMT record affected
// Before_Hash__c / After_Hash__c — SHA-256 of the record before/after
// Acting_User__c — who made the change
// Timestamp__c   — when it happened

// Any mutation to FM_Config__mdt requires the FlowMason_Config_Admin permission.
// Any mutation to LLMProviderConfig__mdt requires FlowMason_Provider_Admin.
// Both write to FlowMason_Admin_Audit__c automatically.

// Permission sets deployed with the SDK:
// FlowMason_Full_Access      — run primitives, use LWCs, execute pipelines
// FlowMason_Provider_Admin   — manage LLMProviderConfig__mdt records
// FlowMason_Config_Admin     — manage FM_Config__mdt records
// FlowMason_Execution_Admin  — cancel/resume any user's pipeline execution

// Assign in Setup → Permission Sets → [set name] → Manage Assignments
// Or via SFDX:
// sf org assign permset --name FlowMason_Full_Access --on-behalf-of [email protected]

// Enable retention jobs (admin opt-in — not active by default):

// Delete Pipeline_Stage_Log__c rows older than stageLogRetentionDays (default 90):
FMLogRetentionBatch.scheduleDefault();

// Delete terminal PipelineExecution__c rows older than executionRetentionDays (default 90):
FMExecutionRetentionBatch.scheduleDefault();

// Custom schedule (cron expression):
FMLogRetentionBatch.schedule('0 0 2 * * ?');  // 2am daily

// Check what's scheduled:
// Setup → Scheduled Jobs — look for 'FMLogRetentionBatch' and 'FMExecutionRetentionBatch'

// Tune retention windows in FM_Config__mdt:
// auditLogRetentionDays    = 365   (Pipeline_Audit__c)
// stageLogRetentionDays    = 90    (Pipeline_Stage_Log__c)
// executionRetentionDays   = 90    (PipelineExecution__c terminal rows)