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

Essentially, what happens when this button is pressed.

No Action

When the Parameter components are changed, the changes will not be saved.

Save Data for Components

This will save the data modified by the Dashboard components specified in Selection Changed Server Task Arguments property. Separate multiple components listed here with a comma.

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 the data modified by the Dashboard components assigned to the dashboard. These do not have to specified in the Selection Changed Server Task 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.

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

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 is a rectangular control that displays a list of strings to be selected by the user at run time. This component is not compatible with dashboards.

Formatting
See Button.

Action
See Button.

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 is a hierarchical collection of labeled items represented in a tree node. This component is not compatible with dashboards.

Formatting
See Button.

Action
See Button.

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.