CubeView and BI Viewer Components
CubeView and BI Viewer components are the primary data display components in OneStream dashboards. CubeViews render tabular reports directly from a stored CubeView definition. BI Viewers provide a richer analytics experience with charts, pivot tables, and interactive filters — powered by the BI Designer.
CubeView Component
A CubeView component renders a stored CubeView on a dashboard. The component is bound to a CubeView-type data adapter, which references the stored CubeView by name. The CubeView's POV (Point of View) can include
|!Param!| syntax so the report changes dynamically based on user selections.CubeView Properties
| Property | Description |
|---|---|
| Data Adapter | Must be a CubeView-type adapter referencing a stored CubeView |
| DisplayFormat | Controls the visual presentation of the report |
| IsVisible | Show or hide the component. Supports |!Param!| for conditional visibility |
| ShowHeader | When True, displays the CubeView's name/description as a header |
| Action properties | Same action model as Buttons — server tasks, UI actions, DashboardsToRedraw |
CubeView Example
A revenue report driven by dashboard parameter selections.
CubeView Adapter —
RevenueAdapter:- CubeView Name:
RevenueSummary - POV:
E#|!EntityParam!|:S#|!ScenarioParam!|:T#|!TimeParam!|
When the user changes the Entity ComboBox (bound to
EntityParam), the dashboard refreshes, the POV resolves with the new entity, and the CubeView re-renders with updated data.BI Viewer Component
The BI Viewer is a more powerful data visualization component that supports charts, pivot tables, grids, and interactive filters. It works with multiple adapter types and provides a drag-and-drop BI Designer interface for configuring the visual layout.
BI Viewer Properties
The BI Viewer component (
XFBIViewerDefinition) exposes these properties, in addition to the standard component properties (Name, IsVisible, and the shared action model):| Property | Description | Default |
|---|---|---|
| ParameterNameValuePairs | Inbound — sets BI Designer parameters from outside values (typically a bound parameter). See Parameter Integration below. | (empty) |
| ActionNameValuePairs | Outbound — pushes a selection made inside the BI Viewer out to a dashboard bound parameter. See Parameter Integration below. | (empty) |
| ShowFilterPanelMode | Controls the filter panel: Dynamic, ShowAlways, or Never | Dynamic |
| PaletteColors | Chart color palette for the BI Viewer's visualizations | (empty) |
| ShowBorders | When True, draws borders around the component | True |
| ShowToggleSizeButton | When True, shows a toggle button to resize the component at runtime | True |
Adapter Binding
The BI Viewer supports all adapter types:
| Adapter Type | Use Case |
|---|---|
| CubeView | Standard CubeView data for simple charts and grids |
| CubeViewMD | Multi-dimensional data with flattened hierarchies for pivot analysis |
| SQL | Custom SQL queries for relational data visualization |
| Method | Business Rule-driven data (CommandType = Method, MethodType = BusinessRule) for complex or computed datasets |
Parameter Integration
The BI Viewer bridges dashboard parameters and its own internal BI Designer parameters through two string properties. Each holds
Name=Value pairs, and a value can be a dashboard bound parameter (|!Param!|). Inbound and outbound are mirror images of each other.Inbound — ParameterNameValuePairs
Sets a BI Designer parameter from an outside value when the component loads. The BI parameter is assigned a value, and that value is typically a bound parameter — it is resolved first, then applied to the BI Designer parameter.
For example, assigning the BI Designer parameter
ChosenAccount the value |!AccountParam!| filters the BI Viewer's charts and grids to the account chosen elsewhere on the dashboard. If AccountParam is not yet resolved, the user is prompted for it before the BI Viewer renders.Outbound — ActionNameValuePairs
Pushes a selection made inside the BI Viewer out to a dashboard bound parameter, so other components can react. There is no separate "Bound Parameter" property for this on the component — the wiring lives entirely in
ActionNameValuePairs. The value's source is a data-visualization item in the BI Designer (a grid, chart, etc.), identified by its name and the field/column that supplies the selected value.Outbound Example: Grid Selection Drives Other Components
A grid inside the BI Viewer named
Actual vs Budget shows an Account column, and you want a selection to drive a detail CubeView elsewhere on the dashboard.- Configure the BI Viewer's Action Name Value Pairs to source the value from the grid's
Accountcolumn and assign it to the bound parameterAccountNumber:
- At runtime, when the user selects the row
52000 – Promotions, that row'sAccountvalue is written to theAccountNumberparameter. (If multi-select is enabled, the selected values are passed as a comma-delimited list.) - A CubeView, Label, or SQL adapter elsewhere on the dashboard that references
|!AccountNumber!|refreshes to show detail for the selected account.
BI Designer
The BI Designer is a drag-and-drop interface for configuring what the BI Viewer displays. Within the BI Designer, you can add:
- Charts — Bar, line, pie, area, scatter, and other chart types
- Pivot tables — Multi-dimensional data with draggable row/column/filter fields
- Grids — Tabular data display with sorting and filtering
- Filter elements — ComboBox, ListBox, and TreeView filters internal to the BI Viewer (distinct from dashboard-level components)
BI Viewer Example
A CubeViewMD adapter feeding a BI Viewer with a pivot grid and chart for entity-level financial analysis.
CubeViewMD Adapter —
EntityAnalysisAdapter:- References a CubeView that returns multi-dimensional entity data with flattened hierarchies
- Account, Entity, and Time dimensions become separate columns in the DataTable
BI Viewer — BI Designer configured with:
- A pivot grid with Entity on rows, Time on columns, and Amount as the value field
- A bar chart bound to the same data source showing Entity-level comparison
Action Properties on Data Display Components
Both CubeView and BI Viewer components support action properties triggered by cell or item selection. This uses the same model as Buttons:
- A user clicks a cell in a CubeView or a data point in a BI Viewer chart
- The server task fires (if configured)
- The UI action executes
- DashboardsToRedraw refresh
This enables drill-down patterns — clicking a revenue total in a summary CubeView can trigger a server task that sets parameters for a detail dashboard, then opens that dashboard in a dialog.
Related Content
- Data Adapters — Adapter types, binding, and configuration
- Configuring Cubes — CubeView POV and member filter syntax in cube context
- Parameters and Syntax —
|!Param!|substitution in CubeView POV - Buttons — Shared action property model for component interactions
- PivotGrid — Standalone drag-and-drop pivot analysis (vs BI Viewer internal pivot tables)
- Cube View Fundamentals — Standalone Cube View design, object hierarchy, and rendering locations
- Cube View Calculations — Calculated rows/columns, GetDataCell expressions, CVC/CVR math, and Custom Member Lists