Initial commit

skills/skill-adapter/assets/progress_report_template.md

@@ -0,0 +1,72 @@
+# Batch Processing Job Progress Report
+
+This report provides a summary of the progress for a batch processing job.
+
+## Job Information
+
+*   **Job ID:** `[Insert Job ID Here - e.g., job-2024-10-26-001]`
+*   **Job Name:** `[Insert Job Name Here - e.g., Import Customer Data]`
+*   **Job Description:** `[Insert a brief description of the job - e.g., Imports customer data from CSV file into the database.]`
+*   **Start Time:** `[Insert Job Start Time - e.g., 2024-10-26 08:00:00 UTC]`
+*   **End Time:** `[Insert Job End Time - e.g., 2024-10-26 10:30:00 UTC (or "In Progress")]`
+*   **Status:** `[Insert Job Status - e.g., Completed, In Progress, Failed, Partially Completed]`
+
+## Input Data
+
+*   **Source:** `[Insert Source of Input Data - e.g., CSV file: customer_data.csv, S3 Bucket: s3://my-bucket/data]`
+*   **Number of Records:** `[Insert Total Number of Records to Process - e.g., 10,000]`
+
+## Processing Summary
+
+| Metric          | Value      |
+|-----------------|------------|
+| Total Records   | `[Insert Total Records]` |
+| Records Processed | `[Insert Records Processed]` |
+| Records Succeeded | `[Insert Records Succeeded]` |
+| Records Failed    | `[Insert Records Failed]` |
+| Success Rate    | `[Insert Success Rate (e.g., 95%)]` |
+| Failure Rate    | `[Insert Failure Rate (e.g., 5%)]` |
+
+**Example:**
+
+| Metric          | Value      |
+|-----------------|------------|
+| Total Records   | 1000       |
+| Records Processed | 750        |
+| Records Succeeded | 700        |
+| Records Failed    | 50         |
+| Success Rate    | 93.33%     |
+| Failure Rate    | 6.67%      |
+
+## Detailed Results (Optional)
+
+This section can include more detailed information about the processed records. You can tailor this section to your specific needs.
+
+*   **Successful Records:** `[Insert a summary or link to successful record details - e.g., A list of successful record IDs can be found in successful_records.log]`
+*   **Failed Records:** `[Insert a summary or link to failed record details - e.g., A list of failed record IDs and error messages can be found in failed_records.log]`
+*   **Example Error Message:** `[Insert Example Error Message - e.g., "Invalid email format for record ID: 123"]`
+
+## Performance Metrics
+
+*   **Processing Time:** `[Insert Total Processing Time - e.g., 2 hours 30 minutes]`
+*   **Average Processing Time per Record:** `[Insert Average Time per Record - e.g., 0.9 seconds]`
+*   **Peak Memory Usage:** `[Insert Peak Memory Usage - e.g., 2GB]`
+
+## Errors and Warnings
+
+*   `[List any errors or warnings encountered during processing.  Include timestamps and specific details.]`
+    *   **Example:** `2024-10-26 09:15:00 UTC - Warning: Rate limit exceeded for API endpoint. Retrying in 60 seconds.`
+    *   **Example:** `2024-10-26 09:30:00 UTC - Error:  Database connection lost. Attempting to reconnect.`
+
+## Recommendations
+
+*   `[Insert any recommendations for improving the job or addressing issues. - e.g., Increase the rate limit for the API endpoint to avoid rate limiting errors.  Consider adding retry logic for database connection errors.]`
+
+## Notes
+
+*   `[Insert any additional notes or comments about the job. - e.g., This job was executed with 4 parallel workers.]`
+
+## Generated By
+
+*   `[Insert the tool or system that generated this report. - e.g., API Batch Processor Plugin]`
+*   **Generation Date:** `[Insert the date the report was generated. - e.g., 2024-10-26]`