Presenting Data With Books, Cube Views and Dashboards

You can present data using report books, cube views, and dashboards. Report Books allow you to combine a variety of reports and files in a way that fits your reporting needs. Cube views allow you to query cube data and present it in a variety of ways. Dashboards present data by combining a variety of sources such as components, data adapters, and other files. in this section you will learn how to present data using these methods.

Presenting Data Using Report Books

Report Books let you combine a variety of reports and files into a single document. They are commonly used to create financial statements and management report packages. Anyone who needs a snapshot view of their company financials can run report books, but this is done most often by managers and individuals who report to management.

There are pre-built reports that can be customized to fit your reporting needs, such as:

• Cube views (which can be exported to an Excel file)

• Dashboard reports

• Charts

• Extensible documents

After creating a report book, it can be viewed and used in different contexts. For example, they can be added to other books, added to dashboards using either the Book Viewer or File Viewer dashboard component, or emailed via the OneStream Parcel Service OneStream Solution. You can also generate and view report books by running a data management sequence.

Books can be stored in locations such as a fileshare, your computer desktop, or a dashboard file. When saving a report book it is important to follow pre-defined naming conventions depending on the format of the book, such as bookname.xfDoc.pdfBook (PDF books), bookname.xfDoc.zipBook (zipped books), and bookname.xfDoc.xlBook (Excel books).

NOTE: Embedding fonts in a PDF Report book could increase the size of the PDF file. Use the PDF Embedded Fonts to Remove property in the Application Server Configuration File to specify which fonts should not be embedded. This will reduce the size of PDF files and control the resolution during report book PDF generation. The default font-stack setting is: Arial; Calibri; Segoe UI; Tahoma; Times New Roman; Verdana.

Book Designer Toolbar

When designing a book, you will work in the two tabs of the book designer to build and preview your book. The book designer is where you use the book toolbar icon to create a book in a hierarchical format. The OneStream Book Designer includes tools and methods that help you customize data when creating reports.

The following image displays the Book Designer toolbar.

The names of the tools describe their functions, but there are options to choose from when you click Save As and Add Item.

Save As lets you specify the kind of book you are creating and the location.

• Save as File in OneStream File System: Saves the book in the File Explorer. It can be saved in a public folder or a local folder on your system.

• Save as File on Local Folder: Saves the book in a local folder on your system.

• Save as Application Workspace File: Saves the book in the File section of an Application Workspace Maintenance Unit.

• Save as System Workspace File: Saves the book in the File section of a System Workspace Maintenance Unit.

You can create three types of books: Excel books, PDF books, and Zip File books. Excel books produce an Excel Workbook with each piece of content on a new tab. PDF books compile all content in a single PDF file. Zip books produce a zip file where each piece of content exists individually. You can create each type of book by saving it with the appropriate file suffix.

You can specify the book type when you save the file using any of the following extensions:

• Excel books: ReportBookName.xfDoc.xlBook

• PDF books: ReportBookName.xfDoc.pdfBook

• Zip File books: ReportBookName.xfDoc.zipBook

Add Item lets you specify the kind of item to add to the book. You can add:

• Files

• Excel Export Items

• Reports

• Loops

• Condition statements (If, Else If, and Else)

• Item to Change Parameters

Book Properties

When you are creating a new book, regardless of type, there are two book properties to consider:

• Determine Parameters from Content

• Required Input Parameters

Parameters let you determine what data should be displayed in the resulting report book. They act like filters in that only certain data is selected and displayed in the report book. Each of these items is explained in further detail below.

Determine Parameters from Content

This item can be set to True or False. If set to True, it automatically determines the required input parameters from the book's content items. For large report books, setting this to False and manually specifying the required parameters will result in a performance gain.

Required Input Parameters

This field requires a comma-separated list of parameter names. You can leave this field blank if Determine Parameters from Content is set to True.

Using an Item to Change Parameters

Change parameters are used to turn off the prompt that the parameter would normally generate to define the desired result of the book. The Loop definition populates the items instead.

For example, imagine a cube view that would normally prompt you for the time member to be added to the report book. In this case, you might not want the user to make a selection, and instead, you want the report book to run for the workflow time. Rather than copying or altering the cube view, you would add an Item to Change Parameters.

File Type

Part of the process of creating new report books is selecting a file source type. You select a file source type whenever a new file is added to a book.

You can select the following source types for your files:

• URL: Specify a file from an internal or external web page. You must use the full URL.

• Application Workspace File: Select a file stored in the Application Workspace Maintenance Unit File Section.

• System Workspace File: Select a file stored in the System Workspace Maintenance Unit File Section.

• Application Database File: Select a file stored in the Application Database Share.

• System Database File: Select a file stored in the System Database Share.

• File Share File: Select a file from the File Share. Many file types can be added such as Word, PDF, CSV, and XLSX.

In addition to specifying the file source type, you must also set the following:

• URL or Full File Name: Select the URL or name of the file you want to use. Type the full URL or click the ellipsis to browse to a file.

• Output Name: Type a name for the file when creating a Zip book. If the .pdf extension is included for a Word or Excel file, the file will be converted into a PDF. This property is optional and does not apply to PDF books.

Excel Export Item

When creating an XLbook, you will use Excel Export Items. You can specify a cube view to export to an Excel file. Each cube view will display on a separate worksheet in the book. These are useful when added to XLBooks rather than PDFBooks.

NOTE: Report and File items are not supported by Excel books and are ignored if added.

To create an Excel Export Item, set the following properties:

• Cube View Name: Click the ellipsis and select a cube view to add to the Excel Book.

• Output Name: This field is optional. Type a name for the cube view to display on the Excel worksheet. The character limit is 31.

Report

When you add a report to a report book, you must specify a report type. This usually depends on how you have saved the book.

You can select from the following report types:

• Cube View: The report is based on a cube view.

• Dashboard Chart: The report is based on an Application Dashboard Chart.

• Dashboard Report: The report is based on an Application Dashboard Report.

• System Dashboard Chart: The report is based on a System Dashboard Chart.

• System Dashboard Report: The report is based on a System Dashboard Report.

NOTE: The chart and report items listed above are application dashboard chart components, rather than dashboard components.

In addition to selecting a report type, you must also set the following:

• Cube View or Component Name: Name of the Cube View, Dashboard Report or Dashboard Chart that you are using in the book. Click the ellipsis and browse to the source for a report.

• Output Name: Type a name for the report when it is a Zip book. This field is optional and does not apply to PDF books.

• Include Report Margins/Report Header/Page Header/Report Footer/Page Footer: Select True to keep the original margins, report or page headers, and report or page footers. Select False to remove the original formatting.

Loop

A loop is a sequence of instructions that will continually run a process as many times as is defined in the loop definition. For example, a book can be set up to loop through all the base entities under a particular hierarchy and generate an instance of the same cube view report for each entity.  

Loop Type

There are three types of Loops to use when building your book:

Comma Separated List: Select this option to enter values separated by a comma to be referenced later in the book hierarchy.

Dashboard Parameter: Select this option to use a pre-configured Parameter found in the Application Dashboards page.

For example, a ParamSalesRegions parameter returns a list of all Sales Regions within the application resulting in the report book’s loop variables using the same list.

Member Filter: Select this option to utilize the member filter builder to build a member filter based on dimension members.

This loop will run each of the report book items for the specified members.

Loop Definition

When using the loop type Comma Separated List, enter a comma-separated list of text values to loop over. Use brackets [ ] when names have spaces.

For example:
(Houston, Clubs, [Houston Heights])

When using the loop type Dashboard Parameter Loop Type Used, enter the name of a dashboard parameter to create a list based on an existing parameter.

For example, a ParamSalesRegions parameter returns a list of all Sales Regions within the application resulting in the report book's loop variables using the same list.

When using the loop type Member Filter Loop Type Used, enter a member filter to supply a list of members to use in the loop.

For example:
E#Frankfurt, E#Houston, E#Montreal
This loops over each entity and performs the process three times.

E#[NA Clubs].Base
This loops over each base entity under NA Clubs and performs the process for however many base entities there are.

Dimension (only available when Member Filter is the Loop Type)
The name of the specific dimension used by the member filter.  Click the ellipsis and select the correct dimension.

Loop Variables

Create loop variables by selecting a variable from the drop down menu.

|Loop1-4Variable|

Allows all Report Book items located in the loop’s hierarchy to reference the loop definition's values by name.

Up to four loop variables can be referenced and all must be enclosed in |pipes|.

For example
|Loop1Variable|.

Use |Loop2Variable| through |Loop4Variable| to create nested loops within a loop.

|LoopDisplay1-4Variable|

Allows all report book items in the loop hierarchy to reference the loop definition's values by description.

For example
|Loop1Display|

|Use |Loop2Display| through |Loop4Display| to create nested loops within a loop.

|Loop1-4Index|

Assigns a number to the values in the loop definition beginning with number one, which can be referenced in the report book items in the hierarchy.

Use |Loop2Index| through |Loop4Index| to create nested loops in a loop.

Change Parameters

Change parameters are used to enhance the data in report books. Setting these parameters customizes the report book output without altering the input from the source.

Loops require Change parameters to run, but Change parameters are not exclusive to loops. When a Change Parameter type is encountered in a loop, the Loop variable is updated to use the next Loop variable.                          

For example, a loop may be used to loop through a list of entities and run a report for each. The Change parameters book Item should be added here to pass along the appropriate Loop variable (such as |Loop2Variable|) which applies to each entity included in the loop.                             

Workflow

Change Workflow: Set to True to change settings for cube views or reports driven by Workflow POV information.

Workflow Profile: Specify the Workflow Profile name to replace the original Workflow Profile referenced in the cube view or report.

Workflow Scenario: Specify the Workflow Profile Scenario Type to replace the original Workflow Profile Scenario Type referenced in the cube view or report.

Workflow Time: Specify the Workflow Profile Time to replace the original Workflow Profile Time referenced in the cube view or report.

POV

POV: Set to True to change the book’s POV without having to change the actual cube view or report.

NOTE: To use this feature, the POV tab in the cube view should not have any members selected. 

Member Script: Click the ellipsis button to launch the Member Filter Builder and enter a Member Script to change the POV.  The example below changes the POV for both the entity and account.
E#[|Loop1Variable|]:A#Sales

Variables

Change Variables: This serves as a placeholder that can store up to ten variables.  This is valuable when If statements are used.

Variable Values: Enter a comma-separated list of name-value pairs to change the values of the predefined variables named Variable 1-10.

Example: Variable1=Red, Variable2=Large, Variable3=[(Loop1Variable)]

Parameters

Change Parameters: Use to specify a value for a dashboard parameter found in a cube view.

Parameter Values: Click to select a parameter.  Enter a comma-separated list of name-value pairs to override the custom parameter’s values.

Example: MyParam=Red, MyOtherParam=[|Loop1Variable|]  

NOTE: Use !! to display the Display Items in a report header. Use ! to display the Value items in a report header.

The Loop definition has a single “Change Parameters” definition. Within that definition, it changes to a single variable, “Loop1Variable”. The “Loop1DisplayVariable” and “Loop1Index” variables never change.

To change the Report Book title based on the Cube View column results, add a second “Change Parameters” definition changing the “Loop1DisplayVariable” variable.

If Statement

If Statements can be used to provide conditional logic to your report books. They are commonly used in tandem with loops to create a more fine-tuned output but they can also stand on their own. Additional logic can also be added through the use of Else If and Else statements. If Statements determine how book items within the hierarchy are processed.

Statement: Enter a conditional statement using parameters to determine whether the book items will be processed. 

Example of Using Variables in If Statements

(|Loop1Variable| = [Frankfurt])

This is an example of an If Statement that would have existing with a loop. If “Frankfurt” is found within the Loop Definition for the Loop1Variables, the book items in this hierarchy will process for Frankfurt.

Example of Using Parameters in If Statements

(|!UserName!| = Administrator)

If the person running the book has a user name of Administrator, the book items in this hierarchy will be included in the book.

Example of Combining Statements

(|!UserName!| = Administrator) Or (|!UserName!| = JSmith)

If the person running the book has a user name of Administrator or JSmith, the book items in this hierarchy will be included in the book.

Else/Else If Statement

Else and Else If Statements, like If Statements, may or may not be used within loops to provide additional logic to the report book output. Else and Else If statements determine how book items within the hierarchy are processed.  An If statement is needed to use an Else or Else If statement.

Statement: Enter a conditional statement using parameters to determine whether the child items will be processed.  See examples in If Statement.

Example:

Loop1Variable: E#[Frankfurt], E#[Europe Clubs], E#[Clubs]

If Statement: (|Loop1Variable| = [Frankfurt])
If Loop1Variable is Frankfurt, run the report and file under the If statement.

Else If Statement: (|Loop1Variable| = [Europe Clubs])
Else If (or otherwise if) the Loop1Variable is Europe Clubs, run the report under the Else If statement.

Else: Else (in all other cases) run the report under the Else statement.  

Create a Report Book

This procedure will guide you through the process of creating a basic report book.

NOTE: When creating books, you can drag and drop book items. This makes it easier to move items up and down the heirarchy.

1. Open OneStream.

2. On the Application tab, under Presentation, click Books. The Book Designer opens.

3. Click Create New Book on the toolbar.

4. Set the Determine Parameters from Content field to either True or False. See Book Properties.

5. If you set the field to False in Step 4, type the appropriate parameters into the Required Input Parameters field.

   If you set the field to True, leave the Required Input Parameters field blank.

6. Click Add Item on the toolbar and select the items you want to add to the book:

   • Add File: See File Type.

   • Excel Export Item: See Excel Export Item

   • Report: See Report

   • Loop: See Loop

   • Conditional Statement: See If Statement and Else/Else If Statement.

   • Add Item to Change Parameters: See Parameters

7. If you need to remove items from the Book Designer, click Remove Item on the toolbar.

8. Click Save As and select a location.

9. Click the Preview tab to see the new book. A book similar to the following image is displayed.

   

10. Click Close Book on the toolbar when you are done. You can open another book by clicking Open Book and selecting the kind of book.

Book Preview Toolbar

The Book preview toolbar allows you to interact and navigate in the book being previewed.

1. Page Navigation:This displays what page is currently being previewed in the report book. To navigate to a specific page, enter the page number and press Enter.

2. First/Last: Use these buttons to navigate to the first or last page of the report book.

3. Previous/Next: Use these buttons to navigate forward or backward one page.

4. Combine All Items: This combines the report book’s pages and treats them as one content item.  Use this feature in conjunction with saving or printing an entire report book.  If selected, you can save the entire report book as one PDF file, print the entire book, and navigate page by page using the blue navigation arrows.  If this box is cleared, only the current page will save or print, and black navigation icons will be enabled.

5. Download Combined PDF File: This combines the entire report book into a PDF file using the standard Adobe rendering process and uses less memory when attempting to display large combined PDF files.  This does not require enabling Combine All Items.  This is the suggested method when downloading any report book to PDF.

6. Refresh: Use this button to refresh the report book and select new Parameter values.

7. Close: Use this to close the report book in the Preview screen.

8. File name: Shows the name of the file currently being previewed.

9. Open: Use this to open a report book from a computer desktop or folder.

10. Save: Use this to save the current report book page.  To save the entire report book as one PDF file, ensure that the Combine All Items checkbox is selected.

11. Print: Use this to open the Print dialogue box. To print the entire report book, ensure that the Combine All Items checkbox is selected.

12. Find: Use this to find specific keywords in a report book.

13. Previous Page/Next Page: Use these icons to navigate pages of a single report book content item or to navigate a report book’s pages when the Combine All Items checkbox is selected. If a particular content item, such as a Cube View Report, is more than one page, use these buttons to navigate that report.

14. Zoom: Use these buttons to zoom in and out of a report book.

Right-Click Options

Right-click anywhere within the report to select these options.

Select tool: Use this to select portions of the report book. This feature allows you to copy and paste. Highlight a portion of the report book, press Ctrl+C then Ctrl+V.

Hand tool: Use this button to scroll through a report book by clicking anywhere on the screen and moving the mouse.

Marquee Zoom: Use this tool to select an area of interest on which to zoom.

TIP: Use Alt+Left to return to the previous view or Ctrl+0 to return to a page level view.

Print: Use this to open the Print dialogue box.

Find: Use this to find specific keywords in a report book.

Select All: Use this to select all the content in a report book.

Build Reports Through Cube Views

Cube views submit and present cube data. You can format cube views to display final reports or forms for data entry, both of which can be exported to a PDF or Excel spreadsheet. You create and maintain cube views on the Application tab in the Presentation section, but can access and run cube views from:

• Application Cube Views page

• Workflow Task (forms)

• Workflow Analysis section of a Workflow

• Cube Views section in the OnePlace tab

• Spreadsheet/Excel Add-In

You can incorporate cube views in report books, dashboards, form templates, spreadsheets, and extensible documents. That is why they are often called the "building blocks of reporting". You can also link cube views to support a more focused, granular analysis. See:

• Build a Simple Cube View

• Member Filter Builder

• Cube View Performance

• Link Cube Views

• Analyze Data Using Passed Point of View Selections

Build a Simple Cube View

A cube view can query and submit data into a cube. They are flexible in how they present data, but this section focuses on how to build a simple cube view.

Cube View Properties

Use the following features to manage cube views. In OneStream, go to Application > Presentation > Cube Views to access the Cube Views page. Then, under Cube View Groups, expand a cube view group, and select a cube view to access these properties.

• Designer and Advanced: Each tab has the same properties, but they are organized differently. You can use either tab.

• POV: Make selections for the cube and all dimensions used in the cube view. You do not need to make selections for any dimensions used in rows or columns. Dimensions can also be selected in the Cube POV.

• General Settings: Apply row and column templates, control common settings, configure headings and formatting, and set navigation links using bound parameters.

• Report Header: Control what displays in the header when a cube view is run as a data explorer report (PDF style).

• Rows and Columns: Determine the content for the rows and columns.

• Member Filters: Select the dimension members, parameters, variables, expansions, expressions, and business rules.

• Formatting: Set the header and cell formatting for the selected row or column or for the default cell for the entire cube view.

• Report Footer: Control what displays in the footer when a cube view is run as a data explorer report (PDF style).

Cube View Toolbar

Use the following toolbar items to manage cube views.

Create Group: Organize cube views.

Create Profile: Organize cube view groups.

Manage Profile Members: Assign cube view groups to cube view profiles.

Create Cube View: Create a new cube view in a cube view group.

Delete Selected Item: Delete a selected item, such as a cube view or cube view group.

Rename Selected Item: Rename a selected item.

Cancel All Changes Since Last Save: Cancel unsaved changes.

Save: Save changes.

Copy Selected Cube View: Copy the selected cube view to use it as a template for another cube view.

Search: Search for cube views.

Open Data Explorer: Run a cube view and see it in a data explorer report.

Show Objects That Reference The Selected Item: View other areas where the selected item is used. For example, see where a cube view is being used in an application to know the impact of a change. This icon is available on other pages as well.

Object Lookup: Find and select an object to copy.

Manage Rows and Columns

Access these additional items on the Advanced tab and the Rows and Columns slider to manage rows and columns.

Add Row or Column: Add rows or columns to a cube view.

Move Up: Move rows or columns up.

Move Down: Move rows or columns down.

Remove Selected Row or Column: Remove a row or column.

Create Cube View Groups and Profiles

Groups organize the artifacts that users are building. Cube views are organized into cube view groups. A cube view group needs to be created before a cube view, and it can include one or more cube views. Profiles further structure the artifacts and enable them to be used in other places in the application and accessed by users. Cube view groups are organized into cube view profiles that are assigned to different areas of the application, such as a workflow profile. Cube view profiles can include one or more cube view groups.

1. On the Cube Views page, click Create Group.

2. Type a name for the new group.

3. Click Save.

4. Click Create Profile.

5. Type a name for the new profile.

   TIP: Use the Visibility drop-down menu to specify where cube views can be viewed in the application. The default is Always, which displays the cube views in all listed locations. If you select a specific location, the cube views will display in that location. If you select Never, the cube views will only display in the Cube Views page in the Application tab.

6. Click Save.

Cube View Group Properties

Cube view group properties apply to general and security settings.

General (Cube View Group)

Name

The name of the cube view group.

Description

A short description of how the group is used, or what it contains.

Workspace

The currently selected workspace.

Maintenance Unit

The currently selected maintenance unit.

Security

Access

Members of this group can access the cube views in the cube biew group.

Maintenance

Members of this group have the authority to maintain the cube views in the cube view group.

NOTE: Click and begin typing the name of the security group in the blank field.  As the first few letters are typed, the groups are filtered making it easier to find and select the desired group.  Once the group is selected, click CTRL and double-click.  This will enter the correct name into the appropriate field.

Assign Cube View Groups to Cube View Profiles

Assign cube view groups to cube view profiles to control how the cube views in the group are accessed, using the visibility cube view profile property.

1. On the Cube Views page, under Cube View Profiles, select a profile.

2. Click Manage Profile Members.

3. Under Available Groups, select the group and then click the arrow to move it to the right.

4. Click OK.

NOTE: You can assign a cube view group to multiple cube view profiles.

Create a New Cube View

1. On the Cube Views page, under Cube View Groups, select a group.

2. Click Create Cube View.

3. Type a name and description for the cube view.

4. Click Save and specify General Settings.

Copy a Cube View

For efficiency, you can copy a cube view to use its formatting settings rather than creating a new cube view. A copy of a cube view is not linked to another cube view.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Click Copy Selected Cube View.

3. Select the cube view group from the drop-down menu.

4. Enter a unique name, not used by another cube view, and click OK.

Set the Cube View POV

Every cube view needs a POV setting to retrieve data. To query data in a cube view, set your Cube View POV, rows, and columns. The Cube View POV will set the cube and all of the dimensions used to query the various cells of the cube views.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Select the POV slider. Enter the information individually by typing in the fields or clicking the ellipsis for each member, or move the entire Cube POV.

   

   To move the entire Cube POV, on the POV Pane:

   1. Right-click Cube POV.

   2. Click Copy Cube POV.

   3. Right-click the light blue Point Of View header.

   4. Click Paste POV.

   TIP: To move an entire cube POV, you can also drag and drop the Cube POV from the POV pane into the Cube View POV.

   NOTE: The information in the POV slider takes priority over the information in the POV pane.

Create Cube View Rows and Columns

1. To set the cube view rows and columns, select the Rows and Columns slider. The preview grid for the new cube view displays default row and column names: Row1 and Col1. You can edit these names to make them more descriptive.

   

2. Click + to add rows or columns, and click - to remove rows or columns.

3. Select a row, column, or intersection in the preview grid, and then set the display options by using the settings tabs. The member filters, formatting, data suppression options, and overrides can be applied at the row and column level.

   

4. Click Save.

   NOTE: See Member Filter Builder.

Create a Cube View Using Shared Rows and Columns

An administrator can share all rows and columns or selected rows and columns from another cube view. Sharing is more efficient when building and managing cube views.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Go to General Settings > Sharing.

3. In the rows for the Row Sharing and Column Sharing, click in the fields to the right to access the drop-down menus. Select the option to share all or specified rows or columns.

   • All Rows/Columns: Enter the source cube view name of the rows and columns to be shared.

   • Specified Rows/Columns: Reference a single row or column from the source cube view when designing rows and columns.

   TIP: You can share rows and columns from two cube views. If you share rows or columns with another cube view, updates are automatically linked. This can make building a cube view more efficient.

4. If you selected the option to share all rows or columns, click the ellipsis and then select the cube view. Click OK to confirm.

   

5. Click Save.

Use a Cube View Template

Creating and using cube views as templates can increase efficiency and consistency for cube views that have similar formatting and properties for the rows and columns. If you plan to use templates, create a cube view group specifically for this purpose. For example, create a cube view group with the name template (Templates_Columns or Templates_Rows) and save cube views to use as templates in this cube view group. Then, other users can find and use the templates.

1. On the Cube Views page, under Cube View Groups, select a cube view to use as a template.

2. Click Copy Selected Cube View.

3. Select the cube view group from the drop-down menu and type a name for the new cube view.

4. Click OK.

   NOTE: Each cube view must have a unique name.

Cube View Shortcuts

Use Cube View shortcuts to launch other cube views. This is helpful when an administrator wants to use the same cube view but does not want to use the same parameters.

For example, a user can launch a cube view for an Income Statement and be prompted with a ParamView parameter. The ParamView has two values of YTD or Periodic, meaning an Income Statement can be launched to show the data with a Year to Date view or a Periodic view (such as Month to Date).

In this case, a shortcut can be used for save two versions of the same report without prompting the user or having to maintain two cube views. In each case, the shortcut cube view Name would be the same (such as Income Statement), but the literal parameter value would be different. The YTD version would be ParamView = [YTD] and the Periodic version would be ParamView = [Periodic]. Each would open the Income Statement cube view to the proper view settings without prompting the user.

Member Filter Builder

The Member Filter Builder dialog box makes it simple to build complex member filters without having to remember or look up the proper syntax.

On the Cube Views page, select a cube view. Select Rows and Columns and then select a row or column header. Click the Member Filters tab and then Member Filter Builder to launch the dialog box.

Navigation

Hover over the items in the Member Filter Builder dialog box for additional information.

1. Member Filter: Location where the member filter is built. Type in this section or use the other items in the dialog box to enter information into the field.

2. Dimension Tokens: There is a button for each dimension that launches the appropriate selection dialog box.

3. Member Expansion Functions: Double-click a member expansion to add it to the member filter.

4. Member Expansion Where Clause: If you select Member Expansion Where, use the where clause properties to complete the expression.
   Example: UD2#AllProducts.Children.Where(Name Contains Clubs)

5. Time Functions: Only applies to the Time dimension, such as T#POVPrior1. Double-click a time function to add it.

6. Substitution Variables: Double-click a system-wide substitution variable to add it.

7. Samples: Refer to this tab for example syntax for complex queries and calculations, including how to build member expansions, where clause expressions, time expressions, calculations (GetDataCell and column/row expressions), custom member list expressions, and XFBR, XFCell, and XFGetMemberProperty.

8. Expansion: Commonly used member expansions added to the end of filters. Double-click the expansion to add it.

9. Workflow: Commonly used workflow member expansions used in cube views that point to a report, form, or dashboard and are affiliated with a specific workflow profile.

10. Other: Commonly used member filter functions that enable you to create calculated rows and columns or use a custom parameter to store member lists.

Member Expansion Tab

To reduce cube view maintenance, use simple member expansions and connect your cube views to the metadata when complex expansions are needed. Avoid referencing individual members.

• Reverse order expansions: These selections include ChildrenInclusiveR, TreeDescendantsR, and TreeDescendantsInclusiveR.

• Where clauses: Enable further qualification of the results and can pull members based on properties such as "name contains" or text properties.

• Remove functions: Removes some of the members from the results.

• Parents: Returns the direct parent of the member. There may be multiple parents if there are alternate hierarchies.

• Ancestors: Returns all members up the chain from the original member.

• Options: Advanced option if you are a report builder familiar with the extensibility design in your application. This expansion is commonly used to focus on one portion of your extensible dimensionality.

This is not an exhaustive list of all the member expansions. Each expansion can also be found in the Samples tab. Hover over each to see the purpose and a sample of the expected syntax. Double-click the member expansion to place the sample syntax in the Member Filter field.

Use the member filter to filter data by creating a list of restricted members. Member filters can contain multiple member scripts. A member script queries a defined set of dimensional members. Members can be specified for any or all dimensions and the primary dimension can also specify a member expansion formula (for example, Descendants).

For example, a simple member script that returns the year 2022: T#2022.

For example, a member script with a member expansion that returns all the income statement accounts: A#[Income Statement].Descendants.

If one or a few dimensions in the member script have a dimension token, the remaining dimensions are pulled from the Cube View POV, the Global POV, or Workflow, Time, and Scenario. Separate each dimension that has a token in the member script with a colon as in the following example:

Cb#GolfStream:E#Houston:P#Texas:C#Local:S#Budget:T#2022M3:V#YTD:A#60000:F#None:
O#Forms:IC#None: U1#Sales: U2#HybridXL: U3#Northeast: U4#SportsCo: U5#None: U6#None: U7#None: U8#None

For example, a member filter that contains three different member scripts that returns the Actual, Budget, and Forecast scenarios: S#Actual, S#Budget, S#Forecast.

Time Functions Tab

Time is a fixed dimension and is based on the time dimension type associated with the application. OneStream software has custom time dimensions (for example, weekly and monthly), which affect time functions and expansions. Time functions pivot the member, and time expansions extend the member.

• Time function example to display the prior period of the time member in a Cube POV: T#POVPrior1

• Time expansion example to display all months in the year 2022: T#2022.Months

Add a time function from the Time Functions tab:

1. In the Member Filter Builder dialog box, click the Time Functions tab.

2. Select the type of time function to display the examples available: POV, WF, Global, or General. You can also select All.

3. Double-click a function to populate it in the Member Filter field.

   NOTE: Click the Samples tab to view more time functions.

The following time function example demonstrates a style of syntax that provides flexibility. You can choose from a variety of time functions, but this one enables you to pivot easily on the year and period separately:

T#YearPrior1(|PovTime|)PeriodNext1 (|PovTime|)

• Prior year from the POV time: T#YearPrior1(|PovTime|)

• Next period from the POV time: PeriodNext1 (|PovTime|)

Variables Tab

Substitution variables are short scripts that use pipe characters to include a predefined substitution variable. For example, |WFProfile| would refresh to display the current workflow profile name. They come with every installation of OneStream and cannot be edited, so you do not need to create or maintain them.

Substitution variables can be used throughout the application. For cube views, you can use them for:

• Headers and footers

• Rows and columns

• Cube view page captions

Substitution variables are always referenced with pipes (for example, |POVTime|). The Member Filter Builder dialog box includes substitution variables in the following categories:

• POV (Cube POV)

• WF (Workflow POV)

• Global (Global POV)

• CV (Cube View POV)

• MF (Member Filter)

• General (items not related to a POV)

When using a substitution variable to return a member name, the prefix indicates where the value of the variable is pulled from. Choose if it should refresh based on the Cube View POV (CV), Workflow POV (WF), Cube POV (POV), Member Filter (MF), or Global POV (Global).

Choose if you want to display the member description (usually in headers and footers) by adding Desc as the suffix. Time has an added short description option that is set through the time profiles. For example, |WFTimeDesc| returns the description Feb 2022, and |WFTimeShortDesc| returns the short description Feb.

Common substitution variables:

• Username that ran the report: |UserName|

• Cube view name: |CVName|

• Members text properties: |Text1|

• Today's date: |DateDDMMYYYY|

On the Variables tab, you can double-click a substitution variable to add it to a member filter. You can also copy a substitution variable from the Object Lookup dialog box:

1. On the Cube Views page, click Object Lookup to open the dialog box.

2. Under Object Type, select Substitution Variables.

3. Select a substitution variable from the list. Use the Filter field to find a specific option.

4. Click Copy to Clipboard and then paste the substitution variable where needed.

Samples Tab

The Samples tab holds example syntax for more complex queries and calculations in the following categories:

• Member Expansions

• Where Clause Expressions

• Time Expressions

• Calculations (GetDataCell Expressions and Column/Row Expressions)

• Custom Member List Expressions

• XFBR, XFCell, and XFGetMemberProperty

Add an expression from the Samples tab:

1. In the Member Filter Builder dialog box, click the Samples tab.

2. Double-click a sample to populate it in the Member Filter field.

Where Clauses

Where clauses are commonly used in reporting to create a more flexible query. The where clause can pull members based on properties:

• Text properties

• Portions of the description or name (for example, starts with or contains)

• Security

• Account types (account dimension only)

• Intercompany (entity and account dimension only)

• Specific currency (entity dimension only)

• In use property

• Has children

  NOTE: Where(HasChildren = True) can only be used for the dimensions assigned to the cube on the default Scenario Type.

• Has a member formula

NOTE: Click the Samples tab to view common where clauses.

Add a where clause from the Samples tab:

1. In the Member Filter Builder dialog box, click the Samples tab.

2. Expand the Where Clause Expressions list.

3. Double-click a sample to populate it in the Member Filter field.

Cube View Performance

Cube view performance includes the following information:

• Database Sparsity

• Row and Column Suppression

• Suppressed Members

• Sparse Row Suppression

• Cube View Paging

Database Sparsity

Sparsity is the ratio of data record volumes in the cube compared to the dimensions modeled in the cube. We see sparsity when the data unit (combination of cube, entity, parent, consolidation, scenario, and time) has sparsely populated data intersections across the account-type dimensions (account, intercompany, flow, and user-defined). The absence of data records can affect reporting performance because it is difficult to render reports if data is sparse.

Avoid sparsity in your application design when possible. Use analytic blend, extensibility, or other design frameworks to ensure the Dimension Library is designed for your reporting structure and to minimize sparsity. However, even with an optimal design, sparsity can still occur if a large report pulls in a lot of dimensions. Suppression settings can help improve reporting performance if this is the case.

Row and Column Suppression

Use row and column suppression in larger reports to make them easier to read while still enabling the report builder to create a low maintenance report based on the metadata design.

To adjust the suppression settings:

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Select Rows and Columns to expand the slider.

3. Select the row or column and then click the Data tab. The following settings are available.

• Suppress Invalid Rows/Columns: Set to True to suppress any invalid cells.

• Suppress NoData Rows/Columns: Set to True to suppress any cells without data. When data entry is required, the recommended setting is False.

• Suppress Zero Rows/Columns: Set to True to suppress any cells containing zeros.

• Use Suppression Settings on Parent Rows/Columns: This property relates to the prior properties and controls whether the parent members in this member filter use the same settings.

• Zero Suppression Threshold: When Suppress Zero Rows/Columns is set to True, enter a value to suppress all numbers below it. All numbers below the specified number are recognized as zeros. For example, entering 499.99 results in every number lower than that value being recognized as zero and therefore suppressed.

• Allow Insert Suppressed Member (rows only): Use this setting to access a member currently suppressed for data entry purposes. You can only use this with cube views and form templates.

  • All: Enables visibility to all cube view row expansions

  • False: All row expansions remain suppressed

  • Nested: Enables visibility of the row expansions two through four

  • Innermost: Enables visibility of the row expansion that is at the bottom level

• User To Determine Row Suppression (columns only): Set to True to improve performance on large cube views by enabling the designer to better define how to apply row suppression.

• Allow Sparse Row Suppression (columns only): Provides performance improvements for cube views that use multiple nested row dimensions and works in conjunction with a General Settings property. When set to True, sparse row suppression is applied to the entire cube view. It can be turned on and off for specific columns.

Suppressed Members

This section includes instructions for how to manage suppressed members.

Apply Modify Suppression Property

With this setting, you can choose whether rows are suppressed from the data explorer grid. This feature is useful for a small cube view that will not generate a large number of additional rows if the suppression is turned off.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Go to General Settings > Common.

3. Under Restrictions, set the Can Modify Suppression property to True.

4. Click Save.

Modify Suppression

To modify suppression, you must first apply the correct property. See Apply Modify Suppression Property.

1. Open a cube view in Data Explorer view.

2. Select the Row Suppression drop-down menu.

   

3. Choose the option to apply.

   • Use Default Row Suppression: Apply the cube view suppression settings.

   • Suppress Rows: Suppress any rows with zeros or no data regardless of the cube view settings.

   • Unsuppress Rows: Unsuppress all rows that were suppressed with zeros, no data, or invalid data regardless of the cube view settings.

Apply Property to Allow Insert Suppressed Members

You can insert suppressed members so that their data is entered in the cube view.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Go to Rows and Columns > Data > Suppression and confirm that Allow Insert Suppressed Member is set to All.

   NOTE: The Allow Insert Suppressed Member option is only available for rows.

3. Click Save.

Insert Suppressed Members

To insert suppressed members, you must first apply the correct property. See Apply Property to Allow Insert Suppressed Members.

1. Open a cube view in Data Explorer view.

2. Right-click in the account or entity.

3. Click Insert Suppressed Member.

4. To the right of the account or entity field, click Select Member.

5. Select an item and click the arrow to add it to the Result List.

6. Click OK and then click OK to confirm.

7. Enter data as needed in the white cells.

8. Click Save and then click OK.

Sparse Row Suppression

Designs for analytic reports typically have multiple dimensions nested in rows. The combination of members generated from the nested expansions can easily result in billions of potential expanded rows, many of which may not have data. In these designs, standard row and column suppression (invalid, no data, or zero) in the cube view would still require each of those billion rows to be inspected individually for data. So, we recommend sparse row suppression be enabled to enhance the performance of a large cube view when, due to widespread database sparsity, the report is likely to return many records without data and take a long time to run. Sparse row suppression evaluates the data records of the cube view intersections and filters records with no data (not zeros) before rendering the cube view.

IMPORTANT: Sparse row suppression cannot be applied to dynamically calculated data through dynamically calculated members and cube view math. Avoid errors by correctly applying the settings on the dynamically calculated columns.

NOTE: When sparse row suppression is applied, OneStream assesses all row data before displaying the cube view. Cells containing dynamic calculations are populated on-the-fly. When OneStream assesses the rows of data, the rows containing dynamically calculated data are omitted from the cube view because the data is not saved in the database.

To enable sparse row suppression in cube views:

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Go to General Settings > Common.

3. Under Suppression, set Allow Sparse Row Suppression to True.

4. Select Rows and Columns to expand the slider. Select the row and then the Data tab.

5. Ensure the additional row suppression properties you will use are also set to True.

   NOTE: Any row assigned a suppression setting will be enabled for sparse row suppression. If no suppression is applied, sparse row suppression will not be applied.

6. In the Rows and Columns slider, select the column and then the Data tab.

7. Under Suppression, set Allow Sparse Row Suppression to True.

8. Ensure the additional column suppression properties you will use are also set to True.

   NOTE: If columns contain dynamically calculated data, set Use to Determine Row Suppression and Allow Sparse Row Suppression to True to avoid an error.

Cube View Paging

Cube view paging is only applied to the data explorer view of a cube view and is used to enhance the performance of cube views containing more than 10,000 unsuppressed rows. The cube view will attempt to return up to 2000 unsuppressed rows within a maximum processing time of 20 seconds. The purpose of paging is to protect the server from large cube views that could affect application performance.

Evaluations are performed on the potential size of the rows and the processing requirements to determine if paging is enabled and the number of rows returned.

• Evaluation 1 – Enable Paging: An evaluation is performed on the entire cube view to determine the total number of possible unsuppressed rows that will be generated. If the total number of potential unsuppressed rows is less than 10,000, no paging will be enabled.

• Evaluation 2 – Paging Enabled: If the total number of unsuppressed rows is greater than or equal to 10,000, paging is enabled.

• Evaluation 3 – Paging: Once paging begins, the cube view evaluates the rows attempting to return a minimum of 20 to a maximum of 2000 unsuppressed rows. In the case of nested dimensions on rows, the evaluation starts on the left most dimension expansion, as defined in the cube view. After a maximum processing time of 20 seconds, the first page of the cube view will be returned for display containing only the rows that completed processing during the time constraint. For this reason, cube view pages are not a fixed number of rows. The rows are ultimately determined by their time to process. This also relates directly to the percentage display, because each page is generated by processing time requirements, and the last page is not known while the cube view is running. Therefore, this percentage is not intended to be a precise measurement.

When a row is defined with nested dimensions, the paging evaluation is performed on the left most dimension. For each expansion of the left most dimension, the paging will not progress to the next sibling until all the records are returned by all the other dimension expansions to be completed.

To set the properties, on the Cube Views page, under Cube View Groups, select a cube view. Go to General Settings > Common. The following settings are available.

• Max Unsuppressed Rows Per Page: Determines how many rows are written before the cube view starts paging (default is -1). The maximum value is 100,000.

• Max Seconds To Process: Determines how many seconds the cube view processes before it starts paging (default is -1). The maximum value is 600 seconds.

See Cube View Paging for more information on how to cancel a long-running cube view through Task Activity.

Advanced Cube Views

There are several advanced uses with cube views such as setting them to change by Point of View or Workflow. Using advanced settings let you create and maintain fewer cube views.

With Workflow

Set the POV, rows, and columns in the cube view so it is driven by the Workflow POV and the entities assigned to the workflow profile in use. By doing this, you can make forms, dashboards, cube views, and reports driven dynamically by the workflow profile.

Workflow Entities

Using an expression such as E#Root.WFProfileEntities from within the Rows or Columns Tab shows the entity or entities assigned to that particular Workflow Profile at run time.  WFProfileEntities or similar expressions cannot be assigned to the POV because there can be more than one and the POV only requires a single member.

Workflow Scenario

Under the cube view Point of View Slider, select the WF Member for the Scenario dimension, or use WFScenario|, or a similar Substitution Variable in Rows and Columns.

Workflow Time

Under the cube view Point of View Slider, select the WF Member for the Time dimension, or use WFTime|, or a similar Substitution Variable in Rows and Columns.

With Dashboard and Form Parameters

When using dashboards and forms, use parameters to focus the data to what is needed. For example, when a Dashboard is launched, it can prompt for the specific entity or region needed. See Parameter Guides for details.

Within the cube view, refer to parameters in the Point of View and Rows and Columns Slider to restrict the query to just the data expected. Surround the parameter name in pipes and exclamation points (for example, |!ParameterName!|).

The following image shows an example of using the entity and region parameters in the cube view’s Point of View:

TIP: Use dashboard parameters as a single repository for parameters that are used in dashboards or forms. If a parameter is referred to within a cube view (for example, |!ParameterName!|) and there is not a parameter by that name associated with the form, it will search through the application’s dashboard parameters for one with that name and use it.

Changing Member Display Name

Change the name returned with a member script in a cube view by adding :Name(“enter name here”) at the end of the member filter. The double quotes around the Name() value are optional.

For example

A#60999:Name(“Net Sales”) or A#60999:Name(Net Sales)

Format a Cube View

This section includes the following information to format a cube view:

• Overview

• Basic Formatting

• Rename Rows and Columns

• Create Conditional Formatting

• General Settings

• Format a Report Page

Overview

Formatting settings and overrides combine to create the cell format. You can apply formatting and isolate it to nested expansion levels on rows or columns by using property filters found in the conditional formatting dialog box.

Apply property filters in this order:

1. Application properties standard report settings

2. Cube view default settings

3. Column settings

4. Row settings

5. Column row overrides

6. Row column overrides

The primary output for a cube view is the data explorer grid. You can also export to Excel or use a report viewer.

Basic Formatting

Cube view formatting controls how cube views display. Most of the format settings transfer to Excel and can still be overridden with the standard Excel styles. The formatting also transfers to reports where the cube view is being used in a data adapter.

Cube view formatting can be selected for the entire cube view or specific rows, columns, headers, and individual cells. The formatting options enable the number formats, percentage signs, scaling, currency symbols, colors, fonts, and font size to be unique to the business needs. Label row and column sets to support cube view maintenance when editing, formatting, and applying calculations.

In the cube view, select the Rows and Columns slider. Then click an individual cell or header and then the Formatting tab to view and edit the toolbar options for data explorer, Excel, and report formats. The icons in the toolbar include the most common formatting properties. Each icon coincides with the cell selected in the Rows and Columns slider. For example, if a column header is selected, the formatting changes made will only affect the specific column header.

1. Selector

2. Data explorer formatting options

3. Excel export formatting options

4. Report formatting options

5. Advanced formatting options

6. Formatting tab

Set Up Basic Formatting for a Cube View

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Select Rows and Columns to expand the slider.

3. Select the row, column, or cell to edit.

   NOTE: Click the Default cell to update the default settings for all headers and cells.

4. Click the Formatting tab.

5. Select the options to change the header and cell format settings for the data explorer, Excel, and report output types.

Data Explorer

The formatting settings available are organized in the following groups.

• Text: Font, color, size, bold, and italic settings. When you select a cell, the following formatting properties become available in the Text drop-down menu: number, zero offset, scale, flip sign, show percent sign, and show currency.

• Border: Background color and gridline color

• Column: Whether the column is visible and its width

There are different settings available for the headers and cells.

Excel

The formatting settings available are organized in the following groups.

• Text: Color, horizontal alignment, vertical alignment, indent level, and wrap settings. When you select a cell, the following formatting properties become available in the Text drop-down menu: number and use scale.

• Border: Background color and the color and line styles of the cell borders

• Column: Column width

There are different settings available for the headers and cells.

Report

The formatting settings available are organized in the following groups.

• Text: Color, alignment, size, and underline settings. When you select a cell, the following formatting properties become available in the Text drop-down menu: no data number, use numeric binding, and numeric binding.

• Border: Background color and cell borders

• Lines: Settings for the top and bottom lines for the first row, padding, color, and thickness

• Column: Column width

There are different settings available for the headers and cells.

Apply Scaling, Indents, and Currencies

• Scale: Open the Data Explorer Text drop-down menu to view the Scale setting. You can also apply it to Excel and report formatting.

  

• Indent level: On the Formatting tab for a row or column header, view the Indent Level setting.

  

• Show currency: Open the Data Explorer Text drop-down menu to view the Show Currency setting.

  

Header Format Details

The formatting properties for a cube view header include default, row, and column headers. These properties are in the Rows and Columns slider. Not all properties are available for each header.

1. In the Rows and Columns slider, select the Default cell to apply the formatting settings to all of the cube view headers.

   NOTE: You can select an individual row or column header instead if you want to edit the settings for a specific header.

2. In the Formatting tab, click the ellipsis to the right of Header Format.

3. Click Format to view the options. The Excel section only affects how the cube view data display in Excel.

• Custom Parameters: Click the ellipsis to select and assign a custom parameter such as a cube view style to the cube view header.

• RowExpansionMode: Control expansion of nested rows. This determines how rows are displayed in the data explorer grid. The default sets this property to False.

• ShowDimensionImages: Set to False to hide the dimension icons in the data explorer grid row and column headers. The default setting will display the dimension icons.

• HeaderWrapText: When False, column and row header text does not wrap. When set to True, column and row header text displays as wrapped. This applies to Default Cube Views and works with Header Overrides.

  NOTE: ColumnWidth and Row Header Width must be set from the Header Size settings menu for row header text to wrap

• IsColumnVisible: Set to False to hide specific columns. Set this property at run time with a parameter to show and hide detail.

• ColumnWidth: Enter a numerical value for column width. If the header label exceeds the column width, the header will automatically wrap the text.

• ColumnHeaderWrapText:False, column header text does not wrap. When set to True, column header text displays as wrapped. This applies to individual column headers and works with Header Overrides. ColumnWidth must be set for Column Headers to wrap.

  NOTE: ColumnWidth must be set for header text to wrap

• MergeAndCenterColumnHeaders: When set to False, column headers are left justified. When set to True, column headers are centered. This applies to Default Cube Views or individual column formatting in Data Explorer and Reports.

  NOTE: MergeAndCenterColumnHeaders does not apply to Header Overrides.

• IsRowVisible: Set to False to hide specific rows. Set this property at run time with a parameter to show and hide detail.

• TreeExpansionLevel1-4: Automatically expand up to 4 nested rows in Data Explorer. Enter the number of rows to be expanded from 0 – 4 in the corresponding TreeExpansionLevel.

  NOTE: For TreeExpansionLevel to work, RowExpansionMode from the Default Header must be set to "Use Default". Using Collapse All or Expand All overrides this setting.

  

  TreeExpansionLevels are tied to the Member Filter Dimension Types on the Designer tab and require a .Tree Member Expansion.

  

  NOTE: Default settings are overwritten by Row Overrides when set.

  Set the TreeExpansionLevel to 0 to collapse all nested rows.

  

  

  Set the TreeExpansionLevel to 1 to expand the first level of nested rows.

  

  

  Set the TreeExpansionLevel to 2 to expand the first two levels of nested rows.

  

  

  Set the TreeExpansionLevel to 3 to expand the first 3 levels of nested rows.

  

  

  This example shows the TreeExpansionLevel 1, 2, and 3 expanded:

  

  

• RowHeaderWrapText: When False, row header text does not wrap. When set to True, row header text displays as wrapped. This applies to individual row headers and works with Header Overrides.

  NOTE: Row Header Width must be set from the Header Size settings menu for row header text to wrap.

• Font and color options are available. For the FontFamily, any .Net font installed on the Excel client operating system is included in the font family. The FontSize default is 11.

• ExcelMaxOutlineLevelOnRows and ExcelMaxOutlineLevelOnCols: Up to six outline levels can be used for the creation of collapsible and expandable Excel groups of rows or columns when exporting. Enter the number of outline levels needed. This relates to the Excel Indent Level setting that is applied in the header format on each row or column, so the number entered here should equal the highest setting applied on the rows or columns.

• ExcelExpandedOutlineLevelOnRows and ExcelExpandedOutlineLevelOnCols: When a cube view is exported to Excel, these settings control to which outline level the file is initially opened. The default is 1, which means each grouping is fully collapsed.

• ExcelColumnWidth: Default Excel column width in pixels unless overridden in columns.

• ExcelOutlineLevelCol and ExcelOutlineLevel: Default Excel outline level for rows and columns is 1 unless specified here or overridden in rows or columns.

• ExcelHorizontalAlignment and ExcelVerticalAlignment: Control how the data will be aligned horizontally and vertically using the Excel standard alignment options.

• ExcelIndentLevel: The number of characters to indent the text or value.

• ExcelWrapText: This determines if text like headers will be wrapped in the output.

• Color and border options are available.

• ReportSeparateBandPerCubeViewRow: This is a setting to optimize performance for large cube views that will be dynamically generating a data explorer report with many row definitions with unique formatting. Default setting is (Use Default), which is a conditional setting. This applies to when a data explorer report is run from a cube view and background temporary database tables in memory, one for each row name in the cube view are created. If there are more than 100 row definitions, fewer report bands (separate temporary in-memory tables) are created, combining rows where formatting is the same. Set to True to create a separate table per cube view row definition, which may affect performance with hundreds or thousands of row definitions. Set to False to combine row definitions of the same format into fewer temporary in-memory tables.

• Page and column header and table layout options are available.

• ReportColumnWidth and ReportRowHeight: Sets the width of a column or the height of a row by number of pixels.

• ReportTopLinesOnFirstRowOnly and ReportBottomLinesOnLastRowOnly: If the row definition results in multiple rows, a top line will be placed on the first line only or a bottom line will be placed on the last line only.

• ReportBandHeightBeforeFirstRow and ReportBandHeightAfterLastRow: Allows a number to be entered in pixels to add before the first row or after the last row of where a row definition starts.

  NOTE: The top and bottom report bands used for lines and spacing are removed if there are no data rows or for suppressed rows.

• ReportRowPageBreak: Applies a page break where appropriate for this row.

• ReportRowContentTop: Specifies the vertical position of the row relative to the row above it. If it is set to zero, the top of the row immediately follows the row above it with no vertical spacing.

• ReportRowContentHeight: The height of the row in pixels.

• ReportRowPaddingTop and ReportRowPaddingBottom: Control the extra space (padding) above and below a row in a report.

• ReportFontSize: The point size of the font on the report if it differs from the font size displayed in data explorer.

• ReportTextAllignment: Controls how the data are aligned in a report.

• ReportUnderline: Creates a simple underline of report values.

• Color options are available for text and background.

• Top Lines and Bottom Lines: Used for underlines and overlines. The Line1 and Line2 options can be used together to create a double underline or double overline. For the lines to have a small gap between each column, use the ReportBottomLine1PaddingLeft property or one similar.

• Borders: Allows a line to be drawn around the border of a cell.

Cell Format Details

The format properties for a cell include font, colors, background, and grid lines.

1. In the Rows and Columns slider, select the Default cell to apply the formatting settings to all of the cube view cells.

   NOTE: You can select an individual cell instead if you want to edit the settings for a specific cell.

2. In the Formatting tab, click the ellipsis to the right of Cell Format.

3. Click Format to view the options. The Excel section only affects how the cube view data display in Excel.

• Custom Parameters: Click the ellipsis to select and assign a custom parameter such as a cube view style to the cube view cell.

• NumberFormat: Uses the Microsoft .NET standard number format syntax, which allows different formats to be specified for positive and negative numbers separated by a semi-colon (not available in Excel). For example:

  • #,### ;(#,###);0 would show the number using a comma as the thousands separator, no degrees of precision, parenthesis around negative numbers, and a zero for null values. The pattern of this format choice is Positive;Negative;Null values with each separated by a semicolon. After the first #,### there is a space. This enables the numbers to line up with negative numbers due to the parenthesis.

  • #,###.#% ;(#,###.#%);” – “ would show a percentage with a comma as the thousands separator, one degree of precision, negative percentages in parenthesis and a dash for null values.

  • N2 would show the data as a numeric value with two degrees of precision. Negative numbers are presented with a minus sign.

  • P1 would show a percentage with one degree of precision.

• ZeroOffsetForFormatting: Related to NegativeTextColor, which is determined by whether a number is less than zero. For example, if sales were less than 100, rather than 0, they could be displayed in red. A valid setting is any number other than zero.

• Scale: -12 to +12 are the valid values for the scale. For example, to show a number in thousands, the scale should equal 3, or for millions, the scale should equal 6.

• FlipSign: This will flip the display value between positive and negative. This is useful for reports where certain expense numbers are stored as positive or negative and need to be shown on the report.

• ShowPercentageSign: Determines whether a percentage sign is displayed.

• ShowCurrency: Shows the currency code (for example, EUR). This is not available in Excel.

• Font and color options are available. For the FontFamily, any .Net font installed on the Excel client operating system is included in the font family. The FontSize default is 11. NegativeTextColor, WritableBackgroundColor, and SelectedGridLinesColor can optionally override the format for negative numbers, writeable data cells, and selected data cells.

• ExcelNumberFormat: Apply to control how numbers display when exporting to Excel. A number format can have up to four sections of code separated by semicolons. These code sections define the format for positive numbers, negative numbers, zero values, and text, in that order.

  <POSITIVE>;<NEGATIVE>;<ZERO>;<TEXT>

  For example, use these code sections to create the following custom format. Note that this format can include the underscore to create a space after the trailing positive number and can control the color of the negative number to be red:

  #,##0.00_);[Red](#,##0.00);0.00

  NOTE: ExcelNumberFormat settings [#,##0,,.0 ;[Red](#,##0,,.0)] on a cube view scales numbers when the cube view is exported to Excel.

• ExcelUseScale: Determines if Excel uses the scale property.

• Alignment, color, and border options are available.

• ReportNoDataNumberFormat: By default, NoData (null) cells display as empty in the data explorer and as zeros in a report. However, any .NET number format text can be specified to format those zero values differently in the report. For example, type NODATA in that setting. To display empty text, type # in that setting. If the number format setting of the cell already does something with null values, this property does not need to be filled.

• ReportUseNumericBinding and ReportNumericBindingFormat: These are related to the export of dashboard reports to Excel, so numbers can be rendered in the proper number format rather than appear in Excel as text. Set ReportUseNumericBinding to True to use numeric amounts instead of OneStream text-based formatting when generating a cube view report. The ReportNumericBindingFormat setting must follow a specific syntax. This number format is related to the report engine, so Excel standard number formats are not used. For example, to represent a number format for positive, negative, and no values:

  {0:#,# ;(#,#);" - "}

  This feature provides the ability to generate numbers instead of text when exporting a dashboard report to Excel. However, it cannot be used for calculation status and annotation data cells because those features cannot be represented as numbers. In those cases, use column overrides to display the values as text.

• Position, font, color, top lines, bottom lines, and borders are available. See Header Format Details.

Member Filters

In a cube view, you can nest up to four different dimensions as rows and two different dimensions as columns.

NOTE: When nesting cube view columns, if the top column header is longer, it will span the nested column headers when displayed on a cube view report.

Dimension Type: Select a dimension type from the drop-down list. Indicates which dimension type will display on the selected row or column.

Member Filter: Enter a member filter to express the specific members needed from the dimension.

User Defined Description – Cube View: In the Cube View Editor, the custom user-defined descriptions will display in the Designer and Advanced tabs, in the Member Filters dimension type:

In the Advanced tab, Row and Column dimension type:

Data

Can Modify Data: If False, specific rows or columns are read-only. If True, the False setting will override it. However, if Can Modify Data is False, the entire cube view is read-only and this setting will not override if True.

Text Box: Makes the cube view cell numerical. Only numerical values can be entered in the data cell at run time. This is the default setting.

Combo Box: Select this when a List Parameter is used in a cube view data cell. Enter the name of the List Parameter in the property below.

Date: Enables a calendar in the cube view cell and allows you to select a specific date in the data cell. 

Date Time: Enables a calendar and a time display and allows you to select a specific date and time in a data cell.

NOTE: Selecting Now in the calendar enters the current date or current date and time.

List Parameter: Enter a parameter to create a drop-down list of choices in a cube view data cell. 

Enable Report Navigation Link (Rows Only): Set to True to enable Navigation Link Drill Downs in dashboards. Enter a value in the Dashboard to Open in Dialog field. Set to False if this function is not used for the cube view. See Navigation Links. 

Dashboard to Open in Dialog (Rows Only): Name of the dashboard or parameter used for the Report Navigation Link. Use a parameter for a cube view acting as a row template across multiple cube views.

Linked Cube Views: Enter a comma-separated list of cube views that will be available to open when viewing a cube view in the Data Explorer Grid. The cube views specified in this field apply to the selected row or column and are available when you right-click on any data cell in the specified row/column. 

NOTE: Row settings override column settings which override cube view settings.

Rename Rows and Columns

By default, a cube view has standard headers to represent rows and columns. All the header settings control the row and column headers presented when the cube view is run if the default is not used. See General Settings.

If the header name for a row or column must be different than the dimension name or description, use the rename function. The rename function is an expansion of the end of a member filter that enables you to enter what you want displayed. For example, A#CashBalance:Name(Cash Balance) will display Cash Balance as its header.

Another way to use the rename function is to include the XFMemberProperty, which returns member properties. For example:

A#6009.base:Name(XFMemberProperty(DimType=Account, Member=|MFAccount|, Property=AccountType))

1. Use the rename function to pull in the member property: Name(XFMemberProperty

2. Define the dimension type: (DimType=Account,

3. Determine what will be in the member filter: Member=|MFAccount|,

4. Pull in the property: Property=AccountType))

Create Conditional Formatting

Conditional formatting provides the ability to format headers or cells based on defined criteria. Conditional formatting in cube views supports data analysis by highlighting cells or ranges of cells, identifying key values, and using data bars, color scales, and icon sets that correspond to specific variations in the data. Conditional formatting is applied and visible in data explorer, Excel, and report views. The conditional formatting criteria are applied to cube view rows or columns on the formatting property within the cube view editor.

Conditional formatting is available on the formatting elements of a cube view.

• Cube view default formatting

• Row and column headers

• Row and column data cells

• Row and column overrides

Conditional formatting follows the cube view processing order of operations:

1. Number format as defined in application properties

2. Cube view default

3. Column formatting

4. Row formatting

5. Column overrides

6. Row overrides

The combination of formats and overrides equals the format for the cell when rendered. Formatting can be applied and isolated to the nested expansion levels on rows and columns by using property filters in the dialog box. This feature is a cube view formatting option.

NOTE: If there are any existing formats before applying conditional formatting, they will be retained if the range of cells containing the conditional formats does not meet the conditions of the rule. All styles from the cube view and the selection styles that had been applied to that range are overridden by conditional formatting.

Conditional Formatting Properties

General and conditional formatting can be applied in the Header Format and Cell Format dialog boxes. The Condition and Format buttons launch additional dialog boxes with available options. The dialog box for conditional formatting is divided into sections.

1. Conditional statement: Defines the options for conditional statements to apply constraints to formatting.

2. Filter: Applies the criteria that pertain to your statement.

3. Operator: Contains criteria filters to use in your conditional statement.

4. Text/object: Find the text or object to be tested.

Header Property Filters

Expansion Specific Property Filters

Cell Format Property Filters

Define Properties for Conditional Formatting

Conditional formatting can be applied based on a data point. Cell formatting conditions can occur based on member names or descriptions, indent levels, row and column names, and expanded and even numbered rows.

Conditional formatting can also be applied based on members. The ability to format based on the name or description is enhanced by using a standardized metadata naming convention. Summary level members with keywords such as “Total” or prefixes or suffixes such as “Tot” could be used in conditional formatting. Members can be formatted using dynamic criteria, such as StartsWith or EndsWith. HeaderDisplayText differs from the MemberName and MemberDescription property filter because it references the custom name parameter in a member filter. Dynamic criteria can be applied to the name and description property filters to apply the required formatting.

1. On the Cube Views page, under Cube View Groups, select a cube view.

2. Select Rows and Columns to expand the slider.

3. Select a row or column.

4. Click the Formatting tab.

5. Click the ellipsis to launch the dialog box.

6. Click Condition, set the requirements, and then click OK.

7. Click Format, set the requirements, and then click OK.

8. Click Condition and then End If to close the condition.

9. Click OK twice.

Examples Applying Conditional Formatting

Below are common usage examples of conditional formatting.

Indent Level

The IndentLevel Property filter will dynamically format from defined rows or expansions. Indentation is zero-based.  The formatting can be applied to the default or to rows.  This solution can speed formatting for summary level dimension members.

Apply the formatting to the cube view's Header section or to specific rows.

Examples of Using Conditional Property Filters Conditional “Traffic-Lighting”

“Traffic-Lighting” is data related and therefore applied as a cell format.  The designer has a choice to apply the conditional formatting to either a row or a column. The order of operations for formatting can impact the decision.  Row overrides are the final layer of formatting applied to a cube view and would not be impacted by other more general formatting.

1. Conditional formatting can be applied to the rows or columns.  A definition applied to the row Formatting tab would apply to all columns.  A row override would isolate the formatting to a specified column(s). 

2. The CellAmount filter is used within multiple If/ElseIf statements to define the various tests required for the report.

ExpandedRowNum Expansion Range

Conditional formatting provides the ability to format an expanded range of data cells using the ExpandedRowNum Property Filter.  This is useful in formatting to support “Top 10” type reports.  This filter best supports cube view designs that use known expansions, such as ranking business rules or member lists. If applied to specific rows, the formatting applies to the defined row, but the Expansion Number Reference relates to the entire cube view.  Formatting defined on subsequent rows will be impacted if the expansion members change on previous rows.  The ExpandedRowNum Property

Filter can also be applied as a default cube view format, in which the definition will apply to all rows. This would require If/ElseIf type statements to support all rows.

1. Design or open a report which supports formatting for ExpandedRowNum , such as a ranking report in the example.

2. Determine how the formatting should be applied, as a default, row or column.  The example will use the cube view default formatting.

3. Cell format is applied for conditional formatting using the ExpandedRowNum filter.  Being zero-based, and having to account for each row and its expansions:

1. Condition1 – Rows < 6 is defined because the text header row “Top10Title” initiates the count at zero.

2. Condition2 – Rows > 11 and < 15 is defined because all the rows up to Row4, “SalesBottom10”, reflect rows 0-11 on the cube view.  The conditional row references must reflect all the cube view expansions.

Test for Row IsRowNumberEven

The IsRowNumberEven property filter may be useful to vary formatting by the even/odd numeric expansion of rows on a cube view.  For example, to replicate a “green-bar” style report the IsRowNumberEven would be a suitable filter. 

In this example the formatting can be applied to the cube view default cell format since it will globally apply to all rows. 

MemberName, MemberDescription or HeaderDisplayText

The ability to format based on the Name or Description is greatly enhanced by adhering to a standardized metadata naming convention.  Summary level members having keywords such as “Total” or prefixes or suffixes such as “Tot” could be used in conditional formatting. Members could be formatted using dynamic criteria, such as StartsWith or EndsWith.

HeaderDisplayText differs from the MemberName and MemberDescription Property filter in that it references the custom Name parameter in a Member Filter.

Dynamic criteria can be applied to the Name and Description property filters to apply the required formatting.

Apply conditional formatting to row header.

The result is a dynamically formatted report.

Parameter Formatting

Conditional formatting definitions can be applied to a cube view as a Literal parameter. To apply, select the format string from the cube view, press Ctrl-C, select the Default value property of a Literal Value-type parameter and press Ctrl-V. Once saved, this parameter can be referred to in a cube view format. As shown, the reference of |!Param_Conditional_PLTree!| in a cube view format would apply the associated format string.

General Settings

This section explains how to view, define, and apply standard report setting properties. These settings determine the information you see and the actions you can take in the cube view. To edit the following properties, on the Cube Views page, under Cube View Groups, select a cube view and then General Settings to expand the slider.

• Sharing: Share all or specific rows or columns from another cube view. Sharing can increase efficiency and consistency when building and managing cube views.

• Common: These options control general, shortcut, restrictions, suppression, and paging properties.

  • Is Visible in Profiles: When set to True, the Cube View is visible in the Cube View Profile. When false, the Cube View is not visible within the Cube View Profile. In these cases, the Cube View would not be visible in Workflow, Excel, Dashboards, or OnePlace.

  • Page Caption: Appears at the top of the Data Explorer grid when viewing the output of a cube view. If left blank, it will get its value from the cube view description. If the description is blank, it will display the cube view name.

  • Is Shortcut: Determines whether the cube view is a shortcut.

  • Shortcut Cube View Name: Enter the name of another cube view that will open when this cube view is being used as a shortcut.

  • Is Dynamic: Set this property to True to make the Cube View dynamic. When set to True, the developer can programmatically manipulate Cube View formatting and data at runtime through the Dynamic Cube View Service that can be added to the Workspace Assembly.

  • Literal Parameter Values: Enter a comma-separated list of name-value pairs for parameter values to be used when this cube view is used as a shortcut to open another cube view. Piped variable names cannot be used (for example, |!ParamView!|) in this setting.

    Example: Param1=Value1, Param2=[Value 2]

  • Can Modify Data: If set to True, the cube view can be modified in OnePlace. If set to False, the cube view is read only.

    NOTE: You can still make annotations to accounts in a cube view if this property is set to False.

  • Can Calculate, Can Translate, and Can Consolidate: If set to True, you can right-click on a cell and calculate, translate, or consolidate data in OnePlace.

    NOTE: These properties coincide with the Can Calculate from Grids Scenario security group. If set to True but the user is not in the group for that given scenario member, they cannot calculate from a cube view grid.

  • Can Modify Suppression: Set to True to enable a row suppression icon in the data explorer grid toolbar and enable users to turn the suppression settings on and off when viewing a cube view.

  • Include Cell Attachment Status: If set to True, a cell containing a data attachment will display a red tick mark. If set to False, there will be no indication of a data attachment in the cell. In large data sets, if set to True, it can affect performance.

    NOTE: This setting only applies to Cube Views in Spreadsheet and the OneStream Excel Add-In. It does not currently apply to Quick Views.

  • See Sparse Row Suppression and Cube View Paging.

• Header Text: The default is a cube view with standard row and column headers. All the header settings control the row and column headers presented when the cube view is run if the default is not used.

• Header Size: Column Header Heights align column headers with the bottom of a report. The default setting is -1 (which means they are auto-sized), so for bottom alignment to work in column headers, the height of the column header needs to be set. This is helpful for wrapped headers, which may cause the columns to expand.

  Row Header Widths are viewed in the cube view. Excel Row Header Widths are viewed when exporting to or rendering a cube view in Excel. Report Header Widths are viewed when a report on-the-fly is generated from a cube view. These can be changed from the default value. The -1 default value means that these Row Header Widths are auto-sized. Otherwise, set a positive number of at least 100 to determine the number of pixels wide (96 pixels = 2.5 cm). These settings can change for a maximum of six nested rows. The same can be done when reporting to Excel by using the ExcelRowHeader1Width property. The default value for this is also -1.

  NOTE: If a cube view Row Header Width is not specified, text and font information from all the expanded headers is used to automatically determine the width. The automatic row width maximum is a half of a page. Any text longer than a half of a page is wrapped.

• Header Overrides: By default, the software determines which dimensions to show for row and column headers based on the member expansions specified in the Rows and Columns slider. These dimensions can also be selected manually.

  Report Column Index for Row Headers can be used for a report to display the row headers after the column instead of on the left side. The default value is -1, but setting this to a positive number changes the cube view column index. Specifying several columns greater than the existing number of columns reverts the row headers back to the left side of the report. Hidden columns are not included in the column count.

  NOTE: If a cube view report exceeds the width of the page, the software automatically adds a page break on the appropriate column and repeats the row headers on the following page. If Report Column Index for Row Headers or Auto Fit to Page Width are enabled, the report does not repeat the row headers.

• Report: These properties apply advanced formatting to cube views.

  • Custom Report Task: Custom report formatting can be applied to cube views using a cube view extender business rule or inline formula.

    • Select No Task if there are no cube view business rules or inline formulas running on this report.

    • Select Execute Cube View Extender Business Rule to call a cube view extender.

    • Select Execute Cube View Extender Inline Formula to include an inline formula.

  • Business Rule: This property is only enabled when Execute Cube View Extender Business Rule is selected as the custom report task. Click the ellipsis and select the cube view extender business rule.

  • Formula: This property is only enabled when Execute Cube View Extender Inline Formula is selected as the custom report task. Click the ellipsis and select the cube inline formula.

  Additional options are available for report formatting to set paper size, page orientation, and margins, and to automatically fit the information to a specific page width or number of pages.

• Excel: Controls whether gridlines are displayed in the Excel file.

• Navigation Links: Determines the information you can view in a cube view in the data explorer grid.

  • Linked Cube Views: Enter a comma separated list of cube views that will be available to open when viewing a cube view in the data explorer grid. The cube views specified in this field apply to the entire cube view and are available when you right-click any cube view data cell. See Linked Cube Views.

  • Linked Dashboards: Enter a comma separated list of dashboards that you can right-click to open when viewing a cube view in the data explorer grid.

  • Include Default NavLink Parameters: Set to True in source cube views to use NavLink parameters - with a intuitive, standard syntax, as Bound parameters for any dimension. This simplifies cube view design and reduces error as you:

    • Do not have to define parameters for navigation, and can use a standard syntax to ensure parameter names match across cube views and other objects.

    • Can navigate cube views from any dimensional intersection to analyze data that is refined by passed point of view selections, in linked cube views. See Analyze Data in Linked Cube Views Wtih Passed Point of View Selections.

  • Bound Parameter Names for Navigation Links: Lists all the dimensions that may be assigned to a row when the Report Navigation Links property is set to True and represents the member name being passed from this report to another using navigation links.

  • Bound Parameter Names: For a linked cube view to open and display the correct member data for a selected cell, parameters with the member need to be specified using a bound parameter. This lists all the dimensions that may have a parameter included in a linked cube view.

Navigation Links

Navigation links let you set up one dashboard to launch another in order to drill into more detail or related detail on a certain row of data from a report, while other times it can create a chart of the reviewed data.

The following information provides a detailed example including the steps one must take to create Navigation Links. The implementation of this feature will differ, but for this example an Income Statement Summary Dashboard will launch another Dashboard with more detail:

Click Total Other Income (Expense) to display the following dashboard:

NOTE: This only works in dashboard mode.

Below is a sample cube view called IS Summary which contains income statement summary accounts. First, select the row to be highlighted for navigation. Set Enable Report Navigation Link to True and type the name of the dashboard to open in the Dashboard to Open in Dialog field. The specified dashboard (not a cube view) opens when this highlighted row is selected from this cube view’s related dashboard.

This next step is optional. Add a header format using a cube view style. This displays the row in a color different from the other rows to indicate the row is clickable. In this case, |!Highlight_Row!| is related to a parameter that was made in a sample application. When this cube view is run, the format of TextColor=Blue activates for this row.

The cube view passes the clicked account to the other dashboard and there the account and its children can be viewed. Now, determine how the account is to be passed. Go to the General Settings slider and go to the Report Navigation Links section. A value of ClickedAccount was entered for the Account Bound Parameter Name which is going to be passed from one dashboard to another. More than one dimension can be passed if it is defined in rows, but in this case this does not need to happen.

Copy this cube view to have the same columns and POV settings for the drilled cube view containing the contents. This one is called IS Content because it contains the content of the drilled data. Whatever it is called, be consistent and come to an agreement with the project team.

In the new cube view (called IS Content in this case), remove the rows that were there and add the rows that will be seen when this Dashboard appears. In this case, refer to the parameter for ClickedAccount and add the ChildrenInclusive extension.

Under dashboards, a maintenance unit was created and called GolfStream Navigation Link Example, which stores all the objects needed to get this to work properly.

Starting from the bottom of the example above is the parameter needed to highlight the row.

The data adapters are required to point to the cube views. First, set up one for IS Content. Set the Command Type to Cube View and set the cube view to IS Content.

Next, set up the data adapter for IS Summary. Set the Command Type to Cube View and set the cube view to IS Summary. Set the Include Row Navigation Link property to True to drill from Cube Views in a Dashboard.

Now, set up two content components for a dashboard. Namethese with the prefix of der_ because they are data explorer reports and not charts or another form of component. Again, come up with a naming schema with the project team, so the result is organized. In this case, click to create a component and chose Data Explorer Report as the type. Do this for both IS Summary and IS Content and click in the dashboard toolbar to attach the appropriate data adapter to each.

Select Parameter Components and create a new component with a type of Supplied Parameter. In the Bound Parameter field, enter the name of the parameter being passed, which is ClickedAccount in this example. Do this for each parameter being passed from dashboard to dashboard.

Create a dashboard group (called IS in this example) and two dashboards. Create one for the launching dashboard (for example, IS Summary) and one for the launched dashboard (for example, IS Content). In this example, a layout of Uniform is being used, but the use of this feature may vary.

Under Dashboard Components, attach the data explorer report component. Do this for both IS Summary and IS Content. For just the IS Summary (the launched dashboard), also attach the parameter component being passed (ClickedAccount in this example). This allows that account to be passed from the initial dashboard to the other.

Linked Cube Views

Linked cube views provide the option to launch a cube view from another when viewing it in the Data Explorer grid, spreadsheet tool, or Excel Add-In. You can right-click a cube view's data cell and open a separate cube view to access more detail and visibility. This applies to any cube view, such as those for data entry forms. See:

• Create a sample linked cube view

• Link a cube view to another entire cube view

• Link a cube view to specific rows or columns

• Nest linked cube views

TIP: For information about evaluating source cube view data in a linked cube view using passed point of view selections, see Analyze data with passed point of view selections.

NOTE: For Linked Cube Views, the Workspace Name will not be automatically prefixed. The search order of operations (requested workspace, current workspace, default workspace, and then shared workspaces) will be used to find the correct Cube View.

Create a Sample Linked Cube View

The following describes how to create a sample linked cube view. In this example, an Income Statement Summary cube view has an Account Detail cube view assigned to all data cells and a Sales by Product cube view linked to specific rows. You can also add a second level of linked cube views for an even more granular analysis.

Link a Cube View to an Entire Cube View

1. Select the cube view to be linked and apply to the entire cube view, specific columns, or specific rows. If the linked cube view applies to the entire cube view, you can right-click any data cell in the Data Explorer grid, spreadsheet tool, or Excel Add-In to access the cube view. If it only applies to columns or rows, the linked cube view is available when you right-click on a data cell in that row or column.
   

NOTE: Column settings override cube view settings and row settings override column settings.

2. Once the base cube view is determined, in this example IncomeStatementSummary, create a cube view that will display more detailed data.
   
   The AccountDetail cube view will display Account details based on the selected data cell. The IncomeStatementSummary’s data displays Parent accounts for a specific time, so the AccountDetail’s data will display the selected Account’s children for that same time period.

3. In the AccountDetail cube view, configure the columns and rows to query the correct data.
   
   |!DrillAccount!| is a Bound parameter and will display the correct account data based on the selected account in the IncomeStatementSummary cube view.
   
   !DrillTime!| is a Bound parameter and will display the correct Time data based on the selected time in the IncomeStatementSummary cube view

4. Ensure the AccountDetail’s POV matches the IncomeStatementSummary’s POV with the exception of Account and Time. Enter the |!DrillAccount!| and |!DrillTime!| parameters into these member fields to ensure that the AccountDetail cube view displays data based on the selected Account and Time in the IncomeStatementSummary.

5. Add any required formatting to the AccountDetail cube view. In this example, the following was added to Page Caption:
   

6. To assign the AccountDetail to the entire IncomeStatementSummary cube view, select IncomeStatementSummary and click General > Navigation Links . Enter the names of the linked cube view in Linked Cube Views or click the ellipsis to find the cube view using Object Lookup.

7. Enter the Bound parameters which will pass from one cube view to the next. In this example, a Bound parameter was entered for Account and Time so both members are based on the selected IncomeStatementSummary data cell.
   

Run IncomeStatementSummary, noting that you can right-click cells to access the AccountDetail cube view.

Link a Cube View to Specific Rows or Columns

This topic describes how to assign a linked cube view to specific rows. The ProductDetail cube view will display product details based on the IncomeStatmentSummary’s selected data cell. The IncomeStatementSummary’s data displays parent accounts for a specific time, so the ProductDetail’s data displays the selected account’s product sales.

In the ProductDetail cube, configure the rows/columns, POV, and formatting to ensure that the user sees the correct data. See the AccountDetail instructions above for details.

To assign the ProductDetail cube view to IncomeStatementSummary rows, select the IncomeStatementSummary cube view, then go to the Linked Cube Views property on the Data tab in the Rows/Columns. Select the row or column and enter the name of the cube view.

NOTE: Due to overrides, assign the AccountDetail cube view to this property too. Previously, AccountDetail was assigned to the entire cube view. However, because a cube view is being assigned to a row, the cube view settings are overridden and only display the cube view specified for this property. For both cube views to be available on the row, specify them both.

If any Bound parameters need to be entered (in this example, the same Bound parameters are used for both cube views), enter them under Navigation Links in General Settings.

In the example above, the ProductDetail Cube View was assigned to the Net Sales row. When a user right-clicks on a Net Sales cell in the Data Explorer grid, Spreadsheet tool, or Excel Add-In, this cube view is available.

Nest Linked Cube Views

You can link a cube views to cube views that are already linked. In this example, the ProductDetail_2 cube view is linked to ProductDetail and displays specific product data tied to a selected ProductDetail cell.

1. In ProductDetail_2, configure the rows and columns as needed.
   
   

2. Enter a |!DrillProduct!| Bound parameter to display specific product details. For example, if you right-click a Clubs cell in the ProductDetail cube view and select the ProductDetail_2, sales details for Clubs displays.
   

3. Ensure a |!DrillTime!| parameter is also used.

4. Set the POV for ProductDetail_2 so it matches the ProductDetail POV, except for the User Defined 2 member. In this example, products are viewed using the UD2 member. Enter |!DrillProduct!| in User Defined 2.

5. Add any required formatting to the ProductDetail_2, such as page captioning:
   

6. Open ProductDetail and navigate to Linked Cube View under General Settings > Navigation Links.

7. Click the ellipsis and select the ProductDetail_2 cube view. This link the cube view to the entire ProductDetail cube view.

8. Enter the Bound parameter from ProductDetail_2.
   

9. Run ProductDetail from IncomeStatementSummary, right-click cells and select Navigate To ProductDetail_2.

Analyze Data in Linked Cube Views With Passed Point of View Selections

Use the Include Default NavLink Parameters property to enhance cube view design and navigation for optimal data analysis. Set the property to True to use the following standard syntax to more easily look up parameters and ensure parameter names match across linked cube views and other objects.

|!dimensionNavLink!|

Point of view selections you specify in a source cube view pass to the linked cube view, for a refined, focused analysis. For example, to pass the Time dimension from a source cube view to a linked cube view, specify |!TimeNavLink!|in the linked cube view's POV. The data in the cell point of view in the source cube view (2018Q1 as shown below) passes to the linked cube view's point of view at runtime.

Watch to learn more.

Using Default NavLink Parameters

To use passed point of view selections in a linked cube view:

1. Click Application > Cube Views, and then the cube view containing the source data to access and analyze further in a linked cube view.

2. Click General Settings > Navigation Links.

3. Set Include Default NavLink Parameters to True and click Save.

4. Open the linked cube view in which to retrieve and evaluate the source data based on point of view selections. Set Include Default NavLink Parameters to False.

5. Click POV , specify |!dimensionNavLink!| for each dimension to analyze and then click Save.
   

6. Return to the source cube view and click Open Data Explorer.

7. Right-click cells to navigate to the linked view, retrieving data for the specified point of view parameters that are also identified in the header.
   

Format a Report Page

The following settings in the cube view address page formatting:

• Header (text, size, overrides)

• Report

• Headers and footers

Ensure the general settings are correct before formatting your page. See General Settings.

To edit the header and report settings, on the Cube Views page, under Cube View Groups, select a cube view and then General Settings to expand the slider.

Header Settings

Row and column headers can be adjusted to refine your cube view.

• Header Text: Decide if you want to see the name, description, or both for each of the dimension types. Also, set the Culture property of a cube view, which determines the language for the report. Ensure the Member Descriptions Culture properties are set up correctly before setting the Culture property.

• Header Size: Provide a height for columns and width for rows. The rows can be edited separately by Data Grid (Row Header), Excel (Excel Row Header), and PDF (Report Row Header). Each of these items defaults to -1, but you can change them by typing a pixel number.

• Header Overrides: Change which dimensions display in the rows and columns. The default for a cube view is to display what is available in the rows and columns. However, you can apply Header Overrides to change the order or add dimensions.

  The Report Column Index for Row Headers can also be set here. This changes the location of the row headers from their usual place (the left). Type the number of columns that should display before the row headers are shown. This only applies to the PDF version of the report.

Report Settings

These properties apply advanced formatting to cube views.

• Custom Report Formatting: Write or assign cube view extender rules to provide intricate cube view formatting. This only applies to the PDF version.

• Paper: Select the paper size.
• Landscape: Select the page orientation.
• Margin: Set margins on individual reports. Type a pixel number to override the default settings of the page in the general settings.
• Auto Fit Settings: Set Auto Fit to Page Width to True if the report should re-size to fit all columns on one page. Use the Auto Fit Number of Pages Wide property to type the number of pages to display the columns.
• Scale Factor: Sets and adjusts the scale of the report by this value and automatically centers report content horizontally. The default value is 1, and the maximum value is 2. If you enter a value greater than 2, it will default to a scale factor of 2.

NOTE: Scale Factor is not compatible with Auto Fit to Page Width.

Header and Footer Settings

Report headers and footers control what displays at the top and bottom of the page when a cube view is run as a data explorer report. Standardize headers and footers across reports and make as dynamic as possible to reduce reporting maintenance. On the Designer tab of the Cube View, Report Header and Report Footer are separate sliders. Enter text in the fields or use substitution variables.

Use substitution variables to reduce the maintenance of headers and footers. Substitution variables are short scripts that use pipe characters to include a predefined substitution variable. They come with every installation of OneStream and cannot be edited, so you do not need to create or maintain them. Substitution variables can be used throughout the application. For cube views, you can use them for:

• Headers and footers

• Rows and columns

• Cube view page captions

To copy and paste a substitution variable into your application:

1. On the Cube Views page, click Object Lookup to open the dialog box.

2. Under Object Type, select Substitution Variables to see the list of options.

3. Select the name of the substitution variable.

4. Click Copy to Clipboard.

5. Paste the substitution variable where needed.

Calculations

When you create a calculation in a cube view, the data is generated on-the-fly and not stored in the database. When you run the cube view, the calculation returns a value.

You can use calculations in a cube view to calculate:

• Variances

• Sums

• Differences

• Ratios

Calculations are useful for variance reporting, What If scenarios in cube views, and KPI calculations.

Types of Cube View Calculations

There are three ways to create calculations in cube views. Each option uses the GetDataCell function, which retrieves specific cells and performs math or business rule operations.

The most common ways to create a calculation in a cube view use:

• GetDataCell Expressions

• Column and Row Expressions

• Dynamic Member Formulas and Cube Views

Choose the option that has the least maintenance and highest usability.

NOTE: You can also create more complex calculations with business rules.

GetDataCell Expressions

Write GetDataCell expressions in the cube view row or column. It will calculate at runtime. The expressions require a reference to specific dimension members to return a data point. Use GetDataCell expressions if you are running calculations on members that are not currently in the cube view or if the expression is easy to create and maintain. GetDataCell expressions are simpler versions of dynamic calculations.

NOTE: Use one of the other calculation types if you are querying multiple member combinations.

Samples Tab

In the Member Filter Builder, use the Samples tab to create simple GetDataCell expressions in your cube view.

In Member Filter Builder, click Samples.

There is a list of preexisting GetDataCell expressions you can use. For detailed information, see the following table.

Components of GetDataCell

A GetDataCell expression is the performance section of a dynamic calculation. It tells the dynamic calculation what it will be doing. The following example shows a common GetDataCell expression. GetDataCell expressions are simpler versions of dynamic calculations.

Return api.Data.GetDataCell("Divide(A#CurrentAssets,A#CurrentLiabilities)")

• Return api.Data: Tells OneStream which results to display.

  NOTE: This is not required for GetDataCell expressions, but it is required for dynamic calculations.

• GetDataCell: Performs the calculation.

• ("Divide(A#CurrentAssets,A#CurrentLiabilities): Math syntax in a string format to calculate.

You can use the Samples tab to create simple GetDataCell expressions in your cube view.

GetDataCell Types

There are several GetDataCell expressions. You can find a complete list under OnePlace > Dashboards > Application Reports > Application Reports Dashboards > Report Groups > Application Analysis.

• Variance: Calculate the difference as a ratio between two scenarios using the [Variance] function in a GetDataCell expression.

  For example: GetDataCell(Variance(S#Scenario1,S#Scenario2)):Name(Variance)

• Variance %: Calculate the difference as a percentage between two scenarios using the [VariancePercent] function in a GetDataCell expression.

  For example: GetDataCell(VariancePercent(S#Scenario1,S#Scenario2)):Name(Var %)

• Better or Worse: Calculate the difference between two scenarios while considering account types using the [BWDiff] function in a GetDataCell expression.

  For example: GetDataCell(BWDiff(S#Scenario1,S#Scenario2)):Name(BW Diff)

• Better or Worse %: Calculate the difference as a percentage between two scenarios while considering account types using the [BWPercent] function in a GetDataCell expression.

  For example: GetDataCell(BWPercent(S#Scenario1,S#Scenario2)):Name(BW %)

• Ratio: Calculate the ratio between two scenarios using the [Divide] function in a GetDataCell expression.

  For example: GetDataCell(Divide(S#Scenario1,S#Scenario2)):Name(Ratio)

• Difference: Calculate the difference between two scenarios using the [Subtraction] function in a GetDataCell expression.

  The example that appears when you double click this expression in Member Filter Builder: GetDataCell(S#Scenario1-S#Scenario2):Name(Difference)

• Sum: Calculate the sum of two scenarios using the [Addition] function in a GetDataCell expression.

  For example: GetDataCell(S#Scenario1+S#Scenario2):Name(Total)

• Custom Function (Condensed Syntax): Call a Finance business rule using the [BR#] function in a GetDataCell expression.

  For example: GetDataCell(BR#[MyBusinessRuleName, MyFunctionName]):Name(Custom Function)

• Custom Function: Call a Finance business rule using the [BR#] function in a GetDataCell expression. For example:

  GetDataCell(BR#[BRName=MyBusinessRuleName,FunctionName=
  MyFunctionName]):Name(Custom Function)

• Custom Function with Parameters: Call a Finance business rule using the [BR#] function in a GetDataCell expression. For example:

  GetDataCell(BR#[BRName=MyBusinessRuleName, FunctionName=MyFunctionName, Name1=Value1, AnotherName=[Another Value]]):Name(Custom Function)

Create a GetDataCell Calculation

GetDataCell expressions run a calculation directly in a cube view by referencing specific dimension members.

In the Member Filter Builder, use the Samples tab to create simple GetDataCell expressions.

Some common errors when developing GetDataCell expressions are:

• Not having the correct dimension listed. Make sure to use the Member Filter Builder if you are not sure what to use.

• Not having the correct number of parentheses. Make sure to use the correct number of opening and closing parentheses.

To add a row expression to a column in a cube view:

1. In OneStream, go to Application > Presentation > Cube Views.

2. Select a cube view group and then a cube view.

   

3. Expand the Rows and Columns slider.

   

4. To add a row to insert the CVC/CVR calculation, in Rows and Columns, click the plus sign.

   

5. In Member Filters, rename the row.

   

6. Click Member Filter Builder for the row to insert a calculation.

   

7. Delete any existing content in the Member Filter field.

8. Click Samples.

   

9. Expand Column/Row Expressions.

10. Click Sum of Rows (CVR). The GetDataCell syntax is generated and displays in Member Filter.

11. Update the row names to add the rows together. Rename Row1 to Cash and Row2 to AR.

12. Replace the name at the end of the expression to reflect the row name. The expression is complete.

13. Click OK and then click Save.

14. Click Open Data Explorer to run the cube view and verify the result.

Troubleshoot GetDataCell Errors

These are some common errors when using GetDataCell expressions:

• Incorrect dimension: Make sure you have the correct dimension listed. If you are unsure, use the Member Filter Builder.

• Incorrect use of parentheses: Verify that you have the correct number of parentheses and that they are positioned correctly to avoid a script error.

Column and Row Expressions

Cube views accept calculated columns and rows using the GetDataCell function and references to cube view column and row names. This is known as Column/Row math.

Write column and row expressions in the cube view row or column itself. They calculate at runtime.

These expressions require a reference to the specific cube view column or row name to return a data point.

Use column and row expressions if you need to perform math across columns and rows. A common use case is with variance columns. Column and row expressions are useful if the query is more complex or if the expression is easy to understand and maintain.

NOTE: Use one of the other expression types if you are using multiple member expansions, especially when performing math on rows.

Create Cube View Column and Row Calculations

Cube views accept calculated columns or rows using the GetDataCell() function and references to cube view column or row names. This is also known as cube view column/row math.

These are based on the names given to a cube view column, for example "Col1" or "TimePeriods" or cube view row, for example “Row2” or “Accounts” by the creator of the cube view.

NOTE: Using the column or row names may be more useful than using member filters.

• Cube view columns: Uses the GetDataCell function to perform math on columns.

• Cube view rows: Uses the GetDataCell function to perform math on rows.

There are several variations on this method, depending on whether the expression refers to columns, rows, or a combination.

When naming a new calculation, do not include spaces or special characters that could make the column/row calculations read incorrectly.

Create a CVC/CVR Calculation

1. Add a row or column to insert the calculation.

   

2. Rename the row relevant to your calculation. In this case, the is CurrAssets.

   

3. Open the Member Filter Builder for the row or column where you want to insert a CVC/CVR calculation.

   

4. Delete what is in the Member Filter pane.

   

5. Navigate to the Samples tab.

   

6. Expand Column/Row Expressions.

   

7. Double-click Sum of Rows (CVR). This will populate the GetDataCell expression that you need.

   

8. Update the row names to add the rows together. Rename Row1 to Cash and Row2 to AR because Cash and AR are row header names used in the cube view.

   

9. Replace the name at the end of the expression to display Current Assets.

   

10. Click OK.

    

11. Click Save.

12. Run the cube view.

CVC: Cube View Column Calculations

The example below shows a Column Math example of the difference between columns (CVC).

The syntax is GetDataCell(CVC(SomeColumnName) - CVC(SomeOtherColumnName)):Name(Header Name)

The example of simple member math includes the :Name() function typically applied to a column in a cube view:

GetDataCell(CVC(Col1) - CVC(Col2)):Name(Variance) 

GetDataCell(CVC(Col1) + 1):Name(Column Plus One)

GetDataCell(CVC(Col1) * (-1)):Name(Column with Sign Flipped) 

CVR: Cube View Row Calculations

The example below shows a Row Math example of Sum of Rows (CVR).

The syntax is similar, but instead of CVC, a calculated row uses CVR for retrieving the value of a row in a formula.

An example of the syntax: GetDataCell(CVR(SomeRowName) + CVR(SomeOtherRowName)):Name(HeaderName)

NOTE: If a column name is numeric (for example, 500), single quotes are required when specifying the row name. Square brackets are allowed, but not required. For example: GetDataCell(CVR('123') - CVR(['4,567'])):Name(Difference)

When you need a column and row index: Col1 has a member filter of S#Actual, S#Budget, meaning it will return two columns. In this case, a variance between Actual and Budget scenarios can be shown like this: GetDataCell(CVC(Col1, 1) - CVC(Col1, 2)):Name(Variance).

Alternatives: GetDataCell(CVC(Col1, First) - CVC(Col1, 2)):Name(Variance) GetDataCell(CVC(Col1) - CVC(Col1, 2)):Name(Variance)

Column Math Example with Division and Other Advanced Functions

Member Expansions may require some more intricate formulas. This may require using indexes or a CVRC expression. Use functions like Divide to avoid divide by zero situations.

GetDataCell(Variance(CVR(Col1,2), CVR(Col1,1)):Name(Variance)GetDataCell(VariancePercent(CVR(Col1,2), CVR(Col1,1)):Name(Variance %) GetDataCell(Divide(CVC(Col3), CVC(Col2))):Name(Ratio) GetDataCell(BWDiff(CVC(Col1), CVC(Col2))):Name(BetterWorse Difference)GetDataCell(BWPercent(CVC(Col1), CVC(Col2))):Name(BetterWorse %)

Create Advanced Column Row Expressions

Use an index or a CVRC expression to create more intricate formulas. The Member Filter Builder has complex options in the Samples tab.

Reference Hidden Columns with Cube View Column Math

Use the CVMathOnly option to perform math on columns when the columns are not visible.

1. From the Application tab, under Presentation, click Cube Views.

2. Expand Cube View Groups, expand a specific cube view group and select a cube view.

3. Click Rows and Columns. In the example below there are three columns, where Column 3 has the GetDataCell() function applied for the total of Column 1 and Column 2.



4. Click Open Data Explorer to generate the Cube View and see the data. In the example below you see that it is adding the value 200.00 from Column 1 to the value 200.00 from Column 2 to generate the total of 400.00 in Column 3.

   

5. Click Edit.

6. Select Column 1 and at the bottom of the window click the Formatting tab.

7. In Header Format, click the ellipsis. The Header Format window opens.

8. Click Format.

9. In the General section, find isColumnVisible and select CVMathOnly.

Dynamic Member Formulas and Cube Views

Dynamic calculations enhance the consolidation performance because the amount is calculated when requested for display and is not written to the database.

Use dynamic calculations in cube views and business rules.

• There is no performance impact on consolidation times.

• You can make dynamic calculations drillable so users can see the source for the calculated result when drilling down.

• Use these calculations for ratios or variances.

In the dimension library, write dynamic calculations on specific members. They will calculate at runtime.

Dynamic calculations have a syntax similar to GetDataCell expressions because they also require reference to specific dimension members to return a data point.

NOTE: A difference between dynamic calculations and GetDataCell expressions is that dynamic calculations require proper business rule logic.

Use dynamic calculations if you need a repository of commonly used calculations which allows for consistency and reduces maintenance.

Create common calculations in the UD8 dimension. It allows you to have the most flexibility with your rule syntax.

Use another calculation type if the calculation is only used on a specific cube view because you may not want to create a member in the dimension library. Also, consider if you will grant a report builder access to the dimension library to view, create, and edit these calculations.

Create Dynamic Calculations

Dynamic calculations enhance the consolidation performance because the amount is calculated when requested for display and is not written to the database.

Account, Flow, and all UDs can contain dynamically calculated members.

• There is no performance impact on consolidation times.

• You can make dynamic calculations drillable so users can see the formulas running.

• These calculations can be used for ratios or variances.

Two properties must be set to make the calculation dynamic: Account Type and Formula Type. Ensure that the Formula Type is set to DynamicCalc. If using on an Account dimension type, both the Account type and Formula Type need to be set to DynamicCalc.

Here are some common examples of how dynamic calculations are used:

• Api.Data.Calculate(“Target = A + B”)

• Api.data.calculate(“A#InsuranceExp = A#Payroll * A#InsuranceCostPcent”)

• Api.Data.GetDataCell(“A + B”)

• Return Api.data.GetDataCell(“A#GrossSales – A#ReturnsAndAllowances”)

Calculated Members and Example

In the Dimension Library, there are likely a few members that will be calculated using a member formula. Dynamically calculated members are members that use the GetDataCell function to return values based on math when they are queried.

These members require that a Formula Type of DynamicCalc be defined before writing a member formula.

NOTE: If this property is not defined, the member will return an error and the rule will not compile.

• Display Results: This section tells the system how to display the results of the function.

• Performs the DynamicCalc: This section tells the system to perform the DynamicCalc using the GetDataCell function.

• Any Math syntax in a string: This tells the system what math you want it to perform.

Define a Dynamic Calculation

Before you add a dynamic calculation to a cube view, you must define it or write the simple dynamic calculation.

In this example, we are going to navigate to a UD8 member that you want to update to define the simple dynamic calculation.

1. Open the UD8 member.

   

2. Open the formula editor for the member and ensure that the formula type is set to DynamicCalc.

   

3. Open the stored value.

   

Now you can write a dynamic calculation. In this example, the formula will display an entity’s Text1 value if an Annotation type View member is referenced.

Write a Dynamic Calculation

You can write a simple dynamic calculation before adding it to a cube view.

1. Open the formula editor for the member that you want to update and navigate to Snippets > Presentation Helpers > Reporting.

2. Select the dynamic calculation you want to use.

3. Copy and paste the syntax.

   

4. Edit the dimensions of the pasted syntax to make sure they are correct.

   

5. Double-check your syntax.

6. Click OK.

7. Close the Formula Member Property.

8. Save the member.

Add a Dynamic Calculation to a Cube View

After you define and write a dynamic calculation, you can add the calculation to a cube view.

1. In OneStream, go to Application > Presentation > Cube Views.

2. Select a cube view group and then a cube view.

3. Create a new column. You will add a dynamic calculation to the second column. All the selections and properties of Col1 are carried over to the new Col2. Our reporting dynamic calculations are located in UD8. Therefore, the dimension will need to change.

   

4. Open the column dimension drop-down and select UD8.

   

5. Click the Member Filter Builder.

6. Delete the current filter.

7. Select the U8# dimension token.

8. Select VariancePctPriorMonth and move the selection over.

   

9. Select the VariancePriorMonth member and move the selection over.

10. Click OK.

11. Click OK to confirm the Member Filter selection.

12. Save your changes.

13. Run the cube view as a Data Explorer Grid. The cube view renders and displays the dynamic calculations in the two far-right columns.

    

Override Complex Calculations

When you apply dynamic calculations to both rows and columns the row formula takes precedence, whether it is a dynamic calculation member or cube view math.

Rows and columns contain several override properties by row:

• When you use the row override in the column it will use the column formulas for the specified rows.

• When you use the column override in the rows it will use the formulas for the specified columns.

Apply Overrides

1. In the cube view, select a column.

2. Select the Row Overrides tab to apply row overrides in the column.

3. Define the row range. Enter a row name or apply a range of row names to override the results for the specific rows in the column of the cube view.

4. Enter the member filter to override the value for the row range. This defines what dimension member data displays or specifies complex calculations for the row range.

5. Set the format for the row range, which includes selecting fonts, text colors, cell background color, grid lines, cell borders, and so on.

6. Select a value from the list parameter drop down list.

Row/Column Overrides

You can have up to four overrides for your column and four overrides for your row. These can be used to change the display for a given column or row. In this example, two columns for the Flash Scenario (Col1) vs. Budget (Col2) are needed. If Row1 is being used by the Net Sales Account (e.g. A#60999), and it needs to be compared to the Flash Net Sales which is a different account (e.g. A#FlashNetSales), then you would use a column override.

Row/Column Range

Type a column name to display a different value in the Cube View. You need to use the name of your rows or columns. The row range isn't looking for a numerical order, it's looking for the actual name of the rows and columns in your Cube View. In this example, Col1 would be typed to show a different value for Flash Scenario Column.

TIP: Your Row Range can be a single row or column. To apply to multiple rows or columns, use a comma-separated list or use a hyphen to define a range.

Member Filter

Type the Member Filter to override the value for the columns or rows.  In this example, type A#FlashNetSales to override the results from A#60999.

The override results will display the value from A#FlashNetSales in Col1 for the Flash Scenario.

Cell Format

See Cube View Formatting.

List Parameter

See List Parameter under Data earlier in this section.

Dashboards

Dashboards are a powerful way for users to view formatted cube views, pixel perfect financial reports and expressive charts. Dashboards are contained in a dashboard group and comprised of components, data adapters and potentially parameters. All of the objects are managed and shared across Dashboard Maintenance Units. Each is a building block on the other. Dashboard Maintenance Units are stored, created, and maintained in Workspaces. Workspaces vary by dashboard project needs and applications.

Workspaces store Dashboard Maintenance Units and facilitate community development by providing an isolated environment for developers to segregate and organize Dashboard objects. Workspaces are the foundation for dashboards and will continue to evolve into the framework that encapsulates the artifacts needed to develop business solutions.

The main use of a Dashboard Maintenance Unit is to enable the sharing of key dashboard artifacts like parameters, data adapters and components across multiple dashboard groups. These objects do not have security access settings, so they assume the settings of the maintenance unit. Once a maintenance unit is created, dashboard groups, components, data adapters, parameters, and files can be created within the unit.

Dashboard groups are created to organize dashboards and work as placeholder where the dashboards reside. The dashboard groups are then available to assign to dashboard profiles for viewing throughout the workflow process.

Dashboards are composed of components which are broken into parameter components, content components, and embedded components. Components can have one to many data adapters and can be used across multiple dashboards and dashboard groups in the same Dashboard Maintenance Unit.

When creating a component, give it a name and description. Feed parameters and other Substitution Variables into the description, so they display in the resulting component.

Account: |!TrendAccountParam!| Region: |!!Region Parameter!!| Year: |WFYear| Will appear as:Account: Net Income Region: Asia Pacific Year: 2012

Data adapters are the minimum building block for components. These specify where the data is coming from for the dashboard component. A list can be made of each data adapter which names the resulting table created when the dashboard runs.

Parameters can be used to filter data in the resulting dashboard. They are not required, but extremely useful. See Presenting Data With Books, Cube Views and Dashboards.

The File section allows an administrator to create company specific dashboards by uploading documents and images.

NOTE: Optimal display size is 1920 x 1080 resolution. For the Windows desktop application, we recommend setting the scale to 100% and using the zoom functionality to zoom in. This is especially helpful in dashboards such as People Planning and Reporting Compliance.

The process works as follows:

Dashboards

Dashboards are contained in Dashboard Groups made up of Components, Data Adapters, potentially Parameters, and Files.  All these objects are managed and shared across Maintenance Units which are then assigned to Dashboard Profiles.

Dashboard Toolbar

Create Group

Use this to create Dashboard Groups which is where all Dashboards are organized. 

Create Profile

Use this to create a Dashboard Profile which is where all Dashboard Groups are organized.

Manage Profile Members

Use this to assign Dashboard Groups to Dashboard Profiles.

Create Workspace
Use this to create a workspace. Workspaces store maintenance units and facilitate community development by providing an isolated environment for developers to segregate and organize dashboard objects. See Workspaces

Create Maintenance Unit

All Dashboards and their corresponding Components, Data Adapters, Parameters, and Files are kept in a Maintenance Unit. 

Create Dashboard

Use this to create a Dashboard. 

NOTE: A Maintenance Unit and a Dashboard Group need to be created first for this icon to be available.

Create Cube View

Use this to create a cube view.

Create Dashboard Component

Use this to create a Component to assign to a Dashboard.

Create Data Adapter

Use this to create a Data Adapter to assign to a Component.

Create Parameter

Use this to create a Parameter to use in a Dashboard or cube view.

Create File

Use this to store files to be used in a Dashboard.

Create String

Used with XFString functionality and displayed as a caption in a cube view.

Create Assembly

Use this to create an assembly.

Delete Selected Item

This allows the deletion of a single child item (e.g., Data Adapter or Component) within a Maintenance Unit, or the deletion of an entire Maintenance Unit including all child items.

Rename Select Item

Use this to rename the selected item.

Cancel All Changes Since Last Save

Use this to cancel any changes made to items since the last save.

Save

Use this to save all changes.

Copy Selected Dashboards, Components, Adapters, Parameters, Files, and Strings

Use this to create copy of the selected Dashboards, Components, Adapters, Parameters, Files, and Strings within or across Maintenance Units.

Multiple items can be selected all at once using Shift+click or Ctrl+click. Items can be copied and pasted multiple times and each time the item is pasted a suffix of _Copy will be added. For every additional instance of the Dashboard item that is pasted a suffix of _Copy (instance#) will be added.

NOTE: Users can Copy using right-click on the Dashboard Item or toolbar menu Copy button.

Paste Selected Dashboards, Components, Adapters, Parameters, Files, and Strings

Use this to paste copies of selected Dashboards, Components, Adapters, Parameters, Files, and Strings within or across Maintenance Units.

Items can be pasted multiple times and each time the item is pasted a suffix of _Copy will be added. For every additional instance of the Dashboard item that is pasted a suffix of _Copy (instance#) will be added.

NOTE: Users can Paste using right-click on the Dashboard Item or toolbar menu Paste button.

Search

Use this to open the Search Workspace Object dialog box and search for an object.

Add Dashboard Component

Use this to add a new dashboard component.

Move Up/Down

Use these to move components up or down in a list.

Remove Selected Dashboard Component

Use this to remove a dashboard component.

Open Data Explorer

Use this to open the Data Explorer dialog box

View Dashboard

Use this to run a Dashboard from the Application Tab.

View Dashboard in Design Mode

Select a Dashboard and click the black arrow in order to Set Selected Dashboard as Default. Click the icon to launch the default Dashboard in design mode. The Dashboard must be set as the default prior to viewing it in design mode. Select Clear Default Dashboard in order to remove the current saved Dashboard from the default state.  See Dashboard Design Mode in Presenting Data With Extensible Documents for more details on this feature.

Show Objects that Reference the Selected Item

Use this to see other areas where the selected item is being used. For example, you can see where a parameter is being used in an application and therefore know the impact when you want to make a change.

Object Lookup

See Object Lookup.

Navigate to Security

This icon appears in the Maintenance Group, Dashboard Group, and Profile Security properties and when clicked it navigates to the Security screen. This is an easy way to make changes to Security Users or Groups before assigning them to specific Maintenance Units, Groups, and Profiles.

Dashboard Design Mode

Dashboard design mode makes it easy to design and edit dashboards because it pinpoints exactly where the desired change needs to be made. Dashboard in design mode displays a dashboard draft and all the dashboard maintenance unit items associated with it. You can then select different sections of the maintenance unit hierarchy which highlight that portion of the completed dashboard, or select a portion of the dashboard and be directed to that exact item in the maintenance unit.

To run a dashboard in design mode:

1. Select the dashboard to which changes need to be made and set it as the default dashboard.



2. Click to run the dashboard in design mode.

Design Mode

The following describes the design mode page elements.

TIP: Highlight a specific dashboard item (such as a data adapter or component) and select this icon to go directly to that item in the dashboard maintenance screen.

1. Toolbar:

   Click this to hide or display the Dashboard Maintenance Unit items.

   Click this to go back to maintenance mode.

   TIP: Highlight a specific dashboard item (such as a data adapter or component) and select this icon to go directly to that item in the dashboard maintenance screen.

2. Dashboard Maintenance Unit items: This provides the entire dashboard maintenance hierarchy for the default dashboard. For more complex dashboards, use the search to find the desired item. This dashboard example contains one chart component, one cube view component and the custom substitution variables used (parameters and their variables). Hover the mouse over each item to display a tool tip that identifies the value currently being used. Each component has its own data adapter.

3. Dashboard Draft: This is the default Dashboard.

4. Find Tree Item When a user clicks this icon, the maintenance items involved in this part of the Dashboard are highlighted in the tree. For example, to change the dashboad title above, click to see what part of the maintenance hierarchy controls the chart

   

   This indicates exactly where these changes can be made.

   Click to return to edit mode and it navigates directly to the chart component selected in design mode

   

   Make the necessary changes and preview it once more in design mode to see the outcome.

   

   NOTE: Authoring dashboards which are designed to contain more than six levels of nested dashboards is a rare use case and not recommended. When viewing in the Silverlight web browser, results may be inconsistent. If there is a desire to nest dashboards to this level or beyond, it is recommended to use the OneStream Windows application interface.

Preview Dashboards

Click to preview a completed Dashboard. Once in preview mode, Parameters may need to be entered, and then click Ok to get the Dashboard to run.  Click to go back to Parameters and run the Dashboard again under a different input value.

Click to toggle back to design mode.

The example above shows a Dashboard with two Chart Components and one Data Explorer Component.

In this example above, there are three Components listed in the Dashboard Components tab in the order in which they appear on the screen.

Component 1 has the Dock Position set to Bottom and Height to 65%.

Component 2 has the Dock Position set to Left and Width to 60%.

Component 3 has the Dock Position set to any position such as Right and all other setting were left blank. The Dashboard will automatically dock this last Component to fill the rest of the available space.

Set layout type to Tabs in order to view each Component in its own tab.

By right clicking on a Profile under OnePlace Dashboards on the left in the Navigation Pane, a user can export all the Dashboards in the Profile out to a combined PDF file. Right click and choose Export All Reports in this Profile… and then choose Combined PDF File or PDFs in Zip File. This is a quick and easy way to produce Report books. The only exception is that currently graphs and charts do not export to PDF in these mass forms. 

Dashboard Maintenance Unit Properties

Is Mobile

If set to True, the Dashboards within this Maintenance Unit can be used with the OneStream Mobile Solution. If set to False, the Maintenance Unit may only be used within the OneStream application. This property cannot be changed once the Maintenance Unit is saved.

NOTE: Dashboards intended for OneStream Mobile have Dashboard Component limitations. These limitations are noted under Dashboard Components. Any Dashboard within a Mobile Dashboard Maintenance Unit can be launched from the Application Dashboard screen but cannot be assigned to Workflows or used in OnePlace. 

Dashboard Group Properties

General (Dashboard Group Unit)

Name

The name of the Dashboard group.

Description

A short description of how the Dashboard group is used, or what it contains.

Security

Access Group

Members of this group can access the dashboards in the Dashboards group.

NOTE: Click and begin typing the name of the Security group in the empty field.  As the first few letters are typed, groups are filtered making it easier to find and select the desired group. Select a group, press CTRL and then double-click.

Dashboard Profile Properties

Once a Dashboard group is completed, it is organized into a dashboard profile. Profiles are then assigned to various functions. Click to create a new profile. Click to assign a group to a profile, allowing users to select the groups to be in a profile.   

Dashboard Visibility controls what dashboards are viewed throughout the application.  This is the key property for all dashboard profiles. The options are as follows:  

Never

This is used for dashboards that are expired, or no longer being used.

Always

This allows the dashboard to be available in OnePlace and Workflow.

OnePlace

This allows the dashboard to be viewed in the Dashboard section under the OnePlace tab.

Workflow

This allows the dashboard to be attached to a workflow profile. This can be completed in Workflow Profiles under the Integration and Data Quality Settings. 

Dashboard Properties

General

Name

The name of the dashboard.

Description

A quick description of the dashboard.

Page Caption

This is used to give a name to the dashboard when it is displayed.  The name will be displayed at the top left of the dashboard.   If the Page Caption is left blank, then it will default to the name given to the dashboard.

Dashboard Group

The Dashboard group to which it belongs.

Behavior

Dashboard Type

This indicates how each dashboard within a group is used. It helps reduce the number of groups needed and simplifies dashboard maintenance.

• (Use Default): Default is Top Level.

• Top Level: This dashboard type indicates which dashboards in a group should be visible if assigned to OnePlace or a Workflow.

• Top Level Without Parameter Prompts: This dashboard type has the same behavior as Top Level, but if the dashboard has runtime parameters, it will have a slight performance improvement. It does not prompt for parameters.

• Embedded: This dashboard type indicates which dashboards in a group should not be visible in OnePlace because they are dependent on other dashboard objects.

• Embedded Dynamic: This dashboard type enables you to dynamically modify dashboard properties, component properties, parameters, adapters, and cube view properties. See Dynamic Dashboards.

• Embedded Dynamic Repeater: This dashboard type enables you to dynamically modify dashboard properties, component properties, parameters, adapters, and cube view properties. This dashboard type can be used to add multiple instances of the same component without having to re-create each component individually. See Embedded Dynamic Repeater Dashboard.

• Embedded Top Level: This dashboard type acts as a new top level with its own parameter resolution and rendering stages. As a result, it allows for the Load Dashboard Server Task to be run even when embedded.

  NOTE: Currently, Embedded Top Level dashboards should not be used with Smart Links.

• Embedded Top Level Without Parameter Prompts: This dashboard type acts as a new top level with its own parameter resolution and rendering stages. As a result, it allows for the Load Dashboard Server Task to be run even when embedded. It does not prompt for parameters, resulting in a slight performance improvement.

  NOTE: Currently, Embedded Top Level Without Parameter Prompts dashboards should not be used with Smart Links.

• Custom Control: This dashboard type has the same behavior as Embedded, but each instance maintains its own set of input parameters, variables, and Event Listeners (actions).

Custom Control

A new dashboard type with required input parameters, which is a comma separated list of parameter names that must be provided by the containing dashboard when processing a custom control dashboard. For example, Param 1, Param 2, Param 3. A parameter component inside the custom control forwards events to the parent dashboard.

Formatting

Layout Type

Canvas

A component docks to the top, bottom, right, or left of the dashboard.  The component only shows in the small space defined by the dock position and does not display fully on a screen.  Slide bars are used to view the components.

Dock

A component docks to the top, bottom, right, or left of the dashboard.  Use Dock Position to determine how much of the screen will be used for this layout.

Grid

This allows the ability to make a dashboard in a grid format by using rows and columns to add Components, Lines, or Moveable Splitters.

Horizontal Stack Panel

Each Component will display horizontally.  Horizontal Stack Panel dashboards are generally used as part of other dashboards.

Tabs

Each component will display in its own tab.

Uniform

Each Component is docked, but all are equal in size.

Vertical Stack Panel

Each component will display vertically.  Vertical Stack Panel dashboards are generally used as part of other dashboards.

Wrap

See Canvas

Is initially Visible if Embedded

When set to True, the selected dashboard will be hidden if it is retrieved from another dashboard.  The hidden dashboard can be set to visible from a Parameter component by listing its name in the dashboard to Show property under User Interface Action and selecting Refresh for the dashboard containing the embedded dashboard.

Display Format

This allows unique display formatting per dashboard for background color, dialog width and height, and border formatting.  See "Display Format Settings".

Literal Parameter Values

Name Value Pairs (e.g., Param1=Value1,…)

Enter a comma-separated list of name-value pairs for this dashboard’s static parameter values.  Piped variable names cannot be used in this setting.

Action (Primary Dashboard Only)

Load Dashboard Server Task

Dashboard Extender Rules can run upon launching and refreshing dashboards.  This only applies to the main dashboard, not embedded dashboards.

No Task

A Dashboard Extender business rule is not being used on this dashboard.

Execute Dashboard Extender Business Rule (Once)

This runs the assigned Business Rule once upon refresh or initial launch

Execute Dashboard Extender Business Rule (All Actions)

This does an iterative action and runs the business rule as many times as needed.

Load Dashboard Server Task Arguments

Enter the arguments required by the server task.  When executing a Dashboard Extender business rule, the arguments include {BusinessRuleName}{FunctionName}{Optional Named-Value Pairs} each enclosed in curly brackets.  Click the ellipsis and select the desired argument format and then enter each object.

Example: {DashboardLoadBRName}{TestFunction}{Param1=[Value1], Param2=[Value2]}

Grid Layout Type

This only becomes available if Grid is chosen as the Layout Type.

Number of Rows

The number of rows the dashboard will use for the grid layout.

Number of Columns

The number of columns the dashboard will use for the grid layout.

Row/Column Type

Component

Use the Component option if a Content or Parameter component is needed for the row or column of the grid layout for the dashboard.

Line

Use the Line option if a line is needed for the row or column on the dashboard.

Moveable Splitter

Use the Moveable Splitter option if one is needed for the row or column on the dashboard.  This allows the ability to move the grid up and down, or left and right.

Row/Column Height

Utilize Row/Column Height to customize the sizing of the rows and columns heights and widths to be displayed on the dashboard. Auto expands the size based on the contents of the row. You can use an * to create a fractional value of the remaining space. For example, if there are three rows, then each row will take a third of the space.

Display Format Settings

General

Background Color

This is used to display the background color of one dashboard.

InnerBackgroundColor

This is used to define the background color of a dashboard containing embedded dashboards.

Dialog

DialogDisplayStyle

Controls how a dashboard is sized when viewed as a dialog box. If the specified value exceeds the current screen, the value will be changed to the maximum display setting for height and width to fit to screen.

Specify Maximize or Normal. The default is Normal. Maximize opens using the Dialog Maximize mode to full screen. Normal opens to the defined Dialog Height and Width settings.

DialogWidth

Customize the width of the dialog for the dashboard. The dialog width supports up to 10,000. If set to -1, the size will set at run time to the maximum width for the active screen.

DialogHeight

Customize the height of the dialog for the dashboard. The dialog height supports up to 10,000. If set to -1, the size will set at run time to the maximum height for the active screen.

EnableSystemClose

This is used to control the display and use of the Close button of the dialog. Setting this to True removes the Close button.

Styles

TabControlStyle

Choose from Classic, No Border, or Rounded Corners to define how tabs appear in the application. The tab control functionality remains the same. TabControlStyle is only available in the Windows version.

Dashboard Tabs 

There are three different tab styles that can be selected for dashboards: 

1. Use Default or Classic – The original style for dashboard tabs. 
    

2. No Border – Rounded corners and no borders. 
    

3. Rounded Corners – Rounded on the edges with borders. 
    

These tabs are only available for use with the dashboards and do not apply to the rest of the product. 

Select a Tab 

1. Go to Application > Dashboards and select a dashboard. 

2. Click to open the dashboard and in Dashboard Properties > Formatting make sure the Layout Type is Tabs.  

3. Go to Display Format and click the ellipsis to edit. 
    

4. Click Styles > TabControlStyle and click in the field to get a menu option. If the Layout Type is not set for Tabs, the field is unavailable. 

5. Choose the type of tab for the dashboard. 
    

6. Click OK and then Save. 
   

8. Click View Dashboard. 
    

9. The tabs have no borders. 
    

Border

BorderThickness

This is used to customize the border thickness for the dashboard.

BorderCornerRadius

This is used to customize the border corner shape for the dashboard.  If left blank, the border will be square. 

BorderColor

This is used to customize the outer border coloring for the dashboard.

BorderBackgroundColor

This is used to specify the border background color of a dashboard containing embedded dashboards.

Margin

BorderMarginLeft/Top/Right/Bottom

Used to customize the margin of the border on the dashboard.

Padding

BorderPaddingLeft/Top/Right/Bottom

Used to customize the padding or spacing of the border on the dashboard.

Dashboard Components

General

Name

The name of the dashboard component.

Description

A free form field to enter a description of the dashboard component.

Components

Add Dashboard Component

Use this to add and assign a dashboard component.

Move Up

Use this to move a dashboard component up in the Components list.

Move Down

Use this to move a dashboard component down in the Components list.

Remove Selected Dashboard Component

Use this to remove a selected dashboard component from a Components list.

NOTE: To select and add multiple components, press CTRL and then click to select. Once all items are selected, click OK.

Position on Dashboard

Dock Position

Left/Top/Right/Bottom

Allows the ability to dock a Component in a specific position on the dashboard.

Left

This sets the amount of dashboard space to allocate to the left dock position.

Top

This sets the amount of dashboard space to allocate to the top dock position.

Width

Enter a percentage to set the width of the dashboard.

Height

Enter a percentage to set the height of the dashboard.

Component Display Format Properties

The following properties are available under the Display Format field for Parameter and Content components.  Not all properties in this section are available for all components. For information about parameters, see Filter Runtime Data and Reduce Maintenance with Parameters.

General

Custom Parameters

Click the ellipsis in order to select and assign a custom parameter such as a cube view style to the cube view header. 

IsVisible

This determines if the component is visible on the dashboard.  Settings are True, False, or Use Default.

ShowSearch

This adjusts the behavior of the ComboBox component. When True, the ComboBox retains typed text and auto complete is enabled. When False, typed text is not retained and auto complete is disabled.

HorizontalAlignment

This determines how the component should be aligned horizontally on the area allocated in the dashboard.

Left

The component is aligned on the left of the allocated area.

Center

The component is aligned in the center of the allocated area.

Right 

The component is aligned on the right of the allocated area.

Stretch

The component is stretched to fill the allocated area.

Use Default

Use the default setting for horizontal alignment.

VerticalAlignment

This determines how the component should be aligned vertically on the area allocated in the dashboard.

Top

The component is aligned on the top of the allocated area.

Center

The component is aligned in the center of the allocated area.

Bottom 

The component is aligned on the bottom of the allocated area.

Stretch

The component is stretched to fill the allocated area.

Use Default

Use the default setting for vertical alignment.

Width

The width of the control.

Height

The height of the control.

MarginLeft, Top, Right, and Bottom

The spacing used on the sides of the control.

BorderThickness

The thickness of the border used when displaying the control.

FontFamily

The font type used on the component (e.g., Ariel, Times Roman, etc.).

FontSize

The font size used on the control text.

Bold

If set to True, the font will be bold.

Italic

If set to True, the font will be italicized.

Color

The color of the text displayed in the control.

TextColor

Choose a color from the drop-down options for the control text.

BackgroundColor

Choose a color from the drop-down options for the text background.

BorderColor

Choose color from the drop-down options for the border of the control.

HoverColor

Choose color from the drop-down options to change the hover color of a button dashboard component.

Image

HorizontalContentAlignment

This determines how the image’s content should be aligned horizontally on the area allocated in the dashboard.

VerticalContentAlignment

This determines how the Image’s content should be aligned vertically on the area allocated in the dashboard.

ImageStretch

This setting allows the image to be re-sized when being displayed.

None

This does not re-size the image.

Fill

The image stretched to fill the control.

Uniform

This preserves the aspect ratio of the image.

UniformtoFill

This scales the source image to fit within the bounds of the image object and keeps the source image centered within the image object.

ImageCropLeft, Top, Width, Height

Use these settings to crop and position the image in order to align the desired content appropriately.

Label

LabelPosition

The location where the control label is placed.

None

This does not display a label for the control.

Left

This displays the label to the left of the control.

Top

This displays the label above the control.

Right

This displays the label to the right of the control.

Bottom

This displays the label below the control.

Use Default

Use the default label display location

LabelFontFamily

The font type to use on the label (e.g., Ariel, Times Roman, etc.).

LabelFontSize

The font size to use on the label.

LabelBold

If set to True, the font is bold.

LabelItalic

If set to True, the font is italicized.

Colors

LabelZeroOffsetForFormatting

This holds a number with the default value of 0.0. When a label is being used to display a number, and the number is greater than the number in this field, it will be displayed using the color associated with LabelTextColor.  Otherwise, the number will be displayed using the color associated with LabelNegativeTextColor.

LabelTextColor

Choose a color from the drop-down options for the label text.

LabelNegativeTextColor

Choose a color from the drop-down options for the label’s negative text.

Parameter Components

Parameter components are objects such as a button or list box that, when selected, could drive additional actions, such as opening a different dashboard or running a Custom Calculate.

Custom calculate executed from a Dashboard Parameter component allow the passing of a complete set of name value pairs that align to the dimension Point of View (i.e. Entity=MyEntity,Time=2017M11,Consolidation=Local, etc) and the custom calculation processor will use those variables to initialize the Finance Engine API POV Variables (i.e. api.POV.Entity.Name will equal MyEntity).  All API.POV objects (Cube, Entity, Parent, Consolidation, Scenario, Time, View, Account, Flow, Origin, IC, UD1, UD2, UD3, UD4, UD5, UD6, UD7, UD8) are initialized and available to this function.  This makes it possible to share custom calculation rules with standard consolidation/calculation rules because both rule sets have a fully initialized set of API.POV variables. For consolidation business rules, this POV is related to the data unit. When using a Parameter component with a cube view on the same dashboard, API.POV is related to the 18-dimension POV that is available from each cell rendered. See "Custom Calculate" under Finance Function Types for more information.

Button

This displays a button on a dashboard. Buttons can be used to initiate a variety of functions including business rules, dashboards, file uploads and so on. This component can be used with dashboards.

Formatting

Text:

The text to be displayed with the button. This is an optional field. If left blank, the Text field will default to display the button name. To clear the default Name from displaying, enter |SPACE|.

Tool Tip

The text to be displayed when hovering over the button.

Display Format

The formatting assigned to the control. See Component Display Format Properties.

Image File Source Type

The Image (if any) displayed on the button.

URL

The image displayed on the button is based on a URL.

Workspace File

The image displayed on the button is in a file stored in the Workspace Maintenance Unit File section. 

Application Database File
The image displayed on the button is in a file in the Application Database Share.

System Database File

The image displayed on the button is in a file in the System Database Share.

File Share File

The image displayed on the button is in the File Share.

URL or Full Name File

The URL, file path or file name for the displayed image.

URL Syntax
Access a built-in toolbar image, or use an image from any web server

Built-in OneStream Image Example   /OneStream.ClientImages;component/Misc/ToolbarImage.png.

Web Server Example

http://www.onestreamsoftware.com/img/onestream-logo.png

Database File System Example
Enter the path and file name Documents/Public/TestImage.png.

Workspace File Syntax
Enter the name of the file resource TestImage.png.

The following Excel properties are used to specify an Excel file from either an Extensible Document or Report Book in order to display it as an image or button.

Excel Page Number

Enter the page number of the Excel document to display.

Excel Sheet

Enter the name of the Excel worksheet to display.

Excel Named Range

Enter the named range from Excel to display. The named range must be in the specified Excel sheet in the Excel Sheet property, or the Excel Sheet property must be blank in order to use a named range. See Image under Component Display Format Properties to position and align the Excel image as needed.

Button

Button Type

Specify the functionality to be assigned for the selected button.

Standard

Displays a generic button that can have custom functionality assigned such as display a dashboard, execute a business rule, and so on.

File Explorer

This sets the button to display the File Explorer dialog.

File Upload

This sets the button to display the File Upload dialog.

Select Member

This sets the button to display the Select Member dialog.

Dimension Type

Specify the Dimension Type. This is required.

Use All Dimensions for Dimension Type

When True, it overrides the Cube Restriction and displays all dimension types. When False, the dimensions are limited to defined dimension type.

NOTE: If no dimension type is defined, the selections are reverted to the default dimension type.

Dimension

Specify a specific dimension. This is optional.

Example: HoustonSalesRegionalBudget

Cube

Specify a cube. This is optional.

Member Filter

Specify a Member Filter. This is optional.

Example: U3#Root.TreeDescendantInclusive

Member Filter Builder

This sets the button to display the Member Filter Builder dialogue.

Default Member Filter

Specify default member filter to display upon opening. This is optional.

Example: E#[Total Golfstream]

Workflow

This sets the button for Complete and Revert Workflow, replacing the need for a custom business rule.

Workflow Button Action Type

Select Complete Workflow to enable the Complete action button or Revert Workflow to enable the Revert action button.

Workflow Button Image Type

Select one of the standard button images, Use Button Image to use a custom image, or Not Used to not use a button image.

Action

Bound Parameter

This is the name of the parameter the component will represent. Piped variable names are not available in this setting. The component will use the parameter to get its list of options. The selection will specify a value for the parameter when it is referenced elsewhere via piped variable naming. Click and begin typing the name of the parameter in the blank field.  As the first few letters are typed, the names are filtered making it easier to find and select the one desired.  If the name is unknown, expand a Workspace Maintenance Unit and scroll to identify a parameter. Then press CTRL and double-click. 

Parameter Value for Button Click (Button Component Only)

The value or string to pass into the Bound parameter.

Apply Selected Value to Current Dashboard

If set to True, the Bound Parameter on the current dashboard will use the current updated value or use the value prior to update.  If set to False, the current dashboard will not be updated.

Save Action

Selection Changed Save Action

What occurs when the button is pressed.

No Action

When the Parameter components are changed, changes will not be saved.

Save Data for Components

This will save the data modified by the Dashboard components specified in the Selection Changed Save Arguments property.

Prompt to Save Data for Components

This will ask the user if the modified data should be saved or not for a defined list of Dashboard components.

Save Data for all Components

This will save all data modified by each of the Dashboard components assigned to the dashboard. These components do not have to be specified in the Selection Changed Save Arguments property.

Prompt to Save Data for All Components

This will ask the user if the modified data on any included dashboard component should be saved or not.

Save Data for Components and Save Files

This will save the components modified by the Dashboard components specified in the Selection Changed Save Arguments property and their files.

Prompt to Save Data for Components and Save Files

This will ask the user if the modified data should be saved or not for the defined list of Dashboard components and their files.

Save Data for All Components and Save Files

This will save all components modified by the Dashboard components included in the Dashboard and their files.

Prompt to Save Data for All Components and Save Files

This will ask the user of the modified data should be saved or not for all dashboard components and their files.

Save All Files

This will save all modified file data within the dashboard and exclude saving any modified component data.

NOTE: The Selection Changed Save Argument field is only active when you choose a Selection Changed Save Action that requires you to specify components.

Save Files Properties

You can use these Save Files properties to save edits made in Text Editor and Spreadsheet Component files through a dashboard button. For example, the user has a dashboard containing a spreadsheet and button component, and the developer sets the button component's Selection Changed Save Action property to one of the Save Files options. When the user edits the file data in the spreadsheet component's file and then clicks the dashboard button, all file changes are saved. The dashboard component changes will also be saved. Component changes are only not saved if the Save All Files property is selected, which only saves modified file data. Users can utilize these Save Files properties through button components instead of having to navigate to File > Save in the component's toolbar to save file changes.

Considerations

• Since Text Editor components cannot have nested components, the Save Data For Components And Save files, Save Data For All Components And Save Files, and Save All Files options will only save the Text Editor component's file.

• When working in a spreadsheet component embedded in a dashboard, the Save Files properties enable users to save nested components while also saving the spreadsheet file. When the dashboard button is set to Save All files, only spreadsheet file modifications are saved.

Save As

If the Text Editor or Spreadsheet components are not linked to or displaying an existing file, clicking a button component with the Save File options opens the Save New File Options window. This enables users to save a new file in different locations and performs the same function as the components' File > Save As toolbar button action.

NOTE: If you have already used the button component to Save As and created a new file, when you select the same button component again, the updates made in the dashboard component will save to that initially created file. It will not prompt the Save New File Options window to create a second new file until the user refreshes or reloads the dashboard.

Local Folder

Select location on local computer/network to save a file to.

NOTE: The Save As File on Local Folder option is not available in the Modern Browser Experience.

OneStream File System

Select location within OneStream File Explorer to save a file to.

Application Workspace File

Select Application Workspace location to save a file to.

System Dashboard File

Select System Workspace location to save a file to.

POV Action

Selection Changed POV Action

No Action When Parameter components are changed, no change will be made to the user’s POV.

Change POV

This setting will change the user’s POV to a specified POV when Parameter components are changed.

Change Workflow

This changes the user’s Workflow to a specified Workflow when Parameter components are changed.

Change POV and Workflow

This changes the Workflow and POV to a specified value when Parameter components are changed.

Selection Changed POV Arguments

Enter the arguments for the selected POV action. 

Change POV Example
Cube=Corporate, Entity=|!MyEntityParam!|, Scenario=Actual

Change Workflow Example
Enter a value for WFProfile, WFScenario, and/or WFTime.
WFProfile=|!MyWFProfileParam!|, WFScenario=Actual, WFTime=2012M1

Change POV and Workflow
See above for examples

NOTE: The Selection Changed POV Action must be set to something other than No Action for this change to occur.

Server Task

Selection Changed Server Task

No Task

When Parameter components are changed, no server task is executed.

Execute Dashboard Extender Business Rule (server type)

Executes the assigned Business Rule when Parameter components are changed. For a long-running business rule, it is optionally able to run on a specific server type, such as a Consolidation server type. Here are the options:

• Execute Dashboard Extender Business Rule (General Server)

• Execute Dashboard Extender Business Rule (Stage Server)

• Execute Dashboard Extender Business Rule (Consolidation Server)

• Execute Dashboard Extender Business Rule (Data Management Server)

Execute Finance Custom Calculate Business Rule

Executes a single year custom calculation from a Finance business rule when Parameter components are changed.  The calculation is performed on the cube view assigned to the dashboard Data Adapter and calculates time based on the cube view Time member set in the Point of View. This is considered a partial calculation and does not store the calculated data or run the calculation during a consolidation.  Running a custom calculation from a dashboard will impact calculation status for the affected data unit even if the data does not change.  A calculated dimension member can call this business rule to do a full stored calculation.

See About the Financial Model for an example of this calculation logic.

Execute Data Management Sequence

Executes the assigned Data Management Sequence when Parameter components are changed.

Calculate

Executes a Calculation when Parameter components are changed.

Force Calculate

Executes a Force Calculate when Parameter components are changed.

Calculate with Logging

Executes a Calculate with Logging when Parameter components are changed.

Force Calculate with Logging

Executes a Force Calculate with Logging when Parameter components are changed.

Translate

Executes Translate when Parameter components are changed.

Force Translate

Executes Force Translate when Parameter components are changed.

Translate with Logging

Executes Translate with Logging when Parameter components are changed.

Force Translate with Logging

Executes Force Translate with Logging when Parameter components are changed.

Consolidate

Executes Consolidate when Parameter components are changed.

Force Consolidate

Executes Force Consolidate when Parameter components are changed.

Consolidate with Logging

Executes Consolidate with Logging when Parameter components are changed.

Force Consolidate with Logging

Executes Force Consolidate with Logging when Parameter components are changed.

TIP: For more details on these calculation types, see Data Management in Application Tools.

Selection Changed Server Task Arguments

Enter the Parameter components to which the Save action applies.  If Save Data for all Components or Prompt to Save Data for All Components is selected, this can be left blank.

Dashboard Extender Business Rule Example (each enclosed with curly braces)

{Business Rule Name}{Function Name}{Optional Name-Value Pairs}

Finance Custom Calculate Business Rule Example (each enclosed with curly braces)

{Business Rule Name}{Function Name}{Optional Name-Value Pairs}

NOTE: Name Value Pairs can have settings for Cube, Parent and any Dimension Type.  It can also have a setting for any Time Member Filter including CurrentPeriod, AllPriorInYearInclusive or AllInYear. It can have any other name-value pair for use by the Business Rule since they are passed into the rule using the CustomCalculateArgs object.

Data Management Sequence Example (each enclosed with curly braces)
{Sequence Name}{Optional Name-Value Pairs}

Calculation, Translation or Consolidation Example (each enclosed with curly braces)
{Data Unit Member Script}
{E#|!EntityParam!|:C#Local:S#Actual:T#|!TimeParam!|}

User Interface Action

Selection Changed User Interface Action

No Action

When Parameter components are changed, no user interface action is executed.

Redraw

This repaints the screen without making a connection to the database acquiring updated data.

Refresh

This refreshes the dashboard specified in the Dashboards to Redraw property which makes a connection back to the database acquiring all new data.

Close Dialog

This closes the dialog upon performing a specified action in a dashboard.

Close Dialog As OK

This closes the dialog after the user clicks OK.

Close Dialog As Cancel

This closes the dialog after the user clicks Cancel.

NOTE: The refresh of the parent dashboard is based on performing a specified action setup in a dashboard. For example, if a dashboard is set to "Open Dialog With No Buttons and Refresh," the "Close Dialog As OK" will refresh the parent dashboard and run the UI action.

Close All Dialogs

This closes all open dialogs upon performing a specified action in a dashboard.

Open Dialog

Opens a Dashboard in a modal window.

Open Dialog With No Buttons

Performs an Open Dialog action and does not display the Close button.

Open Dialog With No Buttons and Redraw

Performs an Open Dialog, allows the user to apply changes, and then Redraw without displaying the close button.

Open Dialog With No Buttons and Refresh

Performs both an Open Dialog & Refresh action without displaying the close button.

Open Dialog and Redraw

Performs both an Open Dialog & Redraw action.

Open Dialog and Refresh

Performs both an Open Dialog & Refresh action.

Open Dialog, Apply Changes, and Redraw

Performs an Open Dialog, allows the user to apply changes, and then Redraw.

Open Dialog, Apply Changes, and Refresh

Performs an Open Dialog, allows the user to apply changes, and then Refresh.

Open Dialog, Apply Changes, and Redraw if OK

Performs an Open Dialog, allows the user to apply changes, and then Redraws once the user selects OK.

Open Dialog, Apply Changes, and Refresh if OK

Performs an Open Dialog, allows the user to apply changes, and then Refreshes once the user selects OK.

Dashboards to Redraw

Comma separated list of embedded dashboards to redraw when the user changes the selection in this Parameter Component.

Dashboards to Show

Comma separated list of embedded dashboards to make visible when the user changes the selection in this Parameter component.  This is typically used when multiple Parameter components are needed to collect settings to display an embedded content dashboard.  After the last selection has been made, that Parameter Component will show the previously hidden embedded content dashboard.

Dashboard to Hide

Comma separated list of embedded Dashboards to hide when parameter components are changed.

Dashboards to Open in Dialog

Single Dashboard to open in a modal dialog when the selected button is clicked.

Dialog Initial Parameter Values

Enter a comma separated list of name-value pairs to specify initial parameter values for the opened dialog. For example: DlgParam1=Value1, DlgParam2=[Value 2].

Dialog Input Parameter Map

Enter a comma separated list of name-value pairs to map parameter names used by this component’s dashboard to parameter names used by the opened dialog. For example, DlgParamName1 = This ParamName1, DlgParamName2=ThisParamName2. When the dialog is opened, the names of the parameters adjust to accommodate the dialog.

Dialog Output Parameter Map

Enter a comma separated list of name-value pairs to map parameter names modified by the closed dialog to parameter names used by this component’s dashboard. For example, ThisParamName1=DlgParamName1, ThisParamName2=DlgParamName2. When the dialog is closed, the names of the parameters adjust to accommodate this component’s dashboard.

Navigation Action

Selection Changed Navigation Action.

No Action

No navigation action is performed when Parameter components are changed.

Open File

When Parameter components are changed by a user, a new file will open. This is specified in the Selection Changed Navigation Arguments field.

Open Page

When Parameter components are changed by a user, a new page will open. This is specified in the Selection Changed Navigation Arguments field.

Open Website

When Parameter components are changed by user, a website will open in a new browser. This is specified in the Selection Changed Navigation Arguments.

Selection Changed Navigation Arguments

Enter the arguments for the selected navigation. 

Open Page Example
Specify the page name followed by a colon and the page type’s arguments separated by two ampersands
XFPage=Dashboard:NameofDashboard or XFPage=Workflow:NameofWorkflow 

Open Page in New Tab Example

An option in the Open Page Navigation type allows dashboards launched from within a dashboard to launch into a new tab. Valid values are True and False.

XFPage=Dashboard:MyDashboardName, OpenInNewXFPage=True

Open File or Website Example

Specify the file source type (e.g., Dashboard, Application, System, FileShare or URL) and the file name.  Also use PinNavName=True/False or PinPOVName=True/False to open or close the Navigation or POV panes.
FileSourceType=FileShare, FullFileName=Document/Public/NameofFile, OpeninXFPageIfPossible=False 

NOTE: Click and begin typing the argument string in the blank field.  As the first few letters are typed, the names are filtered making it easier to find and select the one desired.  If the name is unknown, scroll through the list to select the correct one. Once the argument string is selected, click CTRL and Double Click.  This will enter the correct string into the appropriate field. 

Chart (Advanced)

See Advanced Chart Examples in Presenting Data With Extensible Documents for some examples on the Diagram Types and associated properties.

Action
See Button.

Diagram Type

Polar2D

This is used to display data as a circular graph and displays values on the basis of angles.

Radar2D

This is used to display data as a circular graph and has multiple axes along which data can be plotted.

Simple2D

This is commonly used to compare percentage values of different point arguments in the same series.

XY2D

This is commonly used to show filled areas on a diagram.  Values can be used separately or aggregated.

NOTE: The properties below do not apply to all of the Diagram Types.

Show Toggle Size Button

This controls whether the toggle icon displays on the Dashboard at runtime.

Swap Axes

If set to True, this exchanges the X-axis with the Y-axis.

Domain Color

This is the chart’s background color.

Show Point Labels

If set to True, this displays data values above each data series on the chart.

Point Label Text Format

Within curly braces enter a Value Identifier and optionally a colon followed by a Format String. The Value Identifier can be S for series name, V for value, or A for argument (argument is typically used for the X-axis text format). Format Strings specify how to display the series name, value, or argument.

For example, to display a value to two decimal places enter {V:0.00} where 0.00 is the Format String.  Another common example is {V:0,,M} which will display the value in the millions or {V:0,T} which will display the value in thousands. 

In order to apply a standard number format to a value enter {V:NumberFormat}. 

For example, {V} displays a value as follows:

Applying a number format after the colon displays the value in a desired format.
{V:#,###,0}

Any text written within the curly braces after the Format String will be displayed as text. Additionally, any text written before or after the curly braces will also be displayed as text. Refer to MSDN's topic on Format Strings for additional information.

Enable Animations

This controls how the chart renders at runtime.  Set this to True to include chart animations upon launching the dashboard.

Show Border

Set this to True in order to display a border around the chart.

Use Clockwise Rotation

Set this to True to display the legend in clockwise order.

Show Legend

Set this to True in order to create and display a customized legend for the Dashboard chart.

Title

Enter the legend title.

Vertical/Horizontal Position

This controls where on the screen the legend will display.

Orientation

This determines whether the legend displays vertically or horizontally.

Show Check Boxes

If set to True, this creates a check box next to each legend item.  Users can then uncheck/check specific data points in order to hide/display them while viewing the dashboard chart.   

Show Border

Set this to True in order to display a border around the legend.

Crosshair Enabled

A crosshair is similar to a point label, but only displays when the user hovers over the data series.  Set this to True, in order to enable the crosshair function.

Show Crosshair Lines

Identifies where the axis hits per data point.

Show Crosshair Labels

This displays the crosshair data in a pop-up box.

Crosshair Label Mode

Show Common for all Series

This displays the crosshair data for the entire chart no matter where the user is hovering.

Show for Each Series

This displays crosshair data for each series simultaneously.

Show for Nearest Series

This only displays crosshair data when the user is hovering on a specific series.

Crosshair Label Text Format

See Point Label Text Format.

Show X-Axis/Show Y-Axis

Set this to True in order to display the X and Y-axis.  To disable either axis, set the appropriate property to False.

Title

Enter a title for each axis.

Argument Type (X-Axis Only)

This specifies the type of information feeding into the chart’s arguments.

DateTime

Use this if dates are included in the arguments.  This causes the chart’s x-axis to be continuous meaning the x-axis ticks are independent of the point’s argument.

Double

This causes the chart’s x-axis to be continuous meaning the x-axis ticks are independent of the point’s argument.

String

This causes the chart to be discrete meaning the axis ticks are dependent on the point’s arguments.

Text Format

See Point Label Text Format.

Label Rotation Angle

Enter a value to rotate the X or Y-axis labels.  The default is 0 resulting in no label rotation.

Logarithmic

Setting this to True will force the axis values to follow a logarithmic pattern specified in the Logarithmic Base property below.

Logarithmic Base

Set the Logarithmic Base value.  For example, logarithmic values with base 10 yields the axis values 0, 1, 10, 100, 1000, 10000, etc.

Use Automatic Range

If this is set to True, this sets the minimum and maximum values automatically depending on the points contained in the chart.  In order to customize the minimum/maximum value, set this to False and specify the values in the properties below.

Minimum/Maximum Value

Specify the minimum and maximum range values.

Use Automatic Step

Set this to True in order to create the tick marks by certain interval values automatically.  Set this to False to specify the specific intervals for the tick marks.

Step

Specify the intervals for the tick marks.

Reverse Order

By default, the order of values on a chart begins at the bottom and works its way to the top, so the first color in the legend is the bottom value's color.  Setting this property to True will reverse that order. When the order is reversed, the values are displayed top to bottom, thus following the order of the legend.

Interlaced

Set this to True for the chart’s domain color to alternate between the interlaced color.  If this is set on the x-axis, the color will display horizontally.  If this is set on the y-axis, the color will display vertically.

Interlaced Color

Enter the desired interlaced color.

Show Grid Lines

Set this to True to display grid lines at each data point on the axis.

Show Minor Grid Lines

Set this to True to display grid lines at each tick mark on the chart’s axis.

Polar2D Types

PolarArea

The data series displays as a filled area on a circular diagram.

PolarLine

The data series displays in a continuous line on a circular diagram.

PolarPoint

The data series displays in a series of small circles on a circular diagram.

Radar2D Types

RadarArea

The data series displays as a filled area on a circular grid with multiple axes along which data can be plotted.

RadarLine

The data series displays as a line on a circular grid with multiple axes along which data can be plotted.

RadarPoint

The data series displays as a series of small circles on a circular grid with multiple axes along which data can be plotted.

Simple2D Types

Funnel

A funnel chart displays a wide area at the top, indicating the total points' value, while other areas are proportionally smaller.

NestedDonut

This is similar to a Doughnut Chart but compares the data with one doughnut nested in another one.

PieAndDonut

This is used to compare the percentage values of different data points in the same series.

XY2D Types

AreaRange

This displays the data series as filled areas on a diagram, with two data points that define minimum and maximum limits. This chart is used to illustrate the difference between start and end values.

BarRangeOverlapped/Waterfall

This displays either vertical or horizontal bars along the Y axis (the axis of values). Each bar represents a range of data with two values.  This chart type is used to show activity from different data series one above another to compare.

BarRangeSideBySide/Waterfall

This displays either vertical or horizontal bars along the Y axis (the axis of values). Each bar represents a range of data with two values. This chart type is used to show activity from different data series grouped by their settings.

BarSideBySide

This displays the data series as individual bars where the height of each bar is determined by the data value.

BarSideBySideFull/SideStacked

This can stack different bars and combine them into groups displayed side-by-side across the same axis value.

LineScatter

This is a type of Line Chart where the data points are connected by a continuous line.

LineStep

This is used to display to what extent values have changed for different points in the same series.

Point

This is used to show points from two or more different series on the same chart plot.

Stock

This is used to show variation in stock prices over the course of time.

NOTE: See Chart (Basic) under Content Components for all other XY2D Chart Types.

Model Display

Change the look of the series by choosing between three tiers (Basic, Moderate, Advanced) to determine which preset model the chart series will use.  Selecting Moderate or Advanced provides a more enhanced view of the chart.

Show Markers

This is used in conjunction with Line Charts to display a circular marker at each end of the line.  Set this to True to display line markers.

Marker Size

Enter a value for the marker size.  Values are entered in pixels.

Bar Width

This is used in conjunction with Bar Charts.  Enter a value to control the width of each bar on the chart.

Line Thickness

Enter a value measured in pixels to control the line thickness displayed in a Line Chart.

Line Style Type

This determines whether a Line Chart will display Solid or Dashed lines.

Pie Hole Radius Percent

This is used in conjunction with Pie and Donut Charts and controls how large the middle hole is.  A 0 value will result in no hole.

Series 1-10 Color

Select a color for each Data Series.  For example, if a chart is displaying data for an Actual and Budget Scenario, data displayed for Actual would be one data series and data displayed for Budget would be a second data series.  In this example, a color can be entered into Series 1 Color and Series 2 Color.  By default, the order of values on a chart begins at the bottom and works its way to the top, so the first color in the legend is the bottom value's color.  See the Reverse Order property for details on changing this order.

Series 1-10 Point Colors

Enter a color for the data points within a specific data series.  If there are several data points and each one needs to be a different color, enter a comma separated list of colors.  If there are more data points in the series than specified colors, the data points will cycle through the colors and repeat as needed.

Data Series Source Type

Cube View

A Cube View from the chart’s Data Adapter is being used as the data source.

Business Rule

A Dashboard DataSet Business Rule from the chart’s Data Adapter is being used as the data source.  Utilizing a Business Rule gives more control to the chart’s data series and provides additional customized settings.

Suppress Zeros

If set to True, this removes all results that are zero. 

Row List Type

This specifies the rows to include from the chart’s Data Adapter.

All Rows

The chart will include all rows.

First Row

The chart will only include the first row.

Row Index List

The chart will include the list of rows specified in the Row Index List field.

Row Index List

Enter the list of rows to include in the chart.

Cube View Data Point Legend Type

Default

The legend text comes from the row headers.

Annotation

The legend text comes from the Annotation View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Assumptions

The legend text comes from the Assumptions View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Audit Comment

The legend text comes from the AuditComment View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Footnote

The legend text comes from the Footnote View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Variance Explanation

The legend text comes from the VarianceExplanation View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Check Box

This provides a small box that when selected is filled with a check mark.  This component can be used with dashboards.

Formatting
See Button.

Action
See Button.

Cube View

Use this component to attach a Cube View to a dashboard. 

Cube View
Click the and select the desired Cube View Name.

Show Header

Select True in order to display the Cube View’s Page Caption, select False in order to hide it.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Actions

For all Action settings and examples, see Button earlier in this section.

NOTE: In order to enable Component Actions, the Cube View must have Navigation Link Parameter(s) configured otherwise, the actions will not function.

Combo Box

This displays a drop-down list of strings.  This component can be used with dashboards.

Formatting
See Button.

Action
See Button.

Gantt View

This is a graphical illustration of a schedule over time and is used for relational or hierarchical data (non-Cube data).  This component can use a SQL query to query the data, but in order to fill these components with data, a Dashboard Data Set Business Rule must be used within a Data Adapter. The Business Rule must use an XFGanttTaskCollection object that helps the user convert a normal data source into the object-based data source required to feed these new hierarchical components. See Gantt View Component Business Rule Example in Implementing Security for an example of the Dashboard Data Set Business Rule. 

Action
See Button.

Show Header

When set to True, the grid Name/Description will display as the Component’s header on the Dashboard, when set to False, it will be hidden.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Grid View

This displays data from a Data Adapter in a grid.  Similar to the SQL Table Editor, but data is not editable. 

NOTE: The Grid View dashboard component should not be used for large data sets as it is not a component that uses paging.  In this instance a "SQL Table Editor" component should be used to display the data to the end user and it will use paging to return the full data set.

Grid View Multiselect

Allow Multiselect will generate the Bound Parameter as a comma delimited list.

Use one of the following selection methods:

• Select all rows with the Select All checkbox.

• Select multiple rows using the Shift key.

• Select individual rows with Ctrl-click or select each row individually.

Deselect each row individually or click the Deselect All toolbar button.

Show Column Settings Button

Shows (if set to True) or Hides (if set to False) the Column Setting Button which allows user to reorder and set visibility of columns.

Formatting
See Button.

Action
See Button.

Grid View

Table Name

The name of the table created in the data Parameter.

Show Header

When set to True, the grid Name/Description will display as the Component’s header on the Dashboard, when set to False, it’s hidden.

Show Column Settings Button
When set to True, Column Setting will show on the Dashboard, if set to False, it’s hidden. 

Allow Column Reorder

When set to True, you can drag columns and put them in a different order, if set to False, you can’t drag them to put them in a different order. 

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Show Group Panel

When set to True, the column grouping option will be shown on the Dashboard.  Active users can drag and drop column headers to a group area to apply grouping on the data in the grid.  If set to False, it’s hidden.

Show Row Headers

When set to True, the grid row headers will be shown on the Dashboard, if set to False, it’s hidden.

Show Column Headers

When set to True, the grid column headers will be shown on the Dashboard, if set to False, it’s hidden. 

Show Horizontal Grid Lines

When set to True, the horizontal grid lines will be shown on the Dashboard, if set to False, it’s hidden. 

Show Vertical Grid Lines

When set to True, the vertical grid lines will be shown on the Dashboard, if set to False, it’s hidden. 

Default for Columns are Visible

If set to True, all columns will be hidden unless overridden on an individual column.

Retain Table Column Order

Default value which allows reordering of the columns displayed.  If this setting is True, then the column order can be changed via the Grid View Column Format section.

Column Name for Bound Parameter

Specify the name of the database column to be used to change the value of the Bound Parameter when a database row is selected. This is used when a SQL Table Editor is being used to affect the display of other Dashboard components.  (e.g., when showing detailed information for the selected row.)

Save State

Enables User Preferences for Column: Order, Visibility, Filtering, Sorting and Width.  If this setting is True, then the column activity can be changed and saved via the Grid View Column Format section.

Vary Save State By

Apply Vary Save State By to workflow profile settings and scenario. The current Save State elements will have the control state tied to the current Workflow Profile and Workflow Scenario settings. If you select Falseor Use Default, Vary By Save State will not apply.

When Vary Save State By is enabled, the related Dashboard Component will have the additional reset option of Reset All States, which can be used to clear the user's Save States across all the Vary Save State By parameters.

Grid View Column Format

Column Name

Column name from the table where the selected formatting is to be applied.  Specified name must match the column name from the table exactly.

Description

Column description to be displayed.  By default, the column name from the table is displayed.

Column Display Type

Standard

This displays the default data in the column.

OneStreamClientImage

This replaces the data in the column with the associated image.

WorkflowStatusImage

This replaces the data in the column with the associated Workflow status indicator image.

IsVisible

Setting to override the default Columns Visible setting. Settings are True, False, or Use Default.

ParameterName

The assigned Parameter name to be used to store the Parameter value from the specified column.

Background Color

Background color to be displayed on the selected column.  Choose color from drop down options.

IsGroupable

This determines whether the column can be used in the Group panel on the grid.  Settings are True or False.

IsFilterable

This setting, located at the top of the column, turns the filter button on and off. Settings are True or False.

ShowDistinctFilters

This setting turns the filter option on and off, which enables users to click check boxes to select filtered Members.  Settings are True or False.

ShowFieldFilters

This enables and disables advanced filtering on the specified column.  Settings are True or False.

IsSortable

This enables and disables sorting on the specified column.  Settings are True or False.

IsMultilineText

This setting allows columns to display data on mulrows if the column is not wide enough to display the full value. Settings are True or False. 

TIP: The data will wrap on string spacing.  If there are no blank spaces, the column data will not wrap.  Additionally, keyed fields cannot be wrapped.

DataFormatString

Specify a number and date format to the data in the column.  For example, mm/dd/yyyy will return the current Month/Day/Year using a slash.  MM-dd-yyyy will return the Month-Day-Year using a dash.  N0 will return a number without a decimal point, and #,###,0 will return a number without a decimal and a comma depicting the thousandth place.  See Application Properties in Application Tools for more examples of number formats.

Width

Specifies the default column width to be displayed.

Drag and Drop

You can rearrange the columns, drag and drop the headers, and sort the columns.

If Save State is True, changes to headers and columns ware saved.

If Save State is False and you view the dashboard, you can’t drag and drop headers. Click Column Settings to open the Column Settings window.

You can hide columns and change the order that the columns are shown on the dashboard.

Reset State

When you view a dashboard, you can right click Reset State to go back to the default settings of the grid view component.

Sort Column

When you click on a column header it will sort the column:

• first click, ascending order,

• second click, descending order,

• third click, no sorting order.

If Save State is set to True, the changes to the sort order will be saved.

Filter

When a new filter is applied to the grid, the filter icon is orange to show that it has been changed.

List Box

This component displays a vertical list of predefined strings that are contained in a box and can be configured to allow single or multiple selections.

See Formatting and Action.

Map

The Map Component is used to display specific locations on a geographical map via a Dashboard DataSet Business Rule.  Within each location, users can pass in Parameters in order to perform specific actions and display additional data.  Map components can only display data via a Dashboard DataSet Business Rule using the XFMapItemCollection objects.  Define the data set in the Business Rule, assign the rule to a Data Adapter, and the Data Adapter to the Map Component.  See Map Dashboard Component Business Rule Examples in Implementing Security for examples on using this component.

Action
See Button.

Show Toggle Size Button

This controls whether the toggle icon displays on the dashboard at runtime.

Display Type

Humanitarian

This displays all countries/states/cities in English. The geographical location labels display smaller than Standard and Transport.

Standard

This displays all countries/states/cities in the respective local language. The map displays geographical location labels and road lines.

Transport

This displays all countries/states/cities in the respective local language. The map displays major cities with large labels.

Zoom Level

Enter the zoom value to which the map will open upon running the dashboard.

Center Latitude/Longitude

Enter the GPS coordinates to use upon launching the dashboard.

NOTE: To define the exact GPS coordinates refer to a GPS coordinate website.

Member Tree

This component displays dimensional hierarchies represented in a tree view. The dimensional hierarchies are passed to the component by adding a Bound Parameter and are filterable based on the component's configuration using a Member Filter.

See Formatting and Action.

NOTE: When adding a Bound Parameter, the only valid Parameter Type for the Member Tree is Member Dialog.

Radio Button Group

This displays a choice of mutually exclusive related options where users can only choose one. This component can be used with dashboards.

Formatting
See Button.

Action
See Button.

Supplied Parameter

This is a control that holds a Parameter value for use on a Dashboard, but it will not be displayed.  This component can be used with dashboards.

Bound Parameter
See Button.

Text Box

This provides a box for entering text. 

Formatting
See Button.

Action
See Button.

Allow Rich Text

Set this to True to enable special formatting options such as font, color, alignment, and more. Set this to False for a plain text box without formatting options.

Enable Spell Check

Set this to true to display spell check options in the toolbar when Allow Rich Text is set to True. Set the Text Box's Spell Check toolbar button to Not Used to not display red lines underneath misspelled words or the Spell Check right-click options. Enable Spell Check only works when English is selected in Windows for International users.

Multiline
Set this to True for word wrap or to click Enter and go to the next line. Set this to False for one string of text.

Tree View

This provides a graphical illustration of hierarchical data. This is used for relational or hierarchical data (non-Cube data).

Action
See Button.

Content Components

This section contains information for the following content components:

• BI Viewer

• Show or Hide Borders

• Charts, both Basic and Advanced

• Data Explorer

• Dynamic Grid

• File Viewer

• Image

• Label

• Password Box

• Pivot Grid

• Sankey Diagram

• Dashboard Filter Editor

• Text Editor

• Text Viewer

• Date Selector

• Report

• SQL Table Editor

• Embedded Components

• Text Box

• Menu Component

BI Viewer

This is an Interactive Dashboard Engine that is used to quickly create a Business Intelligence (BI) visualization of data from existing or new Data Adapters. The user can quickly create BI Dashboards that will allow the user to visualize and analyze data.

The BI Dashboards are a powerful tool and allow the user to dynamically add data and build Charts, Gauges, Maps, Grids, Cards. Etc. This BI component integrates well with the cube view MD Data adapter, allows the user at design time to; Add Calculated fields to the Data Source to create new fields and measures, design a path for Drill Down, Multi-Select filtering and Conditional formatting for dynamic viewing at runtime and provides the ability Customize Palette Colors.

Key Elements of the BI Viewer

• Compatible with existing dashboards

• Simple to build, share, and reuse components

• Fast drag and drop ad hoc data exploration

• Easily combine OneStream and non-OneStream data

• Bring trusted, validated OneStream data to the masse

Key Items for a Quick Start

• Data Adapter – used to source the data and render the dataset

• BI Viewer Component – to design the dashboard

• Dashboard Component – to display the BI Dashboard

• Literal Parameter (optional) – to store the color palette

Show or Hide Borders

To use borders to separate areas on dashboards, select Component Properties > BI Viewer and set Show Borders to True. 

For example:  

If Show Borders is False, borders are not displayed. For example:

Additional information on the use and design elements of BI Viewer can be found in the BI Viewer Design and Reference Guide.

Book Viewer

This is used to display a Report Book in a Dashboard.  This Component is not compatible with Mobile Dashboards.

File Source Type

Dashboard File

Display a Book stored in a Dashboard Maintenance Unit File section. 

Application/System Database File

Display a Book stored in the Application or System Database Share. 

File Share File

Display a Book from the File Share. 

Full File Name

The name of the Book.  Click the ellipsis and browse to the desired Book’s file name.

Show Header

Select True in order to display a header derived from the Component’s Name or Description.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Initial Content Item

Enter a number to navigate to a specific page in the Report Book when the Dashboard runs.

Chart (Basic)

This is used to display a chart in a Dashboard.  This Component can be used with Mobile and Application Dashboards.

NOTE: OneStream has intentions to deprecate the Basic Chart Dashboard Component targeted for 2026 R3. We recommend all customers analyze their applications to determine if any dashboards are utilizing the Basic Chart. Any affected Dashboards should make use of the more versatile, and browser-compatible, Advanced Chart, or BI Viewer Components.

Chart Type

Area

An area chart or area graph displays graphically quantitative data and it is based on the line chart. The area between axis and line are commonly emphasized with colors, textures and hatchings. Commonly, two or more quantities are compared with an area chart.  Area charts are used to represent cumulated totals using numbers or percentages over time. Use the area chart to show trends over time among related attributes.

Bar

A bar graph is a chart that uses vertical bars to show comparisons among categories.  One axis of the chart shows the specific categories being compared, and the other axis represents a discrete value.

Bubble

A bubble chart is a variation of a scatter chart in which the data points are replaced with bubbles, and an additional Dimension of the data is represented in the size of the bubbles.

CandleStick

A candlestick chart is a combination of a line and bar chart, in that each bar represents the range of price movement over a given time interval.

Doughnut

A doughnut chart is functionally identical to a pie chart, except for a blank center and the ability to support multiple statistics as one.

Horizontal Bar

A horizontal bar graph is a chart that uses horizontal bars to show comparisons among categories. One axis of the chart shows the specific categories being compared, and the other axis represents a discrete value.

Horizontal Stacked Bar

A horizontal stacked bar chart stacks multiple data points in each bar on the chart instead of a single data point.

Line

A line chart displays information as a series of data points connected by straight line segments.

Pie

A pie chart is a circular chart divided into sectors, illustrating numerical proportion

Range

The range chart displays a range of data by plotting two Y values per data point, with each Y value being drawn as a line chart. The range between the Y values can then be filled with color.

Scatter

A scatter chart displays numerical values along the horizontal and the vertical axis, combining these values into single data points that are displayed in uneven intervals.

Spline

A spline chart is a specialized form of a line chart. Unlike conventional charts which connect data points with straight lines, a spline chart draws a fitted curve through the data points.

Spline Area

A spline area chart is a specialized form of an area chart. Unlike conventional charts which connect data points with straight lines, a spline chart draws a fitted curve through the data points.

Spline Range

The spline range chart displays a range of data by plotting two Y values per data point, with each Y value drawn as a line chart. The range between the Y values can be filled with color.

Stacked Area

The stacked area chart stacks two or more data series on top of one another.

Stacked Area 100

The stacked area 100 chart displays multiple series of data as stacked areas. The cumulative proportion of each stacked element is always 100% of the Y axis.

Stacked Bar

A stacked bar chart stacks multiple data points in each bar on the chart instead of a single data point.

Stacked Bar 100

A stacked bar 100 chart displays multiple data series as stacked bars where the cumulative proportion of each stacked element always totals 100%.

Stacked Line

A stacked line chart has lines that do not intersect because they are cumulative at each point.

Stacked Spline

A stacked spline chart has lines that do not intersect because they are cumulative at each point.

Stacked Spline Area

A stacked spline area chart is very similar to a spline chart. Data is displayed using different colors in the "area" below the line. Each series of points is represented with a different color.

Stacked Spline Area 100

The stacked spline area 100 chart is a variation of the spline area chart. The areas are stacked so that each series adjoins, but does not overlap the preceding series. This chart displays contributions for each data point to the category as a percentage that totals to 100%.

Stick

A stick chart is a combination of a line and bar chart.

Waterfall

A Waterfall chart is a visualization of the sequence of positive and negative values that arrive at a final value.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Show Legend

If set to True, a legend containing a list of the variables will appear in the chart and an example of each appearance. This information allows the data from each variable to be identified in the chart.

Legend Title

The text to be displayed under the legend.

Legend Position

The location of the legend in relation to the chart.  The options are Bottom, Left, Top, Right.

Chart X/Y Axis

Title

The title for the horizontal axis of the chart.

Label Rotation Angle

The angle to display the X Axis & Y Axis labels.

Use Automatic Range

If set to True, it automatically determines the range of values to display on the X & Y Axis based on the values being shown in the graph, if set to False, it needs to be set manually in the following fields. 

Minimum Value

Manually set the X & Y Axis starting value.  This can only be set if Use Automatic Range is False.

Maximum Value 

Manually set the X & Y Axis maximum value.  This can only be set if Use Automatic Range is False.

Step

Manually set the change in values displayed on the X & Y Axis.  This can only be set if Use Automatic Range is False.

Chart Data

Data Series Source Type

The Data Source for the chart.

Cube View

A Cube View from the chart’s Data Adapter is being used as the data source.

One Column Multiple Rows

One column and multiple rows from the chart’s Data Adapter are being used for the data source.

One Row Multiple Columns

One row and multiple columns from the chart’s Data Adapter are being used for the data source.

Suppress Zeroes

If set to True, this removes all results that are zero. 

Row List Type

This specifies the rows to include from the chart’s Data Adapter.

All Rows

The chart will include all rows.

First Row

The chart will only include the first row.

Row Index List

The chart will include the list of rows specified in the Row Index List field.

Row Index List

Enter the list of rows to include in the chart.

Column List Type for X Axis

This specifies the columns from the Data Adapter to include in the chart’s X axis.  When the Data Series Type is set to Cube View, all columns are included.

Column List

A specified list of columns used as X Axis types for the chart.  These columns are entered in the Column List for X-Axis field.

All Columns

All columns are used as X-Axis Members.

All Numeric Columns

All columns with numeric values are used as X-Axis Members.

Column List for X Axis

The column names used as X-Axis Members.  This field is only used when Column List is selected as the Column List Type for X Axis.

Use Column Headers for X Axis

If set to True, the column names are used as X-Axis Members, if set to False, the values/text in the named column are used as X-Axis Members.

Column List Type for Data

This specifies the columns from the Data Adapter to include in the chart.  When the Data Series Type is set to Cube View, all columns are included.

Column List

A specified list of columns used as Data Sources for the chart.  These columns are entered in the Column List for Data field.

All Columns

All columns are used as Data Sources.

All Numeric Columns

All columns with numeric values are used as Data Sources.

Column List for Data

The column name containing the data to display in the chart.  This field is only used when the Column List Type field for Data is set to Column List.

Cube View Data Point Legend Type

Default

The legend text comes from the row headers.

Annotation

The legend text comes from the Annotation View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Assumptions

The legend text comes from the Assumptions View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Audit Comment

The legend text comes from the AuditComment View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Footnote

The legend text comes from the Footnote View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Variance Explanation

The legend text comes from the VarianceExplanation View Member in the Cube View instead of the default.  The Data Adapter must include this information for this option.

Column for Legend Label

The legend text comes from the column name specified here. 

Legend Labels List

Comma separated strings used in the legend to identify the data series.

Chart (Advanced)

This Component can be used with Mobile and Application Dashboards to display charts.

Series Type

Waterfall

A waterfall chart (also known as a Walk or Bridge chart) is a type of chart that provides a visual story of the net changes of values between two identified points, such as starting and ending values in income statements, balance sheets, and operational expenses. You can build a waterfall chart with data supplied in a particular format from a Data Adapter. You can also convert existing BarRangeSideBySideWaterfall charts to the new waterfall chart type.

Waterfall charts display net changes of a single value per bar. They provide positive variance values above the bar and negative variance values below the bar, as shown in the following image.

When you select the Waterfall type chart, the Waterfall Series Properties section provides configurations specific to the Waterfall chart:

• Start Bar Color: Sets the color of the first bar in the series.

• Total Bar Color: Sets the color of the bar that represents a Total.

• Rising Bar Color: Sets the color of all bars whose values are positive (but are not Start or Totals).

• Failing Bar Color: Sets the color of all bars whose values are negative (but are not Start or Totals).

• Total Included in Series: Indicates if the data source includes a total value (a sum). If set to TRUE, the chart identifies the last value in the data source as a Total bar on the chart. If set to FALSE, the chart auto-calculates a sum and adds the result as a Total bar on the chart.

• Total Value Label: Sets the label of the Total bar.

• Include Subtotals: Indicates auto-calculated subtotals added to the waterfall chart. If set to TRUE, you can indicate where you would like to place the subtotal bar(s). If FALSE, no subtotals are defined. Default is False.

• Subtotal Indexes: Enter a comma separated list of number(s) to indicate where you would like your subtotal bar(s) to be placed. For example, to display a subtotal after your first delta value, you would enter 1. You can also enter 2,4 for example, which would display a subtotal after the second delta value and also after the fourth delta value. These numbers count the delta values.

• Subtotal Labels: Enter a comma separated list of labels for each subtotal. Each label needs to have unique text. The number of labels must equal the number of subtotal indexes specified. If nothing is listed, defaults to “Subtotal 1,” “Subtotal 2,” “Subtotal 3,” and so forth.

• Subtotal Bar Color: Sets the color of bar(s) that represent a subtotal. Defaults to XFDarkBlueBackground.

• Label Position: Sets the position of the bar labels. Default is Auto. Options include:

  • Auto: Labels are placed above the bar for rising values and below the bar for falling values.

  • Center: Labels are placed in the center of the bars.

  • InsideEnd: Labels are placed on the inside bottom of the bar for falling values and on the inside top of the bar for rising values.

  • InsideStart: Labels are placed on the inside bottom of the bar for rising values and on the inside top of the bar for falling values.

Create a Waterfall Chart

1. From the My Company Name, LLC Application tab, click Dashboards.

2. Expand Dashboard Maintenance Units and then expand the appropriate maintenance unit.

3. Click the Components label and then, from the toolbar, click Create Dashboard Component.

4. In the Create Dashboard Component dialog, click Chart (Advanced) and then click OK.

5. In the Name field, type a name for the new waterfall chart.

6. Scroll down to the Series Properties section and select Waterfall in the Type field.

7. Click Save.

If you have an existing BarRangeSideBySideWaterfall chart type, you can change it to waterfall by selecting Waterfall in the Type field.

Advanced Chart Examples

XY2D Line Chart Examples

Radar2D Radar Point Example

The chart below is displaying product revenue by region.  This data is driven by a Cube View where the Cube View Rows display the region and the Cube View Columns display the products.  Only the Y axis can be customized with this chart type which is driven by the Cube View data.  The Legend is driven by the Members on the Cube View Rows and the column Members display multiple axes organized in a circle.

Data Explorer

This component is linked to a cube view and displays in the standard Data Explorer view which is seen when a cube view is launched from the Analysis area on the OnePlace tab. To use this component, specify a name and add a Data Adapter linked to a cube view. You cannot use this component with mobile dashboards.

Data Explorer Report

This is a component linked to a cube view and displayed in Report Viewer as if generated on the fly from a Data Explorer window.  To use this, name the component and add a Data Adapter linked to a cube view. The component can be used with mobile and application dashboards. See Report in the Cube Views section. 

Dynamic Grid

The Dynamic Grid Component displays data in a tabular format from a Workspace Assembly-driven data source. Each column represents a field, and each row represents a record. This grid enables you to read data from various sources, transform that data, and write it back to any specified target. This offers a flexible and high-performance feature for managing large datasets. It supports paging, dynamic columns, custom formatting, and other customizations. This component maintains the core functionality of the SQL Table Editor Component while enhancing the flexibility of data presentation and end-user interaction.

The key features of the Dynamic Grid Component include the following benefits:

• Flexible data transformation: Read, write, and transform data from various sources using Workspace Assemblies.

• High performance: Manage large datasets efficiently with paging.

• Dynamic columns: Add, remove, and customize columns.

• Custom formatting: Apply custom formatting to data for better visualization.

This component is created in the Windows Application and can be displayed in the Modern Browser Experience and the Windows Application.

To use the Dynamic Grid Component, follow these steps:

1. Review the Prerequisites.

2. Create a Dynamic Grid Component.

3. Update Configuration Settings.

4. Add the Dynamic Grid Component to a Dashboard.

5. Create a Workspace Assembly Dynamic Grid Service.

Review the Prerequisites

Before you create a Dynamic Grid, review these developer and setting prerequisites.

Developer

• Primarily, the Dynamic Grid will be created by a developer. Users will interact with the grid.

• The Workspace Assembly required can be complex and is designed to be used by a developer.

• The developer should have in-depth knowledge of OneStream Workspace Assemblies, source data, and target data.

Settings

• Create a Workspace and Maintenance Unit. See Workspaces Setup.

• Create a Dashboard Group and Dashboard. See Dashboards.

Create a Dynamic Grid Component

1. Go to Application > Presentation > Workspaces.

2. Click the arrow to the left of the Workspace to expand the navigation tree.

3. Click the arrow to the left of the Maintenance Unit to expand the navigation tree.

   NOTE: Do not select the Default Maintenance Unit if you have also selected the Default Workspace because you will not be able to add a Dashboard Component.

4. Click Components.

5. In the toolbar, click the Create Dashboard Component button.

6. In the Create Dashboard Component dialog box, select Dynamic Grid and then click the OK button.

7. Name the Dynamic Grid.

   NOTE: The Dynamic Grid name must be unique within its Workspace.

8. Update the configuration settings. See Update Configuration Settings.

9. Click the Save button.

Update Configuration Settings

Configure the available settings for the Dynamic Grid Component.

Add the Dynamic Grid Component to a Dashboard

1. In the same Maintenance Unit as the Dynamic Grid Component, click the arrow to the left of Dashboard Groups to expand the navigation tree.

2. Select a dashboard.

3. Click the Dashboard Components tab.

4. In the toolbar, click the Add Dashboard Component button.

5. In the Add Dashboard Component dialog box, select the Dynamic Grid Component and then click the OK button.

6. Click the Save button.

Create a Workspace Assembly Dynamic Grid Service

1. In the same Maintenance Unit as the Dynamic Grid Component, click Assemblies.

2. In the toolbar, click the Create Assembly button.

3. On the Assembly Properties tab, in the Name field, name the Assembly.

   NOTE: The Assembly name must be unique within its Workspace.

4. In the Compiler Language drop-down menu, select a language.

5. In the toolbar, click the Save button.

6. Create files for the Service Factory and the Dynamic Grid Service.

   1. On the Assemblies Files tab, right-click on Files and select Add File. In the Add File dialog box:

      1. In the File Name field, enter a name for the file (for example, ServiceFactory).

      2. In the Source Code Type drop-down menu, select Service Factory.

      3. In the Compiler Action drop-down menu, select (Use Default).

      4. Click the OK button.

      

   2. On the Assemblies Files tab, right-click on Files and select Add File. In the Add File dialog box:

      1. In the File Name field, enter a name for the file (for example, DynamicGridService).

      2. In the Source Code Type drop-down menu, select Dynamic Grid Service.

      3. In the Compiler Action drop-down menu, select (Use Default).

      4. Click the OK button.

      

7. By default, Dynamic Grid methods for Get and Save are included. See Dynamic Grid Service. Modify the code as needed.

8. To enable the Dynamic Grid, in the Service Factory Assembly File, highlight the lines for the Dynamic Grid, and click the Uncomment the selected lines. button.

   

   NOTE: Ensure the object name matches the name of the Dynamic Grid Service file.

   

9. In the toolbar, click the Save button.

10. Select the Maintenance Unit. In the Workspace Assembly Service field, enter the name of the Assembly and the Service Factory Assembly File in this format: <Assemblyname>.<ServiceFactoryAssemblyFilename>

    Example: If the Assembly name is DynamicGridService and the Service Factory Assembly File name is ServiceFactory, the Workspace Assembly Service would be: DynamicGridService.ServiceFactory

    

11. In the toolbar, click the Save button.

12. Select the Assembly, and click the Compile Assembly to check syntax button to ensure the Workspace Assembly files compile.

File Viewer

This is used to present files such as PDF’s stored on the OneStream file share.  This Component can be used with Mobile and Application Dashboards.

There are only three situations where users can see these files:

1. They must have the ManageFileShare system role

2. The files must be stored in a folder under the Incoming folder.

   Example: \\MyServerName\OneStreamShare\Applications\MyApplicationName\Incoming\MyDashboardFiles

3. The file is placed in one of the folders under \\MyServerName\OneStreamShare\Applications\MyApplicationName\Groups and then in a named folder with the same name as a User Group. The file must be in the folder with same name as the User Group and the user must have permissions to that Group.

File Source Type

URL

Display a file from an internal or external web page. 

Dashboard File

Display a file stored in a Dashboard Maintenance Unit File section. 

Application/System Database File

Display a file stored in the Application or System Database Share. 

File Share File

Display a file from the File Share. 

URL or Full File Name

The URL or name of the file being used.  Enter the full URL name, or click the ellipsis and browse to the desired file.

Show Header

Select True in order to display a header derived from the Component’s Name or Description.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Show PDF Toolbar

Select True to display the PDF Toolbar while viewing the Component on a Dashboard, select False to hide it.

Auto Play (audio and video files)

If set to True, the video/audio files shown in the Dashboard Component will automatically start. 

Process Extensible Document

If set to True, the File Viewer Component will run and process the attached Extensible Document, if set to False the unprocessed file will display which is mainly used for testing purposes.

NOTE: An Extensible Document is a Text, Word, PowerPoint, or Excel file that uses Parameters in its content.  The file name must contain .xfDoc before the extension.

Example: StatusReport.xfDoc.docx

See Extensible Document Framework in Presenting Data With Extensible Documents for more details on this feature.

Image

This is used to display an image on a Dashboard. This Component can be used Application Dashboards.

Formatting

See Label

Image

File Source Type

The Image (if any) to display.

URL

The image displayed is located on a URL.

Workspace File

The image displayed is located in a file stored in the Workspace Maintenance Unit File Section. 

Application Database File

The image displayed is located in a file in the Application Database Share.

System Database File

The image displayed is located in a file in the System Database Share.

File Share File

The image displayed is located in the File Share.

URL or Full Name File

The URL, file path or file name for the displayed image.

URL Syntax

Access a built-in toolbar image, or use an image from any web server

Built-in OneStream Image Example   /OneStream.ClientImages;component/Misc/ToolbarImage.png

Web Server Example

http://www.onestreamsoftware.com/img/onestream-logo.png

Database File System Example
Enter the path and file name Documents/Public/TestImage.png

Workspace File Syntax
Enter the name of the file resource TestImage.png

The following Excel properties are used to specify an Excel file from either an Extensible Document or Report Book in order to display it as an Image or Button on a Dashboard.

Excel Page Number

Enter the page number of the Excel document to display.

Excel Sheet

Enter the name of the Excel worksheet to display.

Excel Named Range

Enter the named range from Excel to display.  The named range must be the specified Excel sheet in the Excel Sheet property, or the Excel Sheet property must be blank in order to use a named range.

See Image under Component Display Format Properties to position and align the Excel image as needed.

Label

This is used to display text strings on a Dashboard.  This Component can be used with Mobile and Application Dashboards.

Formatting

Text (use {1}, {2} for Data Table Cells) (Label Component Only)
The text to display in the Label. Use {1}, {2} to reference cells from the associated Data Adapter’s Data Table.

Example: Sales and Profit for |!EntityParam!| are {1} and {2}

Tool Tip

The text to display when a user’s mouse hovers over the Component.

Display Format

The formatting assigned to the control.  See Component Display Format Properties

Data Table Cells from Adapter

Number of Data Table Cells

Specify the Data Table Cells available for display if the Label Component is being used, or to determine which State to display if the State Indicator Component is being used.

The following properties become available if a number is specified in the Data Table Cells field.

Data Row Selection Type

This specifies how the data cell row from the attached Data Adapter is identified and passed into the Label placeholder.

First Row

The specified row is the first row of data from the Data Adapter.

Row Index (0-based)

The row is specified by entering the row number in the Key Column Value or Row Index field.  This selection uses 0-base row numbering where the first row is identified as row 0.  (e.g., if there are six rows returned in the Data Adapter, enter 5 to get the last row)

Key Column Name and Value

The row is specified by querying the attached Data Adapter.  Enter the column name to search in the Key Column Name field and enter the string/value to search in the Key Column Value or Row Index field.  The row where the value is found will be the specified row.

Key Column Name

This property is only available when Key Column and Value is selected for the Data Row Selection Type.  Enter the column name to search.

Key Column Value or Row Index

This property is only available when Row Index (0-based) or Key Column Name and Value is selected for the Data Row Selection Type.  Enter the Key Column value/string to search or enter the Row Index Number.

Result Column Name

Enter the column name to return to the Label placeholder.

Number Format

The formatting applied to a value returned to the label placeholder if a string is not returned.

Logo

This is used to display a logo on a Dashboard.  This Component can be used with Mobile and Application Dashboards.

Formatting
See Label

Password Box

The Password Box displays a text box in which characters entered are hidden, so you can securely enter a password. When you create a Password Box, you can enter tool tip text.

Create a Password Box

1. Go to Presentation > Dashboards.

2. Expand a Dashboard Maintenance Unit and then Components.

3. Click Create Dashboard Component. The Create Dashboard Component window opens.

4. Select Password Box and click OK.

5. In Component Properties, enter a name. Optionally, enter text that displays as a tool tip.

6. Click Save. The password box component appears in the Components list.

8. Add the password box component to the dashboard and then run the dashboard.

Pivot Grid

The Pivot Grid is a component within the Dashboard Maintenance Unit that allows you to create a pivot table, utilizing data from any existing and new Data Adapters to perform multi-dimensional analysis. At runtime, the user can customize the layout of the report using simple drag-and-drop operations and conditional formatting based on their analysis requirements. In the Pivot Grid, data can be summarized, calculated fields (text and decimal) can be added and displayed in a cross-tabular format that can be sorted, grouped and filtered. The Pivot Grid also supports drill-down (to view the underlying Data Adapter Results Table). The resulting output can be printed or exported to various file formats (such as PDF, XLS and XLSX).

All Data Adapters are supported when using the Pivot Grid. Utilizing Cube View MD (Multi-Dimensional) as the source of a Data Adapter will return the selected Cube View as a Multi-Dimensional Fact Table and provide an easy to use source table for the Pivot Grid. The results of the Cube View MD are Dimensions (Entity, Consolidation, Scenario, time, View, Account, Flow, Origin, IC, UD1-UD8) as columns.

Component Properties

Name

The name of the Pivot Grid.

Description

A quick description of the Pivot Grid.

Maintenance Unit

The Maintenance Unit to which the Component belongs.

Component Type

The type of Component

Pivot Grid

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Row Fields

Enter a comma separated list of Column Names (from the Results Table) to be placed in the Row Area of the Pivot Grid by default.

Column Fields

Enter a comma separated list of Column Names (from the Results Table) to be placed in the Column Area of the Pivot Grid by default.

Data Fields

Add a Measure (from the Results Table) to be assigned as the default Measure. Multiple measures can be added using a comma “,” to separate the column names.

Field Groups

Enter a comma separated list of Column Names (from the Results Table) to be grouped together as a default.

Save State

Enables the Save Button on the Pivot Grid when set to True and Disables the Save button when set to False.

NOTE: Layout button on Pivot Grid when copying Dashboards:

When copying a Dashboard that contains a Pivot Grid or Large Data Pivot Grid, the Pivot Grid and Large Data Pivot Grid component layouts are saved per dashboard location, not by component. Next time each dashboard is run the Pivot Grids should have different saved layouts.

Additional information on the use and design elements of the Pivot Grid can be found in the Pivot Grid.

Report

This Component can be used with Mobile and Application Dashboards.

Auto Fit to Page Width

If set to True, this will auto fit the Report to the area allocated in the Dashboard.

Text Editor

This is used to display documents created with the Text Editor feature in a Dashboard.  It also can process Extensible Documents when embedded in a Dashboard.  This Dashboard Component is only compatible with the OneStream Windows App.  If using any version other than the OneStream Windows App to see files created with the Text Editor feature within a Dashboard, information will not display, and an error message appears telling the user that Text Editor documents are not available in the OneStream browser version.  See Text Editor in Application Tools for more information.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

File Source Type

Dashboard File

Display a file stored in a Dashboard Maintenance Unit File section. 

Application/System Database File

Display a file stored in the Application or System Database Share. 

File Share File

Display a file from the File Share. 

Allow Create File

If set to True, this allows users to create text files.

Allow Open File

If set to True, this allows users to open text files.

Allow Save File

If set to True, this allows users to save text files.

Show Ribbon

Select True to enable users to see the Ribbon below the Menu Bar, select False to hide the Ribbon.

Sankey Diagram

This component can be used with the Windows Application dashboards to display Sankey diagrams.

Sankey diagrams enhance the visualization of connected data sources and entities using the method command type business rules or single-row cubes views with multiple columns.

Diagrams can be exported as .png files by right-clicking outside of the links then selecting PNG.

Create a Sankey Diagram

1. From the OneStream Application tab, click Dashboards.

2. Expand Dashboard Maintenance Units and then expand the appropriate maintenance unit under Workspaces.

3. Click the Components label and then, from the toolbar, click Create Dashboard Component.

4. In the Create Dashboard Component dialog, click Sankey Diagram (Windows App Only) and then click OK.

5. In the Name field, type a name for your Sankey diagram.

6. Click Save.

Sankey Diagram Component Properties

Enhance the data presentation by adjusting the component properties. Navigate to the components: Dashboards > Workspaces > Default > Maintenance Units > Sankey > Components > Sankey Diagram

Show Toggle Size Button:When True, the toggle size button is available. When False, the toggle size button is unavailable.

Show Title: When True, the title is centered above the diagram. When False, no title is shown in the diagram.

Show Node Labels: When True, node labels display on the diagram. When False, node labels do not display on the diagram.

Source Link Color: When Default, source link colors automatically change with each refresh. Set a custom or preloaded color to maintain the same color.

Target Link Color: When Default, target link colors automatically change with each refresh. Set a custom or preloaded color to maintain the same color.

Link Transparency: Specify the level of transparency displayed on the diagram by selecting a value between 0 and 1. 0 is opaque and 1 is transparent. The default is 0.5.

Node Width: Specify the width of the bar for the node. Increase this number for a wider bar.

Vertical Node Indent: Specify the vertical space between nodes. Increase this number for more white space.

Node Alignment:Specify the vertical alignment to the top, bottom, or center of the diagram.

Node Link Weight Tooltip Prefix: Set the tooltip prefix as any keyboard character (!@#$%^&*()<>?) or alphanumeric text. This lets you input a currency culture like $ or €.

The example below sets prefix as $ if the user is set to English:

if (args.FunctionName.XFEqualsIgnoreCase("GetUserCultureCurrency"))
{
UserInfo userInfo = EngineUsers.GetUser(si);
CultureInfo culture = new CultureInfo(userInfo.UserPreferences.Culture);
return culture.NumberFormat.CurrencySymbol;
}

XFBR can be changed for culture. To get another user culture, replace GetUser(si) with GetUser(si, "nameOfUser").

Node Link Weight Tooltip Format:Specify the tooltip formating.

Example: 0.00; #.##; #,###,###.00; 000.#'string'

See Standard numeric format strings.

Business Rules and Sankey Diagrams

When using a method command type business rule, in addition to defining the Sankey items, at least 4 columns must be defined from the data table:

• Name

• Source

• Target

• Value

NOTE: Negative values are not recognized by Sankey diagrams. Links between items will not flow when a negative value is present.

Text Editor

This is used to view the Text Editor component in a dashboard. This is available in the Windows Application and can be displayed in the Modern Browser Experience.

Text Editor

Show Toggle Size Button

Defaults to True, which enables the toggle button to allow users to toggle the size of the component at run time. If set to False, the toggle button will not display in the component.

File Source Type

Workspace File

Displays a file stored in a Workspace Maintenance Unit's File section. 

Application or System Database File

Displays a file stored in the Application or System Database.

File Share File

Displays a file from the File Share. 

NOTE: Application Database, System Database, and File Share exist in the File Explorer.

Url Or Full File Name

Specifies the URL or full name of the file being used.

Process Extensible Document

Set to True, which will process Extensible Documents when embedded in a dashboard.

Allow Create File

Defaults to True. If set to True, enables you to create files.

Allow Open File

Defaults to True. If set to True, enables you to open text files.

Allow Save File

Defaults to True. If set to True, enables you to save files.

Allow Refresh

Defaults to True. If set to True, the Refresh Document toolbar button will appear under the OneStream ribbon in the Text Editor component. If set to False, the Refresh Document button will not display in Text Editor Component under the OneStream Ribbon.

Show Ribbon

Defaults to True. If set to True, enables you to view the Ribbon below the Menu Bar. If set to False, hides the Ribbon.

Minimize Ribbon

Defaults to False. If set to True, minimizes the Ribbon below the Menu Bar. If set to False, the Ribbon displays as normal.

Text Viewer

This is used to view text and rich text documents similar to those created in Microsoft Word.  This is available in the OneStream Windows App version. Documents cannot be created or edited using this tool. 

Spreadsheet

This is used to display spreadsheet files created with the Spreadsheet feature in a Dashboard.  See Spreadsheet in Application Tools for more information.

NOTE: There are some configuration changes necessary for the Spreadsheet referenced in a Dashboard if functions such as XFGetCell or XFSetCell are included in that XLSX file that reference a custom Parameter that is driven by the Dashboard.

In this case, the function available to Excel Add-in and Spreadsheet called XFGetDashboardParameterValue should be used. If that function is used within an XLSX file that is using a function like XFGetCell or XFSetCell (or similar) where these are referencing a custom parameter value (e.g. ParamEntity) that is on the Dashboard that references this Spreadsheet from within it as a Component.

The practice to get this Custom Parameter value is to use XFGetDashboardParameterValue to fetch the text from that Parameter or its default value and place it in a cell on the Spreadsheet (e.g. B1). Then the cell that is using a retrieve function such as XFGetCell would reference this other cell (i.e. B1).

Spreadsheet

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

File Source Type

Dashboard File

Display a file stored in a Dashboard Maintenance Unit File section. 

Application/System Database File

Display a file stored in the Application or System Database Share. 

File Share File

Display a file from the File Share. 

Url or Full File Name

Displays the URL or Full name of the file being used.

Process Extensible Document

Defaults to True.  It will process Extensible Documents when embedded in a dashboard.

Refresh Spreadsheet When Opened

If set to True, will automatically refresh the spreadsheet file when it is opened.

Allow Create File

If set to True, allows users to create spreadsheet files.

Allow Open File

If set to True, allows users to open spreadsheet text files.

Allow Save File

If set to True, allows users to save spreadsheet files.

Allow Submit Data

If set to True, the Submit button on the Ribbon is enabled and users can load data to the forms channel.

Allow Calculate Data

If set to True, the Calculate button on the Ribbon is enabled and users can call calculate options using it.

Show Ribbon

Select True to enable users to see the Ribbon below the Menu Bar, select False to hide the Ribbon.

State Indicator

This is used to indicate a specific status on a Dashboard.  This Component is not compatible with Mobile Dashboards.

Formatting

See Label

Data Table Cells from Adapter

See Label

States

State Indicator Type

The type of image used for indicating the status.  Valid states start at index 0 and include the following:

Lamp

Off, Green, Yellow, Red

Arrow

Up, Down, Left, Right Arrow is displayed

Smile

Very Happy, Happy, Neutral, Sad

Traffic Lights

Off, Green, Yellow, Red

Default State Index

The default state is 0-4.

State Selection Type (Image = Off)

Specify the State selection type and then define the Minimum Amount, Maximum Amount and/or a list of comma-separated text items that the value from the first Data Table Cell must satisfy in order for the State to be selected.

(Not Used)

The State is not used.

Minimum Amount

The minimum amount for the State to be selected.

Minimum Amount Inclusive

The minimum amount including the specified value for the State to be selected.

Maximum Amount

The minimum amount for the State to be selected.

Maximum Amount Inclusive

The maximum amount including the specified value for the State to be selected.

Range

The amount between two values for the State to be selected.

Range Minimum Amount Inclusive

The amount between two values including the minimum amount for the State to be selected.

Range Maximum Amount Inclusive

The amount between two values including the maximum amount for the State to be selected.

Range Minimum and Maximum Amount Inclusive

The amount between two values including both the minimum and the maximum amount for the State to be selected.

Equals Text Item

If the string equals the string specified in the Text Items field, it should be selected for the specified State.

Starts with Text Item

If the value starts with the string specified in the Text Items field, it should be selected for the specified State.

Ends with Text Item

If the value ends with the string specified in the Text Items field, it should be selected for the specified State.

Contains Text Item

If the value is listed in the Text Items field, it should be selected for the specified State.

Minimum Amount

The value used in State tests for minimum amount.

Maximum Amount

The value used in State tests for maximum amount.

Text Items

The text values used in the types: Equals Text Item, Starts with Text Item, Ends with Text Item & Contains Text Item.

Web Content

This is used to display a URL or file embedded in a OneStream Dashboard.  It can be used with Mobile and Application Dashboards.

NOTE: This component uses Microsoft Edge WebView2 Runtime to embed the web content. It must be installed on the client device. If the client device does not have it installed, you will receive an error when accessing a dashboard that is configured with a Web Content component.

Web Content Type

URL 

The URL to a web page.  This can be internal or external.

Dashboard File

The image displayed on the button is based on a file stored in the Dashboard Maintenance Unit File Section. 

Application Database File

Display a file from the Application Database share.

System Database File

Display a file from the System Database share.

File Share File

Display a file from the file share.

URL or Item Name

Item to display (URL or file) in the control.

Show Borders

Select False to remove the border around the Web Content dashboard component. This property defaults to True.

Show Header

Select True in order to display a header derived from the Component’s Name or Description.

Show Toggle Size Button

Select True to enable the toggle button and allow users to toggle the size of the Component at run time, select False to hide the toggle button.

Large Data Pivot Grid

The Large Data pivot grid is a dashboard component that lets you connect to external tables or large database tables for “pivot” style analytic reporting. The grid helps designers seamlessly integrate data from external tables into a OneStream environment through a dashboard for analytic reporting. The grid's paging and server based processing features support very large data sets/tables. In some cases, this component requires server configuration settings so users can access specific database tables.

You can specify the following properties:

Date Selector

You can set a date in a dashboard by creating a date selector component.

1. Go to Presentation > Dashboards.

2. Select a dashboard under Dashboard Maintenance Units.

3. Click Components.

4. Select a component and click Create Dashboard Component.
   

5. Click Date Selector
   

6. Enter the properties.
   

7. When you set the properties at design time, you set a minimum and maximum date range that is viewed at run time. For example, Min Date to 20200101 and the Max Date to 20201231, others can only select dates within that range.
   

   if you click the ellipsis, you can choose an existing parameter which will automatically fill in the|!...!|.

   You can enter and use a Dashboard XFBR string.

   

   NOTE: Min and Max Date values should be entered in the following format: yyyyMMdd. This value is converted at run time based on your application culture setting.

Add the Date Selector Component to a Dashboard

Once the date selector dashboard component has been created, you can add it to a dashboard.

1. Select the dashboard and click Add Dashboard Component.
   

2. Select the date selector component and click OK.
   

3. Click Save and View Dashboard.
   

4. Click the arrow to show the calendar.
   

Use the double arrows >> to show the max date and << to show the min date.

NOTE: If no min date is specified, the min date is set to 1/1/1900. If no max date is specified, the max date is 12/31/9999.

Report

The Report Designer is built into the dashboard report component, which allows you to edit reports on the report itself.

NOTE: The OneStreamClientApi.dll is now included with the Windows application install. The OneStream Windows application includes the Client API installer.

Access the Report Designer

1. Go to the Application tab, then click Presentation > Dashboards.

2. Scroll to a maintenance unit and select Components.

3. Expand Report and open a specific report.

4. Click the Report Designer tab.

Toggle Page Size

1. Click Toggle Page Size in the upper right corner of the Report Designer to maximize the Report Designer as full screen.

2. Setting the display Zoom slider will assign the display percentage to the Maximize view.



The report changes to full screen.

Export Report Layout

Export the report *.repx file.

1. Click the XF Tools tab and then click Export Report Layout. The Save As dialog box opens.



2. Browse to a location to save the report and click Save.

Import Report Layout from Cube View

1. Click the XF Tools tab and then click Import Report Layout from Cube View. The Object Lookup dialog box opens.



2. Browse to a cube view and click OK.

3. The report layout changes to the formatting of the selected cube view.

4. Click Save to save the new report layout or click Cancel All Changes Since Last Save to revert to the previous layout.

Import Report Layout from Report

1. Click the XF Tools tab and then click Import Report Layout from Report. The Object Lookup dialog box opens.



2. Browse to a dashboard report component and then click OK.

3. The report layout changes to the formatting of the dashboard report component you selected.

4. Click Save to save the new report layout or click Cancel All Changes Since Last Save to revert to the previous layout.

Functionality

For most right-click functionality in Report Designer, use the Properties dialog box.

NOTE: When editing sub reports, you can access the Generate Own Pages option from the Properties menu.

Display Band Details

To expand any of the bands, double-click the icon in the left column.

Edit Bindings by Report

Edit bindings directly and evaluate all the controls with the built-in component in the Report Designer. The Edit Bindings dialog box lists all of the controls, property type and data binding. It displays invalid status and allows you to apply corrections.

The Property type contains type definitions.

Access Edit Bindings

1. From the Report Designer tab, select XF Tools, then Edit Bindings.

   

   The Edit Bindings dialog box opens.

2. Click any of the column headings to sort the data in the column.

   

Show Invalid Bindings

The Edit Bindings dialog box lists invalid bindings. The source binding is set to a path that does not exist in your data set.

1. From the Edit Bindings dialog box, click Show only invalid bindings.

   

   A list of invalid bindings opens. The invalid bindings have a red background.

   

2. Select one of the invalid bindings from the Data Binding column and click the down arrow.

   

3. From the drop-down list select the correct data to a path that exists in your data set.

4. After you click off of that row, the color of the row changes to yellow to identify that it is modified.

   

   NOTE: Even if you modify an invalid binding to make it valid, it still appears in the invalid list.

5. Click OK to close the Edit Bindings dialog box.

6. Click Save in the Report ribbon to save your changes to the report and database. Or, click Undo to revert the changes without saving.

SQL Table Editor

Displays a grid linked to a SQL table and the contents of the table are shown in the grid.  Settings in the object determine whether the grid allows changes to the table data.  This Component is not compatible with Mobile Dashboards.

Action

See Button

SQL Table Editor

Database Location

Application

Select if the table to be displayed is located in the application database.

Framework

Select if the table to be displayed is located in the framework database.

External

Select if the table to be displayed is located in an external database.

External Database Connection

Connection information to enable connecting to an external database.  This is only needed if the Database location is set to External.

Table Name

The name of the table being displayed in the control.

Where Clause 

The SQL string where clause used to pull data from the table.

Table Column Names

Optional. A comma-separated list of database table column names you can use in the SQL Select statement. Only the entered columns are displayed in the control.

NOTE: If editing existing data or adding new rows is enabled, any columns that exist in the underlying database table are excluded from the list. This property must have default constraints set in the database table.

Order by Clause

The SQL string to order the results of the table.

NOTE:
The Order by Clause property does not allow SQL Functions, like YEAR(effectiveDate). When run inside a dashboard, the Table Editor's columns allow clicks to change the order to ascending, descending, or no sort. SQL functions can not be allowed in the ordering.

Filter Mode

The SQL Table Editor lets you filter results using Filter Mode. This filtering mode is built into the header cell of each filterable column. It is simpler to use than Popup mode (an alternative filtering mode) and uses only one field editor to filter. All filters start as empty until a value is entered into the editor.

Default for Columns are Visible

If set to True, all columns will be hidden unless overridden on an individual column. Settings are True or False.

Default for Allow Column Updates

If set to True, the data in the existing table can be modified, if set to False, it cannot be modified.

Show Title Header

Show or Hide entire bar including the items within the bar. If you set it to False, the Default For Allow Column Updates, Process Selection Changed For Inserts, Allow Inserts, and Allow Deletes remain enabled.

Show Title

Show or Hide the text in the Title Header.

Show Column Settings Button

Shows (if set to True) or Hides (if set to False) the Column Setting Button which allows user to reorder and set visibility of columns.

Show Deselect All Button

Shows or Hides Deselect All Button which allows the user to deselect all selected rows.

Process Selection Changed For Inserts

If set to True, (and the “Allow Inserts” property is also set to True), it will allow the Insert button to process the selection changed event which is often configured to refresh a portion of the Dashboard. If set to False, it will not allow the Insert button to process the selection changed event.

Allow Inserts

If set to True, new rows of data can be added to existing data in the table. If set to False, new rows cannot be added.

Allow Deletes

If set to True, rows of data can be deleted from the existing data in the table. If set to False, rows cannot be deleted.

Retain Table Column Order

If set to True, the column order can be changed via the SQL Table Editor Column Format section. If set to False, the order cannot be changed.

Read Only Text Color

This field sets the default color to standard black text. The setting can be changed to any color including a system color (e.g., XFReadOnlyText).

Column Name for Bound Parameter

Specify the name of the database column to use to change the value of the Bound Parameter when a database row is selected. This is used when a SQL Table Editor is being used to affect the display of other Dashboard Components (e.g., when showing detailed information for the selected row.)

Allow Multiselect

If set to True, the multiple selection of records will be enabled by item selection or using a selection check box. The active selected items will be passed to the defined Bound Parameter field as a comma delimited list. The Bound Parameter format will be as: item1, Item2, Item3. If the 3 values A, B, C,D are selected (where C,D is one value) the resulting bound parameter string is A, B, "C,D". If set  to False, only a single Bound Parameter can be passed at a time and the selection boxes will be deactivated from the user interface.

Rows Per Page

Specify how many rows to display before a page break. This is a numeric value between 1 and 3000. By default, this property is set to -1, which turns OFF the property and uses your defined user preference property Grid Rows Per Page. Any value greater than 3000 results in a maximum value of 3000.

Save State

If set to True, user settings on the Component are retained. User preferences for Columns saved will be for: Order, Visibility, Filtering, Freeze Bar, Sorting and Widths.

NOTE: Reset Save State Back To Default: Right-click on the Dashboard to enable the “Reset State” to return back to its Component Properties settings.

Vary Save State By

Apply Vary Save State By to workflow profile settings and scenario. The current Save State elements will have the control state tied to the current Workflow Profile and Workflow Scenario settings. If you select Falseor Use Default, Vary By Save State will not apply.

When Vary Save State By is enabled, the related Dashboard Component will have the additional reset option of Reset All States, which can be used to clear the user's Save States across all the Vary Save State By parameters.

Display Format

Sets the SQL Table Editor formatting options such as row color. Set row BackgroundColor property to a color, and set AlternateRowBackgroundColor to a different color.

Data Manipulation Buttons

Show Data Manipulation Buttons

Hide or Show Insert Row(s), Delete Row(s), Cancel All Changes Since Last Save and Save.  Settings are True or False.

Show Insert Row(s) Button

Hide or Show Add Row Button.  Settings are True or False.

Show Delete Row(s) Button

Hide or Show Remove Row Button.  Settings are True or False.

Show Cancel All Changes Since Last Save Button

Hide or Show Cancel Button.  Settings are True or False.

Show Save Button

Hide or Show Save Button.  Settings are True or False.

Server Task

Create Table if Necessary

The option to create the table if it does not already exist.  Settings are True or False.

Table Creation Script

The SQL script to create the new table.

Save Data Server Task

No Task

There is not a performed task for a SQL table save data event.

Execute Dashboard Extender Business Rule

This will use a Dashboard Extender Business Rule to perform a save data event.

Save Data Server Task Arguments

Enter the arguments required by the server task. 

Dashboard Extender Business Rule Example (each enclosed in curly braces)

{Business Rule Name}{Function Name}{Optional Name-Value Pairs}

TIP: The data will wrap on string spacing.  If there are no blank spaces, the column data will not wrap.  Additionally, keyed fields cannot be wrapped.

DataFormatString

Specify a number/date format to the data in the column.  For example, mm/dd/yyyy will return the current Month/Day/Year using a slash.  MM-dd-yyyy will return the Month-Day-Year using a dash.  N0 will return a number without a decimal point, and #,###,0 will return a number without a decimal and a comma depicting the thousandth place.  See Application Properties in Application Tools for more examples of number formats.

Width

This specifies the default column width to be displayed.

SQL Table Editor Column Format

ColumnName

Column name from the table where the selected formatting is to be applied.  Specified name must match the column name from the table exactly.

Description

Column description to be displayed.  By default, the Column name from the table is displayed.

Column Display Type

See Grid View for Column Format

IsVisible

Setting to override the default Columns Visible setting. Settings are True, False, or Use Default

AllowUpdates

This is a setting to override the Default For Allow Column Updates setting for each individual column.  If set to True, users can modify data displayed in the grid.  The Use Default setting uses the Default For Allow Column Updates setting.

ParameterName

The assigned Parameter name to be used to store the Parameter value from the specified column.

DefaultValue

The default value to be entered when allowing new records to be added.  This helps ensure that invalid blank cells are not created.

IsMultilineText

If set to True, this will allow columns to display data on multiple rows if the column is not wide enough to display the full value.

SQL Table Editor Multiselect

Enabling the Allow Multiselect on the SQL Table Editor Component will expand the functionality of the Component for use in interactive dashboards.

• Allow Multiselect will generate the Bound Parameter as a comma delimited list.

• Selection Methods can be performed with the Select All check box, selecting a range using Shift key, and by item using Ctrl-Click.

• Deselecting can be done by item or using the Deselect All toolbar button.

• Applying a Column Filter after selections are activated is not allowed.  Applying a column filter will clear any existing selected records.  The column must be first filtered, once filtered, selections can be performed.

• Defer Refresh button can be used to manually control the execution of tasks defined in the Actions properties of the SQL Table Editor Component.  This user-controlled execution of actions may provide better performance within complex dashboards.

  NOTE: Defer Refresh remains checked after the Refresh button is clicked in SQL Table Editor.

  

NOTE: Multi-select retains selected items after column filtering and sorting by using a table’s primary key columns. If the referenced table does not contain a primary key column, the selection is not retained across pages or after filtering or sorting columns.

SQL Table Editor Searchable Drop-Down List

When drop-down lists have many items to choose from, finding a suitable item in the list can be cumbersome. You can make the drop-down list searchable to improve the efficiency of finding the appropriate item. As you type, search options are narrowed down to those that contain the typed text and you no longer have to scroll through a long list.

NOTE: To use this search feature, the table editor must be configured so that you can edit existing data or add new rows. Columns must be configured with a parameter of type Delimited List, Member List, or Bound List, which is what configures a column as a standard drop-down list.

Enable the Search

1. From the Application tab, select Dashboards, and expand the appropriate Workspace, Maintenance Unit, and Component until you reach the SQL Table Editor component you want to modify.

2. Select the SQL Table Editor to view its properties.

3. Enable the search feature.

   • For all columns that are configured with a list parameter:

     1. In the SQL Table Editor section, set Default for Show Search to TRUE.

     2. Click Save.

   • For specific columns only:

     1. In the SQL Table Editor Column Format section, locate the column where you want to enable the search feature and click the ellipses (...).

     2. In the dialog box, set the ShowSearch property to TRUE.

     3. Click OK.

     4. Click Save.

Use the Search

1. Run the dashboard that contains the SQL Table Editor component.

2. Double-click in a cell to expand the drop-down menu.

3. Start typing in the search field. The drop-down list narrows down to items that contain the typed text.

SQL Table Editor Save State User Preferences

Use Save State to retain your user preferences for the SQL Table Editor display. Your preferences for the following are saved if you set Saved State to True:

• Column order

• Visible or hidden columns

You can set column filters Column Filters can be set by the user and will be preserved if the Saved State is set to True.

However, the Column Sort will not be preserved once the SQL Pivot Grid is deselected or the dashboard is closed.

Save State for Freeze Bar

When Save State is set to True the Freeze bar will retain its position if you drag it to a certain column.

SQL Table Editor Filtering

The SQL Table Editor lets you filter results using the following two methods, or modes:

• Popup Mode: This is the default filtering mode and has been available for use in all prior releases of the OneStream software application. Using this mode, you can activate filtering by clicking the funnel icon in the column header, which launches a popup window.

  

  The popup contains two field filters that let you create filtering criteria such as "value is greater than 18 and is less than 60." Field filters consist of two parts: an upper part, which is a combo box, and a lower part called the field filter editor. In the upper part (combo box), you can use filter operators like Is Equal To or Is Less Than, which change based on the data type of the column. The lower part (field filter editor) provides filtering criteria based on the data type of the column. For example, if you have a date column, you can use a date/time picker control as the filtering criteria.

• FilterRow Mode: This filtering mode is built into the header cell of each filterable column. It is simpler to use than Popup mode and uses only one field editor to filter. All filters start as empty until a value is entered into the editor. Click the filter icon to display a drop-down list of all operators available to the data type of the column. If you select Clear Filter from the list, it will clear and reset the column filter.

  

You can configure the Filter Mode property of the SQL Table Editor to use either of the modes. To configure the SQL Table Editor:

1. Navigate to Application tab > Workspaces > Maintenance Units > Components > SQL Table Editor.

2. In the SQL Table Editor section settings, set Filter Mode to either Popup (default) or Filter Row.

NOTE: Consolidated column filtering is not supported on the following data types. Applying filters on these datatypes will not yield consolidated filtered results. Unsupported data types: binary, char, date, datetime2, datetimeoffset, float, geography, geometry, hierarchyid, image, filestream, money, nchar, ntext, numeric, nvarchar, real, rowversion, smalldatetime, smallmoney, sql_variant, text, time, timestamp, tinyint, varbinary, xml.

Filtering Columns Based on Values from Another Column

You can base a column’s header filter on values from another column. This includes any column that is in the data set, even if the column is hidden. This is useful for name-value pair parameter columns as long as the values and names are pulled from individual columns.

To set up and configure the SQL Table Editor component:

1. Inside the appropriate workspace, create and configure an SQL Table Editor component according to your needs.

2. Identify the column that you want to filter along with the column the filter is based upon.

3. In the SQL Table Editor component, configure the column format for the column you want to filter by typing the name of the column into the FilterByColumnName property.

Example

Begin with an SQL Table Editor grid. The data set can come from an SQL view or an SQL table.

When filtering data using a column header filter, the default behavior is to filter by the value stored in that column. For example, filtering the ProdID column on a value of 10 returns one row where ProdID equals 10.

If you would like to change the ProdID column filter and base it on ProductName instead, configure the column format for ProdID by setting FilterByColumnName to ProductName.

Column filtering for column ProdID is now based on values from the ProductName column.

SQL Table Editor Modify Table Data Using a View

You can modify data of an underlying base table through an SQL View. An SQL View is a virtual table where column and row contents are defined by an SQL query. The SQL Table Editor displays data from the virtual table, but you can change the data of the underlying base table. This provides more flexibility and control over how you present and manipulate data in the SQL Table Editor.

Use the following rules when you want to modify data through a View:

• Use Views to create a view of the data in one or more tables in the database. You can add calculated columns to your View.

• You can only update data in a single underlying base table. For example, if you create a View that combines data from four tables, you can only update data from one of those tables.

• Depending on what you are trying to do, you need the correct permissions to the underlying base table.

Configuration

Set up and configure the SQL Table Editor component:

1. Inside the appropriate workspace, create and configure an SQL Table Editor component according to your needs.

2. In the Table Name property, specify the underlying base table that contains the editable data.

3. In the View Name property, type a name for the view.

4. Identify columns in the view that do not exist in the underlying table. These columns are excluded from the Insert and Update statements that the SQL Table Editor generates when updating the base table.

5. Configure a column format for each column in the view that does not exist in the base table.

6. Set the IsFromTable property to False.

Example

You begin with two tables. The first is a Products table.

The second is an Orders table.

The two tables are linked by the ProdID value, as shown in the previous images.

Next, create a simple view called OrderDetails to show products specific to each order.

SELECT dbo.Orders.OrderID, dbo.Orders.prodID, dbo.Orders.Quantity, dbo.Products.productName, 
    dbo.Products.Price
FROM dbo.Orders
INNER JOIN dbo.Products
ON dbo.Orders.prodID = dbo.Products.prodID

This produces the following view:

At this point, you might want to expose the view to users so that they can update order quantities or add additional orders. This data is stored in the underlying base table, Orders.

In the SQL Table Editor, you can set Orders as the Table Name (the base table) and OrderDetails as the View Name.

You now need to identify columns in the view that do not exist in the underlying base table. In this example, that would be productName and Price. For both columns, configure a column format where IsFromTable is set to False. You can also make the columns read-only by setting AllowUpdates to False.

You can now see all columns of the view while also modifying orders.

You can also add calculated columns to views. These columns are virtual and do not exist in the database They derive their values dynamically when the view is executed.

For example, perhaps we would like to add a column that multiplies Quantity times Price. You could update the view with an expression. You can give the expression any name, such as SubTotal in the following example.

SELECT dbo.Orders.OrderID, dbo.Orders.prodID, dbo.Orders.Quantity, dbo.Products.productName, 
    dbo.Products.Price,
(dbo.Orders.Quantity*dbo.Products.Price) AS SubTotal
FROM dbo.Orders
INNER JOIN dbo.Products
ON dbo.Orders.prodID = dbo.Products.prodID

SQL Table Editor Row Background Colors

You can apply a background color to all rows or alternate rows using the BackgroundColor property and the AlternateRowBackgroundColor property. This makes it easier to distinguish between rows of data at a glance, and can significantly reduce eye strain.

To configure these properties:

1. Navigate to Application tab > Workspaces, and expand the workspace.

2. Within that workspace, expand a maintenance unit, then expand Components.

3. Expand SQL Table Editor and select a component.

4. In the Formatting section, at the far right of the Display Format property, click the Edit (ellipses) button.

5. In the Display Format dialog box, in the BackgroundColor field, click the down-arrow and select a color.

6. In the AlternateRowBackgroundColor field, click the down-arrow and select a color.

7. Click OK.

   

Text Box

This is used to display a text box. You can also add formatted rich text to embedded refreshable content. This content can be used for narrative and can be edited and published into a report.

• Rich Text Properties

• Special Formatting Changes

• Insert Rich Text

• Modern Browser Experience with Rich Text

Rich Text Properties

Instead of making changes outside of OneStream or then having to continuously copy and paste into the application, you can add formatted text using the Allow Rich Text property in the Text Box component. This allows you to create formatted text using the formatting toolbar in OneStream in the Text Box Dashboard component.

Allow Rich Text

This property allows you to format font, color, alignment and more using rich text. The property is located in the Text Box component properties and has a default value of False.

• When set to False, this defaults to plain text and the component will not contain formatting options.

• When set to True, this allows you to add rich text formatting to your content.

  NOTE: When set to True, the Multiline field will not be enabled if Allow Rich Text is set to True.

Enable Spell Check

When Allow Rich Text is set to True, this property displays the spell check options in the toolbar. When Allow Rich Text is set to False, this property is disabled. As an Implementer in the Windows Application, you can set the Enable Spell Check field in the text box component to True or False. This property is under the Text Box Component > Component Properties > Text Box section.

NOTE: This field property cannot be updated through Parameters or Business Rules.

When Enable Spell Check is set to True, these spell check icons are available in the Text Box ribbon:

• Proofing: Spelling and Language

• Spell Check: English (United States)

The default for Spell Check is English. Spell Check will only work when English is selected in Windows for International users. When set to Not Used, misspelled words will not display red lines underneath the text.

IMPORTANT: Existing Text Box components will have Spell Check disabled and the default will be set to False.

IsReadOnly

As an Implementer in the Windows Application, you can set the rich text functionality in the text box component to be read-only or editable for select users through the IsReadOnly property.

This property is located in the Text Box Dashboard Component > Component Properties > Display Format field's Edit button > Display Format dialog > General section > Position section. You can also type "IsReadOnly=" to equal either True or False in the Display Format field. The default value is (Use Default). This property affects existing text boxes and rich text boxes.

• When set to True, you cannot edit the Text Box content and this property is read-only.

• When set to False or (Use Default), you can edit the Text Box content.

Set IsReadOnly Property

As an Implementer in the Windows Application, you can use a Business Rule or Custom Parameters to set the IsReadOnly parameter to True or False.

Here are a few scenarios to set this property:

Scenario 1

You can set a Dashboard String Business Rule in a Workspace Assembly with the IsReadOnly property. You can set the IsReadOnly property using Workspace Assemblies by creating a Dashboard String Function Business Rule which returns "IsReadOnly = True" or "IsReadOnly = False". This will not be automatically added to the Assembly File code.

For example, in the Rich Text Component > Display Format field, type the following string: XFBR(Workspace.Current.MyAssembly.MyStrings, IsReadOnly).

In the Workspace Assembly > Assembly File service, update the XFBR string to return either "IsReadOnly = True" or "IsReadOnly = False"” inside the Assembly File service. Refresh your dashboard after updating the XFBR string to display the updated state. If IsReadOnly is set to False, users can edit.

Scenario 2

You can reference a Custom Parameter in the Text Box Component > Display Format field. For example, if the Custom Parameter was named "TextBoxReadOnly", enter "|!TextBoxReadOnly!|" in the Text Box Component > Display Format field. Then in the Custom Parameter, write "IsReadOnly = True". If the Text Box Component > Display Format does not reference IsReadOnly, but the Display Format field references the Custom Parameter, which contains IsReadOnly = True, the Dashboard Text Box would be IsReadOnly and users will not be able to edit.

Scenario 3

You can set a Dashboard XFBR String Business Rule with the IsReadOnly property. You can set the IsReadOnly property using Business Rules by creating a Dashboard XFBR String Function Business Rule which returns "IsReadOnly = True" or "IsReadOnly = False". This will not be automatically added to the args line of code.

In a Dashboard XFBR String Business Rule, update the XFBR string to return either "IsReadOnly = True" or "IsReadOnly = False" inside the args lines of code. Refresh your dashboard after updating the XFBR string to display the updated state. If IsReadOnly is set to False, users can edit.

Special Formatting Changes

Background Color

You can include the optional BackgroundColor setting to specify the background color of the Rich Text image. If the BackgroundColor setting is blank or not valid, it will default to “#FFFFFF” (white). The value for this setting must be in Hexadecimal format (#RRGGBB or #AARRGGBB) and can be prefixed with or without #.

NOTE: The background cannot be transparent. If transparency values are included in the BackgroundColor value, such as "AA" IN #AARRGGBB, it will be ignored and treated as #RRGGBB (no transparency) and remain opaque.

When using Microsoft PowerPoint to insert your rich text, you can find a Hex code on the slide by following these steps:

1. Right-click on the slide and click Format Background.

   

2. Next to Color, select the Fill Color (paint icon) and click More Colors.

   

3. Click the Custom tab. The Hex code is located under Hex. Enter the code and then click OK. The hexadecimal code will be listed in the Hex field.

   

Measurement Unit

You can include the optional MeasurementUnit setting to specify the measurement unit used by the PageWidth and PageHeight settings. If the MeasurementUnit setting is blank or not valid, it will default to Inch.

The following values are allowed for MeasurementUnit:

• Document: A document unit corresponds to 1/300th of an inch.

• Centimeter

• Inch

• Millimeter

• Point: A point unit corresponds to 1/72nd of an inch.

Page Settings

You can include the optional PageWidth, PageHeight, and PageNumber settings.

• PageWidth: This affects the width of the image that is generated and wraps the text to fit within the page width. If the PageWidth setting is blank or not valid, it will default to 8.5 inches.

• PageHeight: This affects the height of the image that is generated. If the PageHeight setting is blank or not valid, it will default to 11 inches.

• PageNumber: If the PageNumber setting is blank or not valid, it defaults to the first page.

Borders

You can include the optional IncludeBorders setting to display borders in the resulting image. If the IncludeBorders setting is blank or not valid, it will default to False.

Insert Rich Text

You can add formatted rich text to embed refreshable content in a document that can be published in various areas.

IMPORTANT: Copy all syntax needed to insert rich text using Document Variable arguments directly from the Object Lookup dialog box. See Extensible Document Settings.

Microsoft PowerPoint

1. Navigate to the Object Lookup dialog box in OneStream. This dialog box provides all the syntax needed to insert content into an extensible document. This icon can be found on the following pages under the Application tab:

   • Form Templates

   • Books

   • Cube Views

   • Workspaces

   • Data Management

2. In the dialog box, select Extensible Document Settings. Expand Insert Content Using Office Image and then expand Rich Text. Select the line of syntax, and click the Copy to Clipboard button to copy the first string.

3. In Microsoft PowerPoint, open a new or existing presentation, and insert an image.

4. Right-click on the image, and select the View Alt Text option.

5. In the Alt Text field, paste the string. The string {XF}{Application}{RichText}{RichTextContent} displays in the field. You must update the "RichTextContent" placeholder text to a specific rich text format or a parameter containing rich text to appear.

   Optional: Return to the Object Lookup > Insert Content Using Office Image > Rich Text node and then copy the second string. The second string includes additional formatting options, see Rich Text in Insert Content Using Office Image.

6. Enter your special formatting changes to use with the Rich Text. See Special Formatting Changes and Extensible Document Settings.

7. Select File and Save As. Select a file name, and add .xfdoc extension to the name. The file name is appended with ".xfdoc.pptx".

8. Click Save the save the file.

9. Navigate back to OneStream, and open File Explorer. Select your folder of choice and then upload the extensible file.

10. Right-click on the file and select "Process and Open". You may need to enter or select a parameter and then click OK. Microsoft PowerPoint will display the Rich Text content in place of the original image.

Text Box Component

1. On the Application tab, under Presentation, click Workspaces.

2. Create a Workspace and Maintenance Unit or select an existing one. See Create a Workspace.

3. Navigate to Components, and click the Create Dashboard Component toolbar button.

4. In the Create Dashboard Component dialog box, click Text Box, then OK.

   NOTE: Under the Text Box section, you can set the Rich Text Properties. For example, you can set Allow Rich text to True. You can also set Enable Spell Check and IsReadOnly in this section. See Rich Text Properties.

5. Set your Rich Text Properties, and name the Text Box. Click Save to save the changes.

6. Add the Rich Text Box component to a new or existing dashboard within the same Workspace.

7. While the Dashboard node is selected, click the View Dashboard toolbar button to run your dashboard with the Rich Text Box component.

8. If IsReadOnly is set to (Use Default) or False, you can begin to edit the rich text box.

Modern Browser Experience with Rich Text

You can add formatted rich text to embedded refreshable content. This content can be used for narrative and can be edited and published into a report in the Modern Browser Experience. This works alongside the existing OneStream Windows Application to give users more options to use rich text formatting options across a wide range of devices.

You can add formatted text using the Allow Rich Text property in the Text Box component within the OneStream Windows Application. This allows you to create formatted text using the formatting toolbar in the Text Box dashboard component in a Modern Browser Experience.

See Extensible Documents with Rich Text Overview. These properties must be set up in the Windows Application to be available in Modern Browser Experience when run through a Dashboard.

NOTE: The Find and Replace formatting options are not available in Modern Browser Experience.

Supported Rich Text Functionality

Allow Rich Text

Set the Allow Rich Text field to True to add extra formatting options. This allows you to make special formatting changes using rich text, such as font, color, alignment, and more.

IMPORTANT: You may need to alter the design of your dashboard properties or individual components to allow the text box component to display properly in your dashboard layout.

Spell Check

You can perform spell checks with rich text in the Text Box ribbon in Modern Browser Experience. When spell check is enabled, the Spell Check icon is available with the following options:

• (Not Used)

• English (United States)

The default for this property is Use English. English Spell Check is only available. If you select (Not Used), it will ignore any misspelled words and not include any red underlining. When spell check is enabled, you can right-click on a word in Modern Browser Experience and select different Spelling Check options.

NOTE: The limit of word suggestions is seven.

IsReadOnly

As an Implementer, you can enable the new rich text functionality within the text box component and make it read-only or editable for select users. Set and use the IsReadOnly property located in Text Box Component Display Format under Position to True to make rich text available for select users. You can set this property to the following options:

• When set to True, you cannot edit and this property is read-only.

• When set to False or (Use Default), you can edit.

NOTE: In the following example, IsReadOnly is set to True and no formatting options are available in the rich text box.

Menu Component Overview

Developers can add navigational menus to their solutions. With the addition of navigational menus, users can easily navigate throughout the solutions and get to where they want to go. You can hover over or select a menu item to view a drop-down menu with nested options. Then, explore additional menu items by selecting those options to navigate seamlessly to your desired page.

• Modern Browser Experience and Menu Component

• Menu Component and Items

• Data Adapter and Menu Component

• Set Up Menu Component

• Customization

• Sample Customization

Modern Browser Experience and Menu Component

This component is created in the Windows Application and can be displayed in the Modern Browser Experience on a dashboard. The Modern Browser Experience works alongside the existing OneStream Windows Application to give users more options to display dashboards containing Menu Components across a wide range of devices. See Menu Component Overview.

Set Up and Customization

These properties must be set up and customized in the Windows Application to be available in the Modern Browser Experience when run through a dashboard. See Set Up Menu Component and Customization.

IMPORTANT: For a dashboard to display in the Modern Browser Experience and on specific devices, the Dashboard Group containing the dashboard must be added to a Dashboard Profile that includes Web, Tablet, and/or Phone for its Client/Device Visibility property.

NOTE: If the dashboard still isn't appearing in the Modern Browser Experience, verify that the Dashboard Profile's Visibility property is set to Always or OnePlace.

Menu Component and Items

The Menu Component has multiple options for Menu Items that you can integrate and use within your component. All Menu Items must be created and set up in the Windows Application to display in the Modern Browser Experience.

As the developer, you can set the Menu Items through the Workspace Assembly or Business Rule code. The Workspace Assembly or Business Rule code containing Menu Items can then be used to populate the Data Table within a Data Adapter. You can configure specific Display Format settings for the main Menu Component through the Display Format Properties dialog. A Custom Parameter can also be included in the Display Format Properties dialog to configure the main Menu Component.

See Menu Component and Items.

Consider the following when using Menu Component and Items in the Modern Browser Experience:

• Menu Hover Color and Auto Open: When using tablets, the Menu Hover Color will appear after tapping to select. To Auto Open, you must tap to open the Menu Item.

Data Adapter

Developers can write a Workspace Assembly or Business Rule to include data and content that a Data Adapter can use. The Data Adapter can then be used to populate the content of a Menu Component in the Windows Application. See Data Adapter and Menu Component.

Considerations

See Considerations for a list of all items to consider when using the Menu Component in the Modern Browser Experience and Windows Application.

Menu Component and Items

The Menu Component has the following options you can integrate and use within your navigational menu. As the developer, you can set the Menu Items through the Workspace Assembly or Business Rule code. The Workspace Assembly or Business Rule code containing Menu Items can then be used to populate the Data Table within a Data Adapter. You can configure specific Display Format settings for the main Menu Components through the Display Format Properties dialog. A Custom Parameter can also be included in the Display Format Properties dialog to configure the main Menu Component.

Menu Component Properties

Auto Open

Defaults to False. When Auto Open is set to False, you must click each Menu Component Item to expand its nested children. When Auto Open is set to True, the Menu Component Menu Items will automatically expand its nested children when you hover the cursor over the item.

Show Down Arrow

Defaults to False. When Auto Open is set to False, it will not display an arrow icon on the top-level Menu Items even if they contain nested children. When Show Down Arrow is set to True, it will display the arrow icon on the top-level Menu Items containing nested children.

Display Format Properties

General

• Custom Parameters: Use this property to use parameters from the following locations: Default Workspace and Non-Default Maintenance Unit or Non-Default Workspace and Maintenance Unit. You can enter the name of a Parameter that contains a string specifying Display Format settings into this property.

Position

• IsVisible: Defaults to (Use Default). Select (Use Default), True, or False to determine if the component is visible on the dashboard.

• IsHorizontalOrientation: Defaults to (Use Default). Select (Use Default), True, or False.

• Width: Enter a width number.

• Height: Enter a height number.

• MarginLeft: Enter a margin left number.

• MarginTop: Enter a margin top number.

• MarginRight: Enter a margin right number.

• MarginBottom: Enter a margin bottom number.

Font

• FontFamily: Enter a font family name.

• FontSize: Enter a font size number.

Colors

• BorderColor: Defaults to (Use Default). Select a color, enter a custom color, or use the default value.

• HoverColor: Defaults to (Use Default). Select a color, enter a custom color, or use the default value.

Menu Items

Nested Menus

You can create nested menus with the Menu Component. A nested menu is a menu item with a submenu. This can be displayed at any nested level depth.

NOTE: Parent menu items cannot have more than four nested child levels.

Enable or Disable Menu Items

You can set specific menu items in a Menu Component to Enabled or Disabled. When set to Disabled (bool isEnabled = false), you cannot click on or select that menu item. Both parent and child menu items can be set to Enabled or Disabled.

Vertical or Horizontal Menus

You can display menu components in a vertical or horizontal format. This property is configured in the Display Format Properties dialog.

Width and Height

You can configure the overall Menu Component's width and height along with setting each individual menu item's width and height. The width or height of the overall Menu Component displayed on the dashboard are set in the Display Format Properties dialog. The width or height of individual Menu Items within the Menu Component are set through the Workspace Assembly or Business Rule code. Menu Item width and height can be specified at any nested level depth.

Images

Images can be set to display within a Menu Component's parent and nested menu items. You can choose to display the image on its own within the menu item or along with header text or an arrow icon. If the menu item uses an image and the drop-down arrow, the image will always display to the left of the arrow.

NOTE: The arrow icon will only display for parent menu items if "Show Down Arrow" is set to True for the Menu Component and they contain nested items. Nested items under the parent menu items, or children, are not affected by this setting and will always display an arrow if they contain their own nested items.

Bold and Italic Menu Options

You can set the menu item text to be bold and/or italic in the Workspace Assembly or Business Rule code.

Tooltip

You can customize tooltips for the Menu Component's menu items. When the menu item has a set string for the tooltip, the text will display when you hover the cursor over that menu item.

Separators

You can set and create horizontal and vertical separators within the Menu Component. Separators are their own individual menu items set through Workspace Assembly or Business Rule code and can be listed anywhere in the Menu Component. When the isSeparator arguments is set to True on an XFMenuItem class, then it ignores most settings except for the color formatting options. If the Menu Component is horizontal, all Separator menu items created at the parent/root level will be vertical, and vice versa. Nested separators always display horizontally between child items.

Text Color for Background and Text Color Styles

You can customize the text, background, and border colors. This can be displayed at any nested level depth.

Toolbar Image Menu

You can also convert navigational menus into toolbars with image icons. You can omit header text and configure the width, height, and padding properties in the Workspace Assembly or Business Rule code to achieve this. You can also pull images from Dashboard Files, Client Images, and URLs.

Padding Options

You can add and set padding for each menu item. The padding settings are set in the Workspace Assembly or Business Rule code (PaddingLeft, PaddingTop, PaddingRight, and PaddingBottom) and can be set for each individual menu item.

Data Adapter and Menu Component

Developers can create a Data Set using a Workspace Assembly or Business Rule to populate a Data Adapter that's used by Menu Component Items.

Data Table

The Data Table within a Data Adapter displays the Items and Relationships in your Menu Component.

Items

The Menu Component Data Adapter contains the following fields and displays them in a table format: 

Relationships

• ParentName: This is the name of the parent menu item of a menu item.

  NOTE: Top-Level Menu Items will be blank or display Empty for the ParentName field.

• ChildName: This is the name of the child menu item.

• SortOrder: This number specifies the numerical order of the menu item in the parent-child relationship.

  NOTE: The first menu item in the parent-child relationship will have a SortOrder value of 0.

To view the data of an existing Data Adapter, follow these steps:

1. Expand the Workspace > Maintenance Unit > Data Adapter node, and then select an existing Data Adapter.

2. Click the Test Data Adapter toolbar button.

3. If a Parameter dialog box appears, input valid arguments for the Parameters, then click the OK button.

Set Up Menu Component

To use the full capacity of the Menu Component, you must have the following items created and setup before customization:

• Workspace and Maintenance Unit

• Dashboard Group and Dashboard

• Menu Component

• Data Adapter

• Data Set Service or Dashboard Data Set created through a Workspace Assembly or Business Rule

IMPORTANT: You can create and set up the following items in any order. You do not need to follow this order.

NOTE: You can also use a Parameter if it is part of your implementation.

Create a Menu Component

1. On the Application tab, under Presentation, click Workspaces.

2. Create a Workspace and Maintenance Unit, or select an existing one. If you are selecting an existing Workspaces, ensure it is a Default Workspace > Non-Default Maintenance Unit or any Non-Default Workspace > Maintenance Unit. See Create a Workspace.

3. Create a Dashboard Group and Dashboard, or select an existing one. See Dashboard.

4. Navigate to and select the Components node, and click the Create Dashboard Component toolbar button.

5. In the Create Dashboard Component dialog box, click Menu, then OK.

6. Name the Menu component.

7. Click the Save button to save the changes.

Create a Data Adapter and Parameter

1. In the Maintenance Unit, navigate to and select the Data Adapters node, and click the Create Data Adapter toolbar button.

2. Name the Data Adapter.

3. Click the Savebutton to save the changes.

4. (Optional) Then, create a Parameter. See Create a Parameter.

   NOTE: Parameters are not a necessity, but can be used in certain Command Type queries.

5. (Optional) After creating a Parameter, utilize it as needed within the Data Adapter's Data Source properties.

Create a Workspace Assembly

1. In the Maintenance Unit, navigate to and select the Assemblies node, and click the Create Assembly toolbar button.

2. Create an Assembly. When naming the Assembly, ensure naming conventions match with what is present in the Workspace or Maintenance Unit's Workspace Assembly Service field.

   Example: If the Workspace contains an Assembly named "MenuAssembly", you will need to specify "MenuAssembly.WsasFactory" in the Workspace Assembly Service field.

3. Create an Assembly file using the Service Factory source code type.

   NOTE: You will choose the Service Factory and Data Set Service source code types to create two different Assembly files to use with the Menu Component.

   1. Create a new Assembly File for your Menu Component. In the Assemblies Files, right-click on Files and select Add File.

      In the Add File dialog box:

      1. Type WsasFactory as the File Name.

      2. Set your Source Code Type to Service Factory.

      3. Set your Compiler Action to (Use Default).

      4. Select OK.

4. Create the second Assembly File. In the Assemblies Files, right-click on Files and select Add File.

   1. In the Add File dialog box:

      1. Type WsasDataSet as the File Name.

      2. Set your Source Code Type to Data Set Service.

      3. Set your Compiler Action to (Use Default).

      4. Select OK.

5. Select the WsasFactory.cs (Service Factory) Assembly File and uncomment the lines of code that reference the previously created WsasDataSet - Data Set Service Assembly File.

   IMPORTANT: The Service Factory - Assembly File must contain uncommented code to function successfully: case WsAssemblyServiceType.DataSet:return new WsasDataSet();

6. Select the WsasDataSet.cs (Data Set) Assembly File, and begin to customize and build out your Menu Component. See Customization and Menu Component and Items.

7. Click the Save toolbar button to save the changes.

8. Click the Compile Assembly to check syntax button to ensure the Workspace Assembly files compile successfully.

Customization

Developers can customize the Menu Component content through the Data Set Assembly File. Menu Components can contain nested menu items that will expand to display new menu items when hovering over or selecting them.

IMPORTANT: A maximum of 250 menu items are supported.

CAUTION: When attempting to open a dashboard with a Menu Component that contains more than 250 Menu Items, you will receive an error message: Unable to create XFMenuItemCollection. A maximum of 250 menu items are supported.

See Menu Component and Menu Items for a list of all options you can use and set up in the Workspace Assembly or Business Rule code.

The Data Set Assembly file returns a method call that contains the whole collection of Menu Items that builds your Menu Component. When building this out, you will notice that the code contains repetitive elements. When creating new menu items, it will auto-complete and display the default arguments including the Menu Item's unique name, header text, foreground color, background color, and so on.

XFMenuItem XFMenuItem(string uniqueName, string headerText, string foreground, string background, bool isBold, bool isltalic, bool isEnabled, bool isSeparator,
double width, double height, double paddingLeft, double paddingTop, double paddingRight, double paddingBottom, XFImageFileSourceType imageFileSourceType, string 
imageNameOrPath, double imageColumnWidth, string parameterValue, string toolTip, List<XFMenuItem> children)

Sample Customization

See Sample Customization for samples of fully customized Data Set Service Files of a custom Menu Component.

Connect Items to the Menu Component

After customizing and creating your Menu Component, you must update, link, and connect these items. The Workspace retrieves information through its Workspace Assembly Service property, which contains the path to the Assembly and Service Factory - Assembly File. For example, MenuAssembly.WsasFactory. The Service Factory File references the Data Set Assembly file which contains the data and content needed for the Data Adapter. The Data Adapter can then query this data and be connected to the Menu Component to generate the menu items' content on a Dashboard.

IMPORTANT: You can connect any of the following items in any order. You do not need to follow this order.

Update the Data Adapter

1. In the Maintenance Unit, navigate to Data Adapter.

2. Update the Data Source:

   1. Update Command Type to Method.

   2. Update Method Type to Business Rule.

   3. Click on the Method Query ellipsis button, and update the Method Query to reflect the Workspace Menu Component item as it is being returned in the Assembly file or Business Rule. You can also do this through other Command Types, Method Types, or Queries.

      Example: {WS}{MainMenu}{SelectedMenuItem=[|!SelectedMenuItem!|]}

3. Click the Save button to save the changes.

Update the Bound Parameter

NOTE: (Optional) Follow these steps if you are using Bound Parameters as part of your implementation.