Cube Views

Report Books

Report Books compile multiple Cube Views, dashboard charts, and dashboard reports into a single distributable package. They automate report generation by looping over dimension members, applying conditional logic, and changing parameters between pages. This guide covers book design, item types, loops, conditional statements, and distribution.

What Report Books Are

A Report Book is a compiled output that combines multiple report items into a single file. Instead of generating individual Cube View reports one at a time, a Report Book produces a complete package — one PDF with all entity reports, one Excel workbook with tabs per scenario, or one ZIP with individual files.

Book Formats

FormatExtensionDescription
PDF.xfDoc.pdfBookAll report items compiled into a single PDF document
Excel.xfDoc.xlBookReport items as worksheets in an Excel workbook
ZIP.xfDoc.zipBookIndividual report files packaged in a ZIP archive

Book Designer

The Book Designer is the visual editor for configuring Report Books. It provides a toolbar and a tree-view of book items.
diagramReport Book Structure

Loading diagram...

Book Properties

PropertyDescription
DetermineParametersFromContentTrue — the engine scans all report items to determine required parameters; False — use RequiredInputParameters instead
RequiredInputParametersExplicit list of required POV parameters. Set this and DetermineParametersFromContent=False for large books to improve performance
💡Tip
For large Report Books with many items, set DetermineParametersFromContent to False and explicitly list RequiredInputParameters. Scanning all items for parameters can be slow when the book contains dozens of reports and loops.

Book Items

The Book Designer supports several item types that control what the book contains and how it is generated.

Reports

Reports are the core items — each one renders a Cube View, dashboard chart, or dashboard report.
Report TypeDescription
CubeViewRenders a stored Cube View in Report view format
DashboardChartRenders a chart component from a dashboard
DashboardReportRenders a report component from a dashboard
SystemDashboardChartRenders a system-level dashboard chart
SystemDashboardReportRenders a system-level dashboard report

Report Properties

PropertyDescription
CubeViewName / ComponentNameThe name of the Cube View or dashboard component to render
OutputNameThe name of the output page or worksheet (supports substitution variables)
IncludeReportMarginsInclude the Cube View's margin settings in the output
IncludeReportHeaderInclude the Cube View's report header in the output
IncludeReportFooterInclude the Cube View's report footer in the output

Files

File items include static files (images, cover pages, appendices) in the book output. The file is included as-is, without processing.

ExcelExportItems

ExcelExportItems add raw data exports to the book — the data is exported in a tabular format suitable for further analysis in Excel.

Loops

Loops iterate over dimension members to generate one page (or set of pages) per member. This is the primary mechanism for producing entity-by-entity, scenario-by-scenario, or time-period-by-time-period reports.

Loop Configuration

plaintext
1Loop Variable: Loop1Variable
2Member Filter: E#Root.Children
3
The loop iterates over the members returned by the member filter. On each iteration, Loop1Variable is set to the current member, and all report items inside the loop render with that member in their POV.

Loop Variable Syntax

Inside a loop, reference the current member using the loop variable in report item properties:
plaintext
1CubeView POV: E#|!Loop1Variable!|:S#Actual:T#2026M3
2OutputName: PL Summary - |!Loop1Variable!|
Each iteration produces a report page with the loop member substituted into the POV and the output name.

Nested Loops

Loops can be nested to create a matrix of outputs:
plaintext
1Loop 1: E#Root.Children          → Loop1Variable = Entity
2Loop 2: S#Actual|S#Budget      → Loop2Variable = Scenario
3  Report: PL Summary
4    POV: E#|!Loop1Variable!|:S#|!Loop2Variable!|
This generates one PL Summary per entity-scenario combination.

Conditional Statements

Conditional statements (If/ElseIf/Else) control which report items are included based on loop variables or other conditions.

Syntax

plaintext
1If: Loop1Variable <> Eliminations
2  Report: Standard PL
3ElseIf: Loop1Variable = CorpHQ
4  Report: Corporate PL (special format)
5Else
6  Report: Eliminations Detail
7End If
Conditions can reference loop variables and compare them to specific member names. This allows different report formats for different entities, scenarios, or time periods.

Use Cases

  • Skip eliminations entities — exclude intercompany elimination entities from the standard report set
  • Different formats — use a detailed Cube View for operating entities and a summary view for holding companies
  • Conditional sections — include a supplementary analysis page only for certain scenarios

Change Parameters

Change Parameters items modify the POV between report pages without using a loop. They set specific dimension members for subsequent report items.
plaintext
1Change Parameters: S#Budget, T#2026M12
2Report: Year-End Budget Summary
This is useful for one-off parameter changes — for example, adding a year-end summary page at the end of a book that loops over monthly periods.

Viewing Report Books

Report Books can be viewed through several mechanisms:
MethodDescription
BookViewerA dashboard component that renders the compiled book inline
FileViewerA dashboard component that displays the book file from storage
Data ManagementGenerate books as part of a Data Management sequence (automated production)
File shareSave the compiled book to a file share for external distribution

Storage Locations

Compiled books can be stored in:
  • Dashboard files — accessible from dashboard components
  • File share — accessible from external systems and email
  • Desktop — downloaded to the user's local machine

PDF Embedded Fonts

PDF books embed fonts to ensure consistent rendering across systems. The PDFEmbeddedFontsToRemove setting controls which fonts are excluded from embedding to reduce file size.
ℹī¸Info
Large Report Books with many pages can produce sizable PDF files. Removing unnecessary embedded fonts with PDFEmbeddedFontsToRemove can significantly reduce file size, especially when standard system fonts (Arial, Times New Roman) are used.

Distributing Report Books

OneStream Parcel Service

The OneStream Parcel Service solution automates book distribution — generating books on a schedule and delivering them via email or file share.

Email Integration

Books can be emailed directly from OneStream using a Data Management sequence that:
  1. Generates the Report Book
  2. Retrieves the compiled file
  3. Sends it as an email attachment via the configured SMTP server

Automated Generation

For recurring reports (monthly close books, quarterly board packages), configure a Data Management sequence to:
  1. Set the POV parameters
  2. Generate the Report Book
  3. Store or distribute the output
This eliminates manual report generation and ensures consistency.

Related Content