sf-agent-framework
Version:
AI Agent Orchestration Framework for Salesforce Development - Two-phase architecture with 70% context reduction
390 lines (298 loc) • 7.83 kB
Markdown
# Validation Script Runner Utility - Agent Instructions
## Purpose
This utility provides instructions for AI agents to generate validation script
execution frameworks for Salesforce implementations, enabling automated
validation of configurations, data integrity, and system compliance.
## Agent Instructions
### When to Generate Validation Script Running
Generate validation script execution components when:
- Data integrity needs verification
- Configuration validation is required
- Business rule compliance needs checking
- System health monitoring is needed
- Quality assurance requires automation
- Deployment validation is necessary
- Continuous validation is required
### Core Components to Generate
#### 1. Validation Script Engine
Generate execution components that:
- Execute validation scripts in sequence
- Manage script dependencies
- Handle parallel execution
- Collect results and metrics
- Generate comprehensive reports
- Provide real-time feedback
Key validation types:
- Data validation scripts
- Configuration validation
- Business rule validation
- Integration validation
- Performance validation
- Security validation
#### 2. Script Repository Manager
Create management components for:
- Script version control
- Script categorization
- Dependency management
- Execution scheduling
- Result archiving
- Performance tracking
#### 3. Result Processing Framework
Implement processing for:
- Result aggregation
- Error analysis
- Trend identification
- Report generation
- Alert triggering
- Remediation recommendations
### Configuration Requirements
#### Custom Objects
```yaml
Validation_Script__c:
- Script_Name__c (Text)
- Script_Category__c (Picklist)
- Script_Type__c (Picklist)
- Script_Body__c (Long Text Area)
- Description__c (Text Area)
- Dependencies__c (Text Area)
- Expected_Runtime__c (Number)
- Active__c (Checkbox)
- Version__c (Text)
- Author__c (Lookup - User)
Script_Execution__c:
- Validation_Script__c (Master-Detail)
- Execution_Date__c (DateTime)
- Status__c (Picklist)
- Duration_ms__c (Number)
- Records_Processed__c (Number)
- Issues_Found__c (Number)
- Success_Rate__c (Percent)
- Output_Log__c (Long Text Area)
- Error_Details__c (Text Area)
Validation_Result__c:
- Script_Execution__c (Master-Detail)
- Rule_Name__c (Text)
- Object_Name__c (Text)
- Record_Id__c (Text)
- Status__c (Picklist)
- Error_Message__c (Text Area)
- Severity__c (Picklist)
- Resolution_Notes__c (Text Area)
```
### Validation Script Categories
#### Data Validation Scripts
```
1. Data Integrity Checks
- Required field validation
- Data type validation
- Format validation
- Range validation
- Relationship validation
- Duplicate detection
2. Business Rule Validation
- Workflow compliance
- Approval process validation
- Field dependency checks
- Custom validation rules
- Process builder verification
- Flow execution validation
```
#### Configuration Validation Scripts
```
1. System Configuration
- Security settings validation
- User access verification
- Permission set validation
- Profile configuration checks
- Sharing rule validation
- Organization limits monitoring
2. Custom Configuration
- Custom object validation
- Field configuration checks
- Page layout validation
- Record type verification
- Custom settings validation
- Custom metadata verification
```
### Implementation Patterns
#### Sequential Execution Pattern
1. Load script queue
2. Check dependencies
3. Execute in order
4. Collect results
5. Generate reports
6. Trigger notifications
#### Parallel Execution Pattern
1. Identify independent scripts
2. Execute concurrently
3. Monitor progress
4. Aggregate results
5. Handle failures
6. Optimize performance
#### Conditional Execution Pattern
1. Evaluate conditions
2. Select applicable scripts
3. Execute dynamically
4. Adapt to context
5. Handle variations
6. Track decisions
### Script Generation Instructions
#### Data Validation Scripts
Generate scripts that:
- Query data sets
- Apply validation rules
- Check business logic
- Verify relationships
- Validate formats
- Detect anomalies
#### Configuration Scripts
Create scripts that:
- Verify system settings
- Check user permissions
- Validate custom configurations
- Test integration points
- Monitor system health
- Assess compliance
#### Performance Scripts
Build scripts that:
- Monitor response times
- Check resource usage
- Validate throughput
- Assess scalability
- Identify bottlenecks
- Track trends
### Best Practices to Implement
1. **Script Design**
- Modular architecture
- Clear naming conventions
- Comprehensive logging
- Error handling
- Performance optimization
2. **Execution Management**
- Dependency resolution
- Resource management
- Progress tracking
- Failure recovery
- Result preservation
3. **Result Analysis**
- Clear metrics
- Trend analysis
- Exception handling
- Root cause analysis
- Actionable insights
4. **Maintenance**
- Version control
- Regular updates
- Performance monitoring
- Documentation updates
- Archive management
### Advanced Features to Consider
1. **Intelligent Scheduling**
- Priority-based execution
- Resource-aware scheduling
- Adaptive timing
- Load balancing
- Optimization algorithms
2. **Dynamic Script Generation**
- Template-based creation
- Parameter substitution
- Conditional logic
- Runtime adaptation
- Context awareness
3. **Advanced Analytics**
- Pattern recognition
- Anomaly detection
- Predictive analysis
- Machine learning integration
- Trend forecasting
### Error Handling Instructions
#### Exception Management
Handle these scenarios:
1. Script compilation errors
2. Runtime exceptions
3. Permission errors
4. Timeout conditions
5. Resource limitations
#### Recovery Strategies
Implement recovery for:
- Partial failures
- Dependency issues
- Resource conflicts
- Data access problems
- Network connectivity
#### Logging Requirements
Generate comprehensive logs for:
- Execution tracking
- Error diagnostics
- Performance metrics
- Debug information
- Audit trails
### Dashboard Components to Generate
#### Execution Dashboard
Display:
- Script execution status
- Success/failure rates
- Performance metrics
- Current queue status
- Resource utilization
- Historical trends
#### Results Dashboard
Show:
- Validation results summary
- Issue categorization
- Severity distribution
- Resolution tracking
- Trend analysis
- Compliance metrics
#### Management Dashboard
Include:
- Script inventory
- Version management
- Dependency mapping
- Schedule management
- Performance analysis
- Maintenance tracking
### Testing Requirements
Generate test strategies for:
1. Script execution accuracy
2. Error handling robustness
3. Performance benchmarking
4. Concurrency testing
5. Integration validation
#### Test Scenarios
- Normal execution paths
- Error conditions
- Edge cases
- Performance limits
- Concurrent execution
- Resource constraints
### Success Metrics
Track and measure:
- Execution success rate
- Average execution time
- Issue detection rate
- False positive rate
- System reliability
- User satisfaction
### Integration Capabilities
#### CI/CD Integration
- Build pipeline validation
- Deployment verification
- Automated testing
- Quality gates
- Release validation
- Rollback verification
#### Monitoring Integration
- Real-time alerts
- Performance monitoring
- Health checks
- Threshold management
- Escalation procedures
- Dashboard updates
#### Reporting Integration
- Automated reporting
- Stakeholder notifications
- Compliance documentation
- Audit trail generation
- Metrics collection
- Trend analysis