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

The kind of dashboard you would like to create. Includes:

  • (Use Default)

  • Top Level: Shows only the top level in OnePlace

  • Top Level Without Parameter Prompts: Shows only the top level in OnePlace and does not resolve parameters, resulting in a slight performance improvement

  • Embedded: A type of dashboard component created after building a dashboard

  • Custom Control: Same as Embedded, but each instance is independent

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.