Run Report Book

The Run Report Book activity executes a Report Book, regenerating all the reports it contains and saving the output.

Purpose

Use the Run Report Book activity to:

• Automatically regenerate a Report Book as part of a data workflow (e.g. after a data load or calculation)
• Schedule Report Book generation without manual intervention
• Chain Report Book generation with downstream distribution steps (email, Slack, Teams)

Configuration

Path

The full path to the Report Book file in the Una file system. Click the field to open the file picker, which filters to Report Book files only.

Example: /Reports/Monthly/ExecutiveSummary.rb

Behavior

1. The Report Book path is resolved in the Una file system.
2. If the file cannot be found, the activity logs an error and returns Error.
3. The Report Book service executes the book, regenerating all contained reports.
4. On success the activity returns Success.

Usage Patterns

Load Then Refresh Reports

ETL ("Import_Actuals") ──> Run Calculation ("ComputeVariances") ──> Run Report Book
                                                                       └── /Reports/Monthly/VarianceReport.rb

Generate Then Distribute

Run Report Book ──> Send Email
  └── /Reports/Weekly/SalesReport.rb    └── Attach report link

Usage Notes

• The path must point to a Report Book file. Other file types will result in a file-not-found error (the picker filters to Report Books, but the path can also be typed directly).
• If the path includes query parameters (e.g. ?period=2025-Q1), they are stripped before the file lookup. Report Book parameters must be configured within the Report Book itself, not via path parameters.
• Report Book execution time depends on the number and complexity of reports it contains. For large report books, consider whether the workflow timeout needs to be adjusted.

Best Practices

• Name the activity after the Report Book it runs (e.g. "Generate: Monthly Close Report") for clarity in the workflow diagram.
• Wire an error arrow so file-not-found or execution failures are surfaced rather than silently skipped.
• Combine with a Send Email or messaging activity to distribute the output immediately after generation.

JSON Reference

{
  "discriminator": "RunReportBookWorkflowActivity",
  "activityId": "<uuid>",
  "name": "Run Report Book",
  "positionX": 0,
  "positionY": 0,
  "advanceRule": 2,
  "reportBook": "/Reports/Monthly/ExecutiveSummary.rb"
}

Property	Type	Description
reportBook	string | null	Corresponds to the Path field. The full Una file system path to the Report Book file to execute.