Skip to main content

Workflow 3: Report Generation

This workflow generates comprehensive reports from processed data and analysis results.

Overview​

The Report Generation workflow creates detailed reports by aggregating data, applying analysis, and formatting results into professional documents.

Workflow Steps​

Step 1: Data Aggregation​

Purpose: Collects and aggregates data from multiple sources

Configuration:

{
  "stepId": "data_aggregation",
  "name": "Data Aggregation",
  "type": "data-input",
  "config": {
    "sources": ["database", "api", "files"],
    "aggregationMethod": "merge"
  }
}

Step 2: Analysis​

Purpose: Performs statistical and AI-powered analysis

Configuration:

{
  "stepId": "analysis",
  "name": "Analysis",
  "type": "ai-process",
  "config": {
    "model": "gpt-4",
    "analysisType": "statistical",
    "includeInsights": true
  }
}

Step 3: Report Formatting​

Purpose: Formats analysis into report structure

Configuration:

{
  "stepId": "report_formatting",
  "name": "Report Formatting",
  "type": "formatting",
  "config": {
    "template": "standard-report",
    "format": "pdf",
    "includeCharts": true
  }
}

Step 4: Report Delivery​

Purpose: Delivers report to specified recipients

Configuration:

{
  "stepId": "report_delivery",
  "name": "Report Delivery",
  "type": "output",
  "config": {
    "method": "email",
    "recipients": ["team@example.com"],
    "schedule": "weekly"
  }
}

Configuration​

Basic Configuration​

{
  "name": "Report Generation Workflow",
  "description": "Generates comprehensive reports",
  "timeout": 180000,
  "retries": 2
}

Usage Examples​

Generate Weekly Report​

import { AIWorkflow } from 'ai-workflow';

const workflow = new AIWorkflow({
  apiKey: process.env.AI_WORKFLOW_API_KEY
});

const result = await workflow.execute('report-generation-workflow', {
  input: {
    reportType: "weekly",
    dateRange: "2024-01-01 to 2024-01-07",
    sections: ["summary", "analysis", "recommendations"],
    format: "pdf"
  }
});

console.log('Report generated:', result.reportUrl);

Scheduled Reports​

// Schedule automatic report generation
await workflow.schedule('report-generation-workflow', {
  input: {
    reportType: "monthly"
  },
  schedule: {
    frequency: "monthly",
    day: 1,
    time: "09:00"
  }
});

Input/Output​

Input Schema​

{
  "reportType": "string (daily|weekly|monthly|custom)",
  "dateRange": "string",
  "sections": "array",
  "format": "string (pdf|html|markdown)",
  "includeCharts": "boolean",
  "recipients": "array"
}

Output Schema​

{
  "reportUrl": "string",
  "reportId": "string",
  "metadata": {
    "pageCount": "number",
    "generatedAt": "timestamp",
    "format": "string"
  },
  "sections": "array"
}

Error Handling​

Common Errors​

Error CodeDescriptionSolution
NO_DATA_AVAILABLENo data found for date rangeCheck data sources
FORMATTING_ERRORReport formatting failedCheck template configuration
DELIVERY_FAILEDReport delivery failedVerify recipient addresses

Report Templates​

Standard Report Template​

Includes:

  • Executive Summary
  • Data Analysis
  • Key Insights
  • Recommendations
  • Appendices

Custom Templates​

You can create custom report templates:

await workflow.createTemplate({
  name: "custom-report",
  sections: ["custom-section-1", "custom-section-2"],
  styling: "custom-style.css"
});

Best Practices​

  1. Schedule reports during off-peak hours
  2. Use appropriate date ranges for data aggregation
  3. Include visualizations for better understanding
  4. Test report generation before scheduling
  5. Monitor report delivery success rates

Next Steps​