sf-agent-framework

name: Salesforce Data Validation Framework Template description: Comprehensive template for designing and implementing data validation frameworks in Salesforce parameters: - name: "projectName" type: "string" description: "Name of the project or system being validated" required: true - name: "validationType" type: "string" description: "Type of validation (Migration, Integration, Data Quality, System)" required: true default: "Data Quality" - name: "environment" type: "string" description: "Target environment (Development, Sandbox, Production)" required: true default: "Sandbox" - name: "includeAutomation" type: "boolean" description: "Include automated validation scripts and processes" default: true - name: "performanceRequirements" type: "boolean" description: "Include performance validation requirements" default: true sections: framework_overview: title: "Validation Framework Overview" content: | # {{projectName}} Data Validation Framework **Framework Type:** {{validationType}} **Target Environment:** {{environment}} **Framework Version:** {{version}} **Created Date:** {{currentDate}} **Validation Engineer:** {{validationEngineer}} ## Executive Summary This validation framework provides comprehensive data validation coverage for {{projectName}}. It includes field-level, record-level, and system-level validation checks designed to ensure data integrity, accuracy, and compliance with business rules. ## Framework Objectives 1. **Zero Data Loss**: Ensure complete data preservation during {{validationType.toLowerCase()}} processes 2. **Data Accuracy**: Validate 100% accuracy of transformed and migrated data 3. **Business Rule Compliance**: Verify adherence to all business validation rules 4. **Performance Standards**: Meet or exceed performance requirements for validation processes 5. **Automated Coverage**: Achieve {{automationCoverage}}% automated validation coverage ## Validation Scope | Component | Coverage | Priority | Validation Method | |-----------|----------|----------|-------------------| {{#each validationScope}} | {{component}} | {{coverage}} | {{priority}} | {{method}} | {{/each}} ## Success Criteria {{#each successCriteria}} - {{criterion}} ({{threshold}}) {{/each}} validation_strategy: title: "Validation Strategy" content: | ## Validation Approach ### Multi-Layer Validation Strategy ``` Validation Framework Architecture: Layer 4: Business Process Validation ├─ End-to-end workflow testing ├─ Cross-system integration verification └─ User acceptance validation Layer 3: System Integration Validation ├─ API endpoint testing ├─ Data flow verification └─ Integration point validation Layer 2: Record-Level Validation ├─ Business rule compliance ├─ Cross-field dependencies └─ Data relationship integrity Layer 1: Field-Level Validation ├─ Data type verification ├─ Format validation ├─ Range and constraint checks └─ Null/required field validation ``` ### Validation Types and Coverage {{#each validationTypes}} #### {{validationType}} **Purpose:** {{purpose}} **Coverage:** {{coverage}}% **Frequency:** {{frequency}} **Automation Level:** {{automationLevel}} **Key Validation Points:** {{#each validationPoints}} - {{point}} {{/each}} **Success Metrics:** {{#each metrics}} - {{metric}}: {{target}} {{/each}} {{/each}} ### Validation Phases | Phase | Timing | Focus | Duration | Deliverables | |-------|--------|-------|----------|--------------| {{#each validationPhases}} | {{phase}} | {{timing}} | {{focus}} | {{duration}} | {{deliverables}} | {{/each}} technical_framework: title: "Technical Implementation" content: | ## Validation Architecture ### Core Components {{#each coreComponents}} #### {{componentName}} **Function:** {{function}} **Technology:** {{technology}} **Input:** {{input}} **Output:** {{output}} **Implementation Details:** ```{{language}} {{implementationCode}} ``` **Configuration:** {{#each configurations}} - {{configKey}}: {{configValue}} {{/each}} {{/each}} ### Data Validation Engine ```apex // Core Validation Framework Class public class DataValidationFramework { // Validation Configuration private static final Map<String, ValidationConfig> VALIDATION_CONFIGS = new Map<String, ValidationConfig>{ {{#each validationConfigs}} '{{objectName}}' => new ValidationConfig('{{objectName}}', {{required}}, {{rules}}), {{/each}} }; // Main Validation Method public static ValidationResult validateRecords(List<SObject> records, String validationType) { ValidationResult result = new ValidationResult(); for (SObject record : records) { // Field-level validation validateFields(record, result); // Business rule validation validateBusinessRules(record, result); // Cross-reference validation validateReferences(record, result); } return result; } // Field Validation Logic private static void validateFields(SObject record, ValidationResult result) { {{fieldValidationLogic}} } // Business Rule Validation private static void validateBusinessRules(SObject record, ValidationResult result) { {{businessRuleValidation}} } } ``` ### Validation Query Framework {{#each validationQueries}} #### {{queryName}} **Purpose:** {{purpose}} **Frequency:** {{frequency}} **Performance Target:** {{performanceTarget}} ```sql {{sqlQuery}} ``` **SOQL Equivalent:** ```soql {{soqlQuery}} ``` **Expected Results:** - Success: {{successCriteria}} - Warning: {{warningCriteria}} - Failure: {{failureCriteria}} {{/each}} validation_rules: title: "Validation Rules and Logic" content: | ## Field-Level Validation Rules {{#each objects}} ### {{objectName}} Validation Rules {{#each fields}} #### {{fieldName}} ({{fieldType}}) **Validation Rules:** {{#each validationRules}} - **{{ruleName}}**: {{ruleDescription}} - Formula: `{{formula}}` - Error Message: "{{errorMessage}}" - Severity: {{severity}} {{/each}} **Format Validation:** {{#if formatValidation}} - Pattern: `{{formatValidation.pattern}}` - Examples: {{formatValidation.examples}} - Invalid Examples: {{formatValidation.invalidExamples}} {{/if}} **Range Validation:** {{#if rangeValidation}} - Minimum: {{rangeValidation.min}} - Maximum: {{rangeValidation.max}} - Default: {{rangeValidation.default}} {{/if}} {{/each}} {{/each}} ## Cross-Field Validation Rules {{#each crossFieldRules}} ### {{ruleName}} **Objects:** {{involvedObjects}} **Fields:** {{involvedFields}} **Rule Logic:** {{ruleLogic}} **Implementation:** ```apex {{apexImplementation}} ``` **Test Scenarios:** {{#each testScenarios}} - **{{scenarioName}}**: {{description}} - Input: {{input}} - Expected: {{expected}} {{/each}} {{/each}} ## Business Process Validation {{#each businessProcesses}} ### {{processName}} Validation **Process Flow:** {{processFlow}} **Validation Points:** {{validationPoints}} **Success Criteria:** {{successCriteria}} **Validation Steps:** {{#each validationSteps}} 1. **{{stepName}}** - Check: {{check}} - Method: {{method}} - Pass Criteria: {{passCriteria}} - Fail Actions: {{failActions}} {{/each}} {{/each}} data_quality_checks: title: "Data Quality Validation" content: | ## Data Quality Dimensions ### Completeness Validation {{#each completenessChecks}} #### {{checkName}} **Target:** {{target}}% completion rate **Scope:** {{scope}} **Validation Query:** ```soql {{validationQuery}} ``` **Acceptance Criteria:** - Excellent: >95% complete - Good: 90-95% complete - Needs Improvement: <90% complete **Remediation Actions:** {{#each remediationActions}} - {{action}} {{/each}} {{/each}} ### Accuracy Validation {{#each accuracyChecks}} #### {{checkName}} **Validation Method:** {{method}} **Sample Size:** {{sampleSize}} **Accuracy Target:** {{accuracyTarget}}% **Validation Logic:** ```apex {{validationLogic}} ``` **Error Patterns:** {{#each errorPatterns}} - {{pattern}}: {{description}} {{/each}} {{/each}} ### Consistency Validation | Object Pair | Relationship | Validation Rule | Target | |-------------|--------------|-----------------|---------| {{#each consistencyChecks}} | {{objectPair}} | {{relationship}} | {{validationRule}} | {{target}} | {{/each}} ### Uniqueness Validation {{#each uniquenessChecks}} #### {{objectName}} Duplicate Detection **Matching Rules:** {{#each matchingRules}} - {{field}}: {{matchingLogic}} (Weight: {{weight}}) {{/each}} **Duplicate Handling:** - Detection Threshold: {{detectionThreshold}}% - Auto-merge Threshold: {{autoMergeThreshold}}% - Manual Review: {{manualReviewThreshold}}% {{/each}} performance_validation: title: "Performance Validation Framework" content: | ## Performance Requirements ### System Performance Targets | Operation | Volume | Response Time | Throughput | Success Rate | |-----------|---------|---------------|------------|--------------| {{#each performanceTargets}} | {{operation}} | {{volume}} | {{responseTime}} | {{throughput}} | {{successRate}} | {{/each}} ### Validation Performance Testing {{#each performanceTests}} #### {{testName}} **Test Scenario:** {{scenario}} **Data Volume:** {{dataVolume}} **Concurrent Users:** {{concurrentUsers}} **Duration:** {{duration}} **Performance Metrics:** ``` Response Time Targets: - P50: {{p50Target}}ms - P95: {{p95Target}}ms - P99: {{p99Target}}ms Throughput Targets: - Records/second: {{recordsPerSecond}} - Queries/minute: {{queriesPerMinute}} - API calls/hour: {{apiCallsPerHour}} ``` **Monitoring Queries:** ```soql {{monitoringQuery}} ``` {{/each}} ### Resource Utilization Limits | Resource | Limit | Warning Threshold | Critical Threshold | |----------|-------|------------------|-------------------| {{#each resourceLimits}} | {{resource}} | {{limit}} | {{warningThreshold}} | {{criticalThreshold}} | {{/each}} automation_framework: title: "Automated Validation Framework" content: | ## Automation Architecture ### Validation Automation Pipeline ```yaml validation_pipeline: triggers: - data_load_complete - scheduled_daily - manual_trigger stages: - stage: field_validation parallel: true tasks: - format_validation - range_validation - required_fields - stage: record_validation depends_on: field_validation tasks: - business_rules - cross_field_validation - duplicate_detection - stage: integration_validation depends_on: record_validation tasks: - api_validation - data_flow_verification - reconciliation - stage: reporting depends_on: all tasks: - generate_report - send_notifications - update_dashboard ``` ### Automated Test Scripts {{#each automatedScripts}} #### {{scriptName}} **Purpose:** {{purpose}} **Frequency:** {{frequency}} **Runtime:** {{expectedRuntime}} **Script Framework:** ```{{scriptLanguage}} {{scriptCode}} ``` **Configuration:** ```yaml {{scriptConfiguration}} ``` **Error Handling:** {{#each errorHandling}} - {{errorType}}: {{handlingMethod}} {{/each}} {{/each}} ### Continuous Validation Monitoring {{#each monitoringComponents}} #### {{componentName}} **Monitoring Frequency:** {{frequency}} **Alert Thresholds:** {{alertThresholds}} **Escalation Path:** {{escalationPath}} **Dashboard Metrics:** {{#each dashboardMetrics}} - {{metric}}: {{description}} {{/each}} {{/each}} reporting_framework: title: "Validation Reporting" content: | ## Validation Report Structure ### Executive Dashboard ``` Validation Status Overview ═════════════════════════ Overall Status: {{overallStatus}} Last Validation: {{lastValidation}} Quality Scores: ██████████████████░░ Completeness: {{completenessScore}}% ██████████████████░░ Accuracy: {{accuracyScore}}% ██████████████████░░ Consistency: {{consistencyScore}}% ██████████████████░░ Uniqueness: {{uniquenessScore}}% Validation Results: ✅ Passed: {{passedCount}} ({{passedPercentage}}%) ⚠️ Warnings: {{warningCount}} ({{warningPercentage}}%) ❌ Failed: {{failedCount}} ({{failedPercentage}}%) ``` ### Detailed Validation Reports {{#each reportSections}} #### {{sectionName}} Report **Report Frequency:** {{frequency}} **Distribution:** {{distribution}} **Format:** {{format}} **Key Metrics:** {{#each keyMetrics}} - {{metric}}: {{value}} ({{trend}}) {{/each}} **Report Content:** {{#each reportContent}} - {{contentItem}} {{/each}} {{/each}} ### Alert and Notification Framework | Alert Type | Trigger | Audience | Method | SLA | |------------|---------|----------|--------|-----| {{#each alertTypes}} | {{alertType}} | {{trigger}} | {{audience}} | {{method}} | {{sla}} | {{/each}} ### Validation Metrics Tracking ```sql -- Daily Validation Metrics Query {{dailyMetricsQuery}} -- Trend Analysis Query {{trendAnalysisQuery}} -- Exception Reporting Query {{exceptionReportingQuery}} ``` implementation_guide: title: "Implementation Guide" content: | ## Framework Implementation Phases ### Phase 1: Foundation Setup ({{phase1Duration}}) {{#each phase1Tasks}} #### Week {{week}}: {{taskName}} **Objectives:** {{#each objectives}} - {{objective}} {{/each}} **Deliverables:** {{#each deliverables}} - {{deliverable}} {{/each}} **Success Criteria:** {{#each successCriteria}} - {{criteria}} {{/each}} {{/each}} ### Phase 2: Rule Implementation ({{phase2Duration}}) {{#each phase2Tasks}} #### {{taskName}} **Implementation Steps:** {{#each implementationSteps}} 1. {{step}} {{/each}} **Testing Requirements:** {{#each testingRequirements}} - {{requirement}} {{/each}} {{/each}} ### Phase 3: Automation Deployment ({{phase3Duration}}) {{#each phase3Tasks}} #### {{taskName}} **Automation Scope:** {{automationScope}} **Technology Stack:** {{technologyStack}} **Integration Points:** {{integrationPoints}} **Deployment Plan:** {{#each deploymentSteps}} 1. {{step}} {{/each}} {{/each}} ### Phase 4: Monitoring and Optimization ({{phase4Duration}}) {{#each phase4Tasks}} #### {{taskName}} **Monitoring Setup:** {{#each monitoringSetup}} - {{setup}} {{/each}} **Optimization Targets:** {{#each optimizationTargets}} - {{target}} {{/each}} {{/each}} ## Resource Requirements | Role | Allocation | Duration | Key Responsibilities | |------|------------|----------|----------------------| {{#each resourceRequirements}} | {{role}} | {{allocation}} | {{duration}} | {{responsibilities}} | {{/each}} ## Risk Management {{#each risks}} ### {{riskName}} **Probability:** {{probability}} **Impact:** {{impact}} **Risk Level:** {{riskLevel}} **Mitigation Strategies:** {{#each mitigationStrategies}} - {{strategy}} {{/each}} **Contingency Plans:** {{#each contingencyPlans}} - {{plan}} {{/each}} {{/each}} maintenance_procedures: title: "Framework Maintenance" content: | ## Ongoing Maintenance Tasks ### Daily Operations {{#each dailyTasks}} - **{{taskName}}** ({{duration}}) - Process: {{process}} - Owner: {{owner}} - Success Criteria: {{successCriteria}} {{/each}} ### Weekly Reviews {{#each weeklyTasks}} - **{{taskName}}** ({{duration}}) - Scope: {{scope}} - Deliverable: {{deliverable}} - Stakeholders: {{stakeholders}} {{/each}} ### Monthly Assessments {{#each monthlyTasks}} - **{{taskName}}** - Analysis: {{analysis}} - Reporting: {{reporting}} - Actions: {{actions}} {{/each}} ### Framework Updates | Update Type | Frequency | Approval Required | Documentation | |-------------|-----------|------------------|---------------| {{#each updateTypes}} | {{updateType}} | {{frequency}} | {{approvalRequired}} | {{documentation}} | {{/each}} ## Performance Optimization {{#each optimizationAreas}} ### {{areaName}} **Current Performance:** {{currentPerformance}} **Target Performance:** {{targetPerformance}} **Optimization Strategy:** {{optimizationStrategy}} **Implementation Steps:** {{#each optimizationSteps}} 1. {{step}} {{/each}} {{/each}} processing-instructions: | When implementing validation frameworks: 1. Start with field-level validation and build up 2. Automate repetitive validation tasks 3. Focus on business-critical data first 4. Include performance testing from the start 5. Plan for continuous monitoring and improvement 6. Document all validation rules and logic 7. Test validation framework thoroughly before production 8. Provide clear error messages and remediation guidance metadata: version: "2.0" category: validation complexity: high estimated-time: "4-8 weeks development" review-required: true agent: "sf-data-validation-engineer" agent-name: "Raj Patel" framework-components: required-skills: - SOQL and SQL expertise - Apex development - Data modeling - Business process analysis - Performance testing dependencies: - Salesforce platform access - Test data sets - Integration endpoints - Monitoring tools deliverables: - Validation framework code - Test documentation - Performance benchmarks - Monitoring dashboards - Maintenance procedures