Dashboards

Buttons

Buttons are action triggers — they do not display data, but they drive dashboard interactivity. A button click can execute a Business Rule, refresh other dashboards, open a dialog, change the POV, or navigate to a different page. Understanding Button action properties is essential because the same action model applies to other interactive components like ComboBoxes and ListBoxes.

Button Properties

PropertyDescription
TextThe label displayed on the button. Supports |!Param!| substitution.
ToolTipHover text. Supports |!Param!| substitution.
IsVisibleShow or hide the button. Supports |!Param!| for conditional visibility.
IsEnabledEnable or disable the button.
DisplayFormatButton appearance style.

Action Properties

When a user clicks a button, OneStream executes actions in a specific order: server task first (if configured), then UI action, then dashboard redraws.
diagramButton Action Execution Flow

Loading diagram...

SelectionChangedUserInterfaceAction

Controls what happens to the UI after the server task completes.
ActionDescription
NoActionNothing happens on the UI side
RedrawRedraws the current dashboard (lighter than Refresh — re-renders components without re-fetching all data)
RefreshFully refreshes the dashboard — re-evaluates parameters, re-runs adapters, re-renders all components
CloseDialogCloses the current dialog window (if the dashboard is shown as a dialog)
CloseDialogAsOKCloses the dialog and signals OK to the parent dashboard (triggers output parameter mapping)

SelectionChangedServerTask

Specifies which type of server-side task to execute.
TaskDescription
NoTaskNo server task is executed
ExecuteDashboardExtenderBusinessRuleCalls a Dashboard Extender BR. The most common option — the BR receives args.FunctionType = ComponentSelectionChanged.
ExecuteFinanceCustomCalculateBusinessRuleCalls a Finance Business Rule's CustomCalculate function type. Useful for triggering calculations from the dashboard.

SelectionChangedServerTaskArguments

Uses the curly brace syntax to specify which BR to call and what arguments to pass:
plaintext
1{MyExtenderBR}{ProcessSubmission}{Mode=Full,Source=Dashboard}
This maps to:
  • args.FunctionName = ProcessSubmission
  • args.NameValuePairs("Mode") = Full
  • args.NameValuePairs("Source") = Dashboard

DashboardsToRedraw

A comma-separated list of dashboard names to redraw after the action completes. Use this to refresh data-display dashboards after a button triggers a data-changing operation.

Button Example

A button that executes a Dashboard Extender BR and refreshes a results dashboard.
Button configuration:
plaintext
1Text:                                    Run Calculation
2SelectionChangedServerTask:              ExecuteDashboardExtenderBusinessRule
3SelectionChangedServerTaskArguments:     {CalcExtender}{RunCalc}{Scenario=|!ScenarioParam!|}
4SelectionChangedUserInterfaceAction:     Refresh
5DashboardsToRedraw:                      ResultsDashboard
Matching Extender BR skeleton (CalcExtender):
1If args.FunctionType = DashboardExtenderFunctionType.ComponentSelectionChanged Then
2  Dim functionName As String = args.FunctionName
3  If functionName.XFEqualsIgnoreCase("RunCalc") Then
4      Dim scenario As String = args.NameValuePairs.XFGetValue("Scenario", String.Empty)
5
6      ' Execute calculation logic here...
7
8      ' Return a result message (optional)
9      Dim selChangedTaskResult As New XFSelectionChangedTaskResult()
10      selChangedTaskResult.IsOK = True
11      selChangedTaskResult.ShowMessageBox = True
12      selChangedTaskResult.Message = "Calculation completed for " & scenario
13      Return selChangedTaskResult
14  End If
15End If

Opening Dialogs

Buttons can open other dashboards as modal dialog windows. This is useful for confirmation prompts, data entry forms, and detail views.
diagramDialog Parameter Mapping Flow

Loading diagram...

Dialog Properties

PropertyDescription
DashboardsToOpenInDialogDashboard name to open as a modal dialog
DialogInitialParameterValuesComma-separated Name=Value pairs to set in the dialog before it opens
DialogInputParameterMapMaps parent parameters to dialog parameters: ParentParam=DialogParam
DialogOutputParameterMapMaps dialog parameters back to parent parameters when the dialog closes with OK: DialogParam=ParentParam
The workflow:
  1. User clicks button → dialog dashboard opens
  2. DialogInputParameterMap copies parent parameter values into the dialog's parameters
  3. User interacts with the dialog
  4. User clicks a button in the dialog with CloseDialogAsOK action
  5. DialogOutputParameterMap copies dialog parameter values back to the parent
  6. Parent dashboard refreshes with updated parameter values

POV Actions

Buttons can change the current Point of View, affecting which data the user sees across all dashboard components.
ActionDescription
ChangeEntityChanges the current Entity in the POV
ChangeScenarioChanges the current Scenario
ChangeTimeChanges the current Time period
ChangeWorkflowChanges the current Workflow

Navigation Actions

ActionDescription
OpenFileOpens a file from the dashboard's file resources
OpenPageNavigates to a different OnePlace page
OpenWebSiteOpens an external URL in a new browser tab

Related Content