bridge user guide - smartview · web view2019. 7. 21. · with a single cell selected, this...

Bridge User Guide - SmartView

Bridge

User Guide - SmartView

Version 1.5

Table of Contents

1

Version 1.5Bridge User GuideUser Guide - SmartView

1 Error! No text of specified style in document.Bridge User Guide - SmartView


Table of Contents

Table of Contentsi

Introduction1

SmartView Setup and Configuration2

Designers Toolbar2

Configurator Design Tool4

Data Sources Screen5

Images Screen7

Database Backups Screen7

RSS Feeds Screen8

Snapshot Schedules Screen8

Layout Design Tool11

Select Layout Panel12

New Layout Panel13

Layout Configuration Panel15

Import Layout Panel16

Layout Editor18

Configuration For Cell # Panel19

DataView Design Tool21

Select Content22

New DataView Panel22

DataView Configuration Panel (DataView Configuration Mode)23

Import DataView Panel25

DataView Columns Screen26

DataView Data Screen32

DataView Criteria Screen36

DataView Display Modes Screen39

Dashboard Design Tool44

Dashboards Panel45

New Dashboard Panel45

Dashboard Configuration Panel (Dashboard Configuration Mode)47

Import Dashboard Panel51

Select Layout Panel53

Select Content Panel54

Dashboard Editing Screen56

DataView Configuration Panel (Dashboard Configuration Mode)58

Static Contents Configuration Panels (Dashboard Configuration Mode)82

Managing Filter Rules (Dashboard Configuration Mode)91

Managing Conditional Formatting Rules (Dashboard Configuration Mode)94

Managing Link Configurations98

General SmartView Dashboard Controls104

Dashboard Controls104

Dashboards Panel105

Dashboard Configuration Panel (Analysis Mode)106

Cell and Data View Controls107

DataView Configuration Panel (Analysis Mode)108

Managing Filter Rules (Analysis Mode)114

Managing Conditional Formatting Rules (Analysis Mode)118

Common Panels123

Notes Panel123

Export Options Panel124

Reference127

Data Formatting Codes127

Index131

Table of Contents

ii


Table of Contents

1

Table of Contents

134


130 Table of ContentsBridge User Guide - SmartView


Introduction

Welcome to the SmartView Information Management System. The system provides tools to gather data from external systems, filter, sort, and process the data, then display the data in interactive dashboard views. All fully configurable and customizable.

This guide is primarily for administration-level users, detailing the configuration of data views and dashboards, plus the standard controls within the dashboards.

Note: Access to all data and features in the system are controlled by the user accounts. The type of account you have, and the security rights and roles assigned to it, will affect the following:

· The ability to see and use features to view, create, edit, or delete data.

· The ability to see and use data created by other users. You should always be able to use data you created yourself, unless your account has been changed to remove access.

SmartView Setup and Configuration

Designers Toolbar

The Designers toolbar provides access to the administration and configuration features. These tools control how SmartView retrieves data from external systems, the layout of the dashboards, and how the various data elements are organized and linked together. Some configuration options are merely set as defaults, allowing the dashboard users to make changes and save custom settings.

The Designers toolbar is accessed using the Design option in the Analysis toolbar. This toolbar provides options and controls for the behind-the-scenes configuration of dashboards. This includes the setups for pulling in data from a range of sources, organizing that data, and the visual layout of the dashboard itself.

Click anywhere on the header to open the toolbar panel. This contains various options divided into groups.

The Designers group is used to navigate between the different design tools. The following options are available.

Configurator

Used to create Data Sources, which define how SmartView will obtain data from external systems.

Layout

Used to define layout options for dashboards, arranging and resizing cells to produce an organized presentation.

DataView

Used to build and configure the individual dataviews that will display the data in the dashboard. This is where data is selected, organized, and formatted.

Dashboard

Used to assemble the final dashboard. A layout is selected, dataviews are assigned to cells, default filters and conditions are applied, and links between dataviews are established.

Analysis

Exits designer mode and returns to the standard dashboard toolbar.

Additional groups become available for each tool. See the individual descriptions for details.

Configurator Design Tool

The Configurator tool provides controls for adding and configuring data sources, integrating with external systems to retrieve data.

This feature is generally not available to users, and should only be used by those with in-depth knowledge of the web services and integrations, as well as direct training in the use of this feature.

The Edit group contains the following standard options.

Open

This option is not functional at this time.

Save


New

This option is not available for this tool.

Options


Export


Import


The Configuration group contains the following options.

Data

Displays the Data Sources screen, where integrations with external systems are maintained.

Images

Displays the Images screen, where image files can be uploaded for use in the configurations.

Backup

Displays the Database Backups screen, used to manage backups of the SmartView system.

RSS

Displays the RSS Feeds screen, where RSS configurations can be created to provide live data feeds.

The Management group contains the following option.

Snaps

Displays the Snapshot Schedules screen, used to manage scheduled snapshot configurations.

Data Sources Screen

The Data Sources screen lists all configured data sources, and identifies the type of each data source.

Click a source name to display the Edit Data Source panel below.

The Edit Data Source panel is used to manage the settings for the data source selected in the Data Sources tab.

Edit Data Source

Name

Enter the name of the data source.

Data Source Type

Displays the type of external system that will be providing data. All implementations within the same data source must be of the same type.

· WebService Application Query

Data will be retrieved by a webservice application.

· REST Application Query

Data will be retrieved by a REST API integration.

· OData Queries

Data will be retrieved by an OData service integration.

· RSS Feeds

Documentation to be completed.

· UX Forms

This option is not in use.

· SQL Queries

Uses one or more SQL queries to retrieve custom data directly from the database.

· Weather Query

Returns current and forecast weather data.

· MDX Queries

Uses one or more MDX queries to retrieve custom data directly from the database.

Data Source Implementations

Lists all individual sources included in this data source.

Click Save to save the data source.

If any of the selected configured implementations have been updated outside of the SmartView system, click Refresh Metadata to analyze the sources and make any necessary changes to the data mapping. The data source must be saved after refreshing in order to keep the new metadata.

Click the name of an implementation to view the current settings, or click the Add new implementation icon to display the Edit Data Source Implementation panel below.

Edit Data Source Implementation

Name

Enter the name of the implementation.

Connection Info

Enter the connection code string. This will be custom for every source, and should be obtained from an official administrator or other documented source.

Click Ok to save the implementation, or click Cancel to close the panel without saving any changes.

Images Screen

The Images screen is used to upload image files for use as backgrounds in the dashboard and cells.

Click Select Files to open a standard file selection window. Locate and select the appropriate image file.

On selecting a file, it is added to the list. The filename, extension, and size are displayed.

To delete a file from the system, click the X icon.

Database Backups Screen

The Database Backups screen is used to create backups of the entire SmartView database, including all dashboards and configurations. Backup files are stored internally, and can be restored or deleted as necessary.


RSS Feeds Screen

The RSS Feeds screen is used to configure live data feeds from RSS sources.


Snapshot Schedules Screen

The Snapshot Schedules screen is used to manage scheduled snapshot configurations through the system.

The list panel displays all snapshot schedules. The list can be filtered by entering a full or partial name in the Filter by user field.

Each schedule configuration entry displays the name of the configuration, the name of the user who created it, and a summary of the schedule frequency with a [0 / 0] notation of how many scheduled snapshots have been generated.

Click the name of a configuration to open the schedule details panel.

The following information is available.

Configuration Name

Displays the name of the schedule configuration.

Active

The configuration can be enabled or disabled as needed. If the configuration is disabled, snapshots will not be generated. If the configuration is re-enabled after a period, any missed snapshots will be skipped and the schedule will resume for future snapshots.

User Name

Displays the name of the user who created the configuration.

User Dataview Instance

Displays the name of the dashboard and dataview for which the schedule has been configured.

Frequency

Displays a summary of the schedule frequency.

Active Snapshots

Displays how many snapshots have been generated so far for this configuration.

Runs

Displays the total number of snapshots scheduled for this configuration.

Last Run

Displays the date and time of the most recent snapshot.

Snap-shot expires in

Displays the number of days remaining before the schedule configuration is completed. This number can be modified for active configurations.

If the schedule configuration is active, the Update button is available to save any changes.

If the schedule configuration is inactive, the Delete Generated Snapshots link will delete all snapshots that have been generated so far for the current configuration, and the Delete Schedule link will delete the entire schedule configuration.

Layout Design Tool

The Layout tool is used to design the dashboard layout, arranging and sizing cells to contain the data sources.


Open

Opens the Select Layout panel to choose an existing layout for editing.

Save

Saves the current layout.

New

Opens the New Layout panel to create a new layout.

Options

Opens the Configuration panel to change the settings for the current layout.

Export

Opens a standard Save window to export the current layout to an XML file. Select a location, enter a filename, and click Save.

Import

Opens the Import Layout panel to import a layout file created with the Export option.

The Cells group contains the following options.

Split 2 (vertical)

With a single cell selected, this option will split the cell vertically into two equal cells.

Split 2 (horizontal)

With a single cell selected, this option will split the cell horizontally into two equal cells.

Split 3 (vertical)

With a single cell selected, this option will split the cell vertically into three equal cells.


With a single cell selected, this option will split the cell horizontally into three equal cells.

Split 5 (vertical)

With a single cell selected, this option will split the cell vertically into five equal cells.


With a single cell selected, this option will split the cell horizontally into five equal cells.

Merge (vertical)

With multiple cells selected in a row (hold the Ctrl key and click on each cell), this option will merge the cells into one cell. The cells must be exactly the same height and alignment. Any space between the selected cells will be included in the merged cell.

Merge (horizontal)

With multiple cells selected in a column (hold the Ctrl key and click on each cell), this option will merge the cells into one cell. The cells must be exactly the same width and alignment. Any space between the selected cells will be included in the merged cell.

Delete

With a single cell selected, this option will delete the cell.

When the Layout window opens, the layout for the currently selected dashboard will open by default. Use the options in the Edit group to Open or Import an existing layout, or use New to create a new layout.

Proceed to the Layout Editor section when the proper layout is displayed.

Select Layout Panel

The Layout panel opens to the right of the screen when selecting Open from the Edit group. Click X to close the panel again.

This panel is used to open an existing layout configuration saved in the system.

Click the name to open the layout in the Layout Editor.

New Layout Panel

The New Layout panel opens to the right of the screen when selecting New from the Edit group. Click X to close the panel again.

This panel is used to create a new layout configuration.

Name

Enter the name of the new layout.

Height and Width

Enter the height and width of the dashboard as a percentage of the available screen space within the browser window.

100% is the default. Numbers less than 100% will leave part of the dashboard area blank, while numbers greater than 100% will extend the dashboard with scrollbars.

The size of the dashboard and all cells are set as percentages of the screen space, so resizing the browser window will resize the dashboard and cells, maintaining the percentage ratio.

This option sets the screen space available for the minimum and maximum size settings below.

Min Height and Min Width

These options set the minimum size of the dashboard. When the available screen space exceeds these settings, the dashboard will resize normally as the browser window is resized. If the screen space is reduced to less than these settings, the dashboard will remain at the minimum size with the extra space cut off by the browser window. No scrollbars will be available to view the areas that are outside of the window.

Max Height and Max Width

These options set the maximum size of the dashboard. When the available screen space is less than these settings, the dashboard will resize normally as the browser window is resized. If the screen space is increased to more than these settings, the dashboard will remain at the maximum size, leaving blank space.

Click Create New Layout to display the layout in the Layout Editor. Note that the layout is not yet saved at this point.

Layout Configuration Panel

The Configuration panel opens to the right of the screen when selecting Options from the Edit group. Click X to close the panel again.

This panel is used to edit the configuration options for the current layout.

Name

Enter the name of the new layout.

Height and Width

Enter the height and width of the dashboard as a percentage of the available screen space within the browser window.

100% is the default. Numbers less than 100% will leave part of the dashboard area blank, while numbers greater than 100% will extend the dashboard with scrollbars.

The size of the dashboard and all cells are set as percentages of the screen space, so resizing the browser window will resize the dashboard and cells, maintaining the percentage ratio.

This option sets the screen space available for the minimum and maximum size settings below.

Min Height and Min Width

These options set the minimum size of the dashboard. When the available screen space exceeds these settings, the dashboard will resize normally as the browser window is resized. If the screen space is reduced to less than these settings, the dashboard will remain at the minimum size with the extra space cut off by the browser window. No scrollbars will be available to view the areas that are outside of the window.

Max Height and Max Width

These options set the maximum size of the dashboard. When the available screen space is less than these settings, the dashboard will resize normally as the browser window is resized. If the screen space is increased to more than these settings, the dashboard will remain at the maximum size, leaving blank space.

Click Apply Changes to update the layout in the Layout Editor. Note that the changes are not saved until the layout itself is saved.

Import Layout Panel

The Import Layout panel opens to the right of the screen when selecting Import from the Edit group. Click X to close the panel again.

This panel is used to import a layout that has been exported to a file.

The Source File category is used to select the import file. Click the button to open a standard file browser window. Locate and select the appropriate export file. The file name appears next to the button.

The Options category controls how components will be imported. The following options are available:

Layout

Select how components will be handled during the import.

· None

This component will not be imported.

· Add a new entity

The import will be added as a new component, even if a component already exists with the same name.

· Add if not found

If a component exists with the same name, the import will not be performed. Otherwise, the import will be added as a new component.

· Update existing. Add if not found

If a component exists with the same name, it will be updated. Otherwise, the import will be added as a new component.

· Update existing matching on Name

If a component exists with the same name, it will be updated. Otherwise, the import will not be performed.

Click Import to import the file.

Notes: If one of the Update Existing options are selected and more than one matching layout is found, the first matching layout will be updated.

If one of the Update Existing options are selected, the saved layout is updated. If that layout is currently open in the Layout Editor, it will not show any changes immediately. Re-open the saved layout to see the imported changes. If the layout is saved before the imported changes are re-loaded, it will overwrite the imported changes.

Layout Editor

The editor section provides a preview of the layout, and allows direct editing of the cell spacing.

Each cell includes information in the top-left corner.

The Cell Config icon opens the Configuration for Cell # panel to manage settings for the current cell.

Cell No

Each cell in the layout has a unique cell number. All dataviews are associated to the cell number, so moving the cell numbers around is a quick way to move the cell content around. The cell number assignment can be modified through the Configuration for Cell # panel.

Size

Displays the percentage of the layout occupied by the cell. Splitting, combining, and manually resizing the cell will show the current percentages.

To use the controls in the Cells group, select one or more cells (to select multiple cells, hold the Ctrl key and click on each cell). The selected cells are highlighted in blue. Note that certain controls have restrictions on how many cells can be selected, or how the selected cells must be aligned. See the option descriptions for details.

To manually resize cells, click and drag the edges of the cells. Note that resizing one cell can push the edges of surrounding cells, but will not pull them back.

When all changes have been made, click Save to save the layout.

Configuration For Cell # Panel

The Configuration for Cell # panel opens to the right of the screen when clicking the Cell Config icon in a particular cell. Click X to close the panel again.

This panel contains settings for the selected cell.

The General category includes the controls for the cell.

Cell Numbers

Each cell in the layout has a unique cell number. All dataviews are associated to the cell number, so moving the cell numbers around is a quick way to move the cell content around. Select a different number to swap numbers with that cell.

Lock Cell

Enable the lock to prevent the cell from being resized, either in the layout editor window or in the Dimensions settings below. A locked cell is displayed in the layout editor with a dark gray background and red outline.

The Dimensions category is used to set the position and size of the cell. These can also be set by dragging the edges of the cell in the layout editor.

Left and Top

These settings define the position of the top-left corner of the cell, presented as a percentage of the total dashboard area.

Width and Height

These settings define the size of the cell, presented as a percentage of the total dashboard area.

Tip: Locking the cells around the current cell, then using the Dimensions settings to modify the position and size of the cell can cause the cells to overlap. This is useful to create cells that open on top of other cells to focus on some data.

The Dimensions settings can also extend a cell off-screen. Take care not to push the Cell Config icon off the screen, or it may be impossible to re-open the configuration panel after closing it.

Click Apply Design Configurations to save the changes.

DataView Design Tool

The DataView tool is used to design the tables, graphs, charts, etc. displayed within the cells. Data is selected, formatted, and organized, then rules and links are created.


Open

Opens the Select Content panel to choose an existing dataview for editing. This same panel opens when entering the DataView section, and can be closed to use the New or Import options instead.

Save

Saves the current dataview and settings.

New

Opens the New DataView panel to create a new dataview.

Options

Opens the Configuration panel to change the settings for the current layout.

Export

Opens a standard Save window to export the current dataview to an XML file. Select a location, enter a filename, and click Save.

Import

Opens the Import DataView panel to import a dataview file created with the Export option.

The DataView group contains the following options.

Cols

Displays the DataView Columns screen, where data is assigned to columns and formatted.

Data

Displays the DataView Data screen, where sorting, subtotals, ranking, and grouping rules are configured. grouping rules are configured.

Criteria

Displays the DataView Criteria screen, where data can be locked or set as required.

Display

Displays the DataView Display Modes screen, used to define the available display types that can be selected in the dashboard configuration and analysis modes.

Select Content

The Select Content panel opens to the right of the screen when selecting Open from the Edit group. Click X to close the panel again.

This panel is used to open an existing dataview configuration saved in the system.

Click Show All to display all available dataviews. This includes dataviews that you have created, dataviews that have been marked as available to everyone, and dataviews that you can access due to a security role.

To locate a specific dataview, enter text in the Filter field. The listed dataviews are filtered as you type.

Click the name to open the dataview in the DataView Columns screen.

New DataView Panel

The New DataView panel opens to the right of the screen when selecting New from the Edit group. Click X to close the panel again.

This panel is used to create a new dataview configuration.

Name

Enter the name of the new dataview.

Topic

Select the data source topic. The topics are defined in the metadata of the data sources. This will filter the options available in the Data Source View field.

Data Source View

A data source may have multiple views, which define a subset of the data. Select a view.

Click Create New DataView to display the dataview in the DataView Columns screen. Note that the dataview is not yet saved at this point.

DataView Configuration Panel (DataView Configuration Mode)


This panel is used to edit the configuration options for the current dataview.

Name

Enter the name of the dataview.

Title

Enter the title to be displayed at the top of the dataview in Analysis mode.

Description

Enter a description of the dataview.

Who will get access to it

Select if the dataview is private or shared. This affects the ability to select the dataview in the Dashboard Design Tool, and the ability to see the view in Analysis mode.

· Only me

Only you will be able to see this dataview.

· Everyone

The dataview will be visible to all users.

· People with the following security role

Only accessible to users with a specific security role assigned to their user account. Select this option and enter the Code of the required security role.

Multiple roles can be provided, formatted as comma-separated and without spaces. If a user has at least one of these roles, they will be able to see the dataview.

Created by

Identifies the date and time the dataview was created, and the user who created it.

Last Modified by

Identifies the last date and time the dataview was changed, and the user who made the changes.

The changes are applied immediately, but are not saved until the dataview itself is saved.

Import DataView Panel

The Import DataView panel opens to the right of the screen when selecting Import from the Edit group. Click X to close the panel again.

This panel is used to import a dataview that has been exported to a file.


The Options category controls how components will be imported. The following options are available:

· None


· Add a new entity


· Add if not found






The following components can be set for import.

Data View

Select how the data view itself should be imported.

Data Source View

The Data Source associated to the view can be imported along with the view. Select how it should be imported.


Notes: If one of the Update Existing options are selected and more than one matching item is found, the first matching item will be updated.

If one of the Update Existing options are selected, the saved item is updated. If that item is currently open in the editor window, it will not show any changes immediately. Re-open the saved item to see the imported changes. If the item is saved before the imported changes are re-loaded, it will overwrite the imported changes.

DataView Columns Screen

The Cols option switches to the DataView Columns editing screen. This screen is used to select the columns that will be displayed in the dataview and define the settings for each column.

The screen is composed of three sections.

The Data Source View Columns section lists all available columns in the selected data source view. The Title and Data type are displayed for each column.

Select a column and click Add View Column to add a column detail entry in the DataView Columns section below. This entry will include the default settings for the appropriate data type.

Click Add New Column to add a blank detail entry in the DataView Columns section below. This entry will have the base settings, and can be configured as needed. These blank entries are generally used to create new columns that are derived from other data, rather than pulling data directly from the data source.

The Preview section shows how the data will appear with the current settings. Click the Refresh Preview button to show the results of any changes.

The DataView Columns section displays a column detail panel for each column in the dataview. These are used to define the settings for each column.

Header

Enter the column header. If no header is provided, a default column number will be displayed. To have a column without a header, use the dashboard configuration to hide the header.

Type

Select the type of data.

· Data source column

This column will display data taken from the associated data source.

· Calculated column

This column will be calculated from data in other columns.

· Constant value

This column will display a single specified value.

· Ranking value

Provides ranking values based on data in another column.

Source

This field is available when Data source column is selected as the Type. Select a column from the associated data source.

Expression

This field is available when Calculated column is selected as the Type.

Value

This field is available when Constant value is selected as the Type. Enter the text or value to be displayed in each row of the column.

Data type

Select the type of data in the column, Text, Integer, Decimal, Date, or Boolean. For Data source column and Ranking value columns, this will be preset to the appropriate data type.

Display

Select how the value will be displayed.

· Value

Displays the straight value.

· Running total

Displays a total of the current value plus all preceding values in the column.

· Group running total

Displays a total of each group plus all preceding group values in the column.

· Percent to total

Displays the current value as a percentage of the total value for the column.

· Percent to group

Instructions to be completed.

Summary

Displays a Total line at the bottom of the table, containing a summary value for the column. Note that summaries are calculated from visible values, so grouped values must have Aggregate settings. Total and subtotal lines themselves are also not included in the summary.

· Average

Displays the average of all rows.

· Average of non empty

Displays the average of all rows that contain a value, including zero.

· Average of non zero

Displays the average of all rows that contain a value, not including zero.

· Count

Displays the total number of rows.

· Count of non empty

Displays the total number of rows that contain a value, including zero.

· Count of non zero

Displays the total number of rows that contain a value, not including zero.

· Maximum

Displays the highest value in the column.

· Minimum

Displays the lowest value in the column, including zero or no value. Note that if the minimum value is no value, then the total will be blank.

· Minimum of non empty

Displays the lowest value in the column, including zero.

· Minimum of non zero

Displays the lowest value in the column, not including zero.

· Sum

Displays the total of all values in the column.

Aggregate

When grouping is used, the Aggregate settings define how grouped values will be displayed. If no aggregate is selected, no value will be displayed for grouped values.

· Average

Displays the average of all rows in the group.


Displays the average of all rows in the group that contain a value, including zero.


Displays the average of all rows in the group that contain a value, not including zero.

· Count

Displays the total number of rows in the group.


Displays the total number of rows in the group that contain a value, including zero.


Displays the total number of rows in the group that contain a value, not including zero.

· Maximum

Displays the highest value in the group.

· Minimum

Displays the lowest value in the group, including zero or no value. Note that if the minimum value is no value, then the aggregate value will be blank.


Displays the lowest value in the group, including zero.


Displays the lowest value in the group, not including zero.

· Sum

Displays the total of all values in the group.

Format

Enter the formatting code to define how the value is displayed in the dashboard. See the Data Formatting Codes section for instructions on formatting codes.

Note that the codes provided here will be used as the default formatting when adding the DataView to a Dashboard configuration, but can be overridden in Dashboard design or Analysis modes. Once the format codes have been saved in the Dashboard or Analysis modes, changing the format here will have no effect on those settings.

FormatX

Enter the formatting code to define how the value will be displayed when exported to an Excel file. This field accepts standard Excel format codes.

Note that the codes provided here will be used as the default formatting when adding the DataView to a Dashboard configuration, but can be overridden in Dashboard design or Analysis modes. Once the format codes have been saved in the Dashboard or Analysis modes, changing the format here will have no effect on those settings.

Alignment

Select if the data should be aligned to the left, centered, or the right.

When hovering the mouse over a column detail panel, a control bar appears at the top of the panel.

/

Left / Right

Shifts the column one space to the left or right.

Remove

Removes the column from the list.

Hide / Show

Hides the column, but leaves it available for various functions. The column detail panel is collapsed to a narrow vertical bar with the Header label displayed. Click the collapsed panel to expand it again. The background will appear gray for hidden columns. Click the icon again to show the column.

Collapse

Collapse the column detail panel to a narrow vertical bar with the Header label displayed. Click the collapsed panel to expand it again.

Collapse All

Collapse all column detail panels to narrow vertical bars with the Header labels displayed. Click any collapsed panel to expand it again.

DataView Data Screen

The Data option switches to the DataView Data editing screen. This screen is used to apply rules and settings that control the organization of the data within the dataview.

The screen is composed of four sections.


The Sorting section provides options for sorting the data and adding rows for totals. These are the default settings, which can be overridden in the dashboard design tool, as well as by each user in analysis mode.

Sort by

Select the first sorted column. Click the arrows to sort in ascending or descending order. Click to delete the line. When a Sort by column is selected, a Then by field is added below.

Then by

Select all additional columns to sort by, in order. Click the arrows to sort in ascending or descending order. Click the to delete the line.

Subtotal Options

Click one or more options for displaying totals and subtotals.

· Show Data Rows

Select this option to include the individual data rows. Without this option, only the selected total and subtotal lines will be displayed.

· Show Subtotal Rows

Displays a subtotal row for group, up to the selected number of Subtotal Levels.

· Show Grand Total

Displays a grand total row at the bottom of the table.

Subtotal Levels

Select how many groups defined in the Grouping section should have a subtotal. This setting can exceed the number of defined groups, and will apply if additional groups are set in the dashboard configuration or analysis modes.

The Ranking section is used to assign numerical grading to rows based on the values of a specific column. To display the ranking data, a column of type Ranking Value must also be included in the DataView Columns list.

Ranking Column

Select the column on which to base the rankings.

Limit To

These settings are used to limit the display to just the highest or lowest values.

First or Last

Select if the system should display the First or Last ranked values.

Number

Enter the limit number according to the type of ranking.

Ranking Type

Select if the limit should be based on Rows, Percent, or Sum.

· Rows: Displays the selected Number of first or last ranked rows.

· Percent: Displays the first or last ranked rows, up to the specified Number percentage of the total rows.

· Sum: Displays the first or last ranked rows where the combined values in the Ranking Column is up to, but not exceeding, the specified Number.

Group Others

If there are more rows than will be included in the ranking display, they can be grouped. When Group Others is enabled, an extra row will be displayed to represent all remaining rows. If the option is disabled, the extra rows will not be displayed.

The Name field is required when Group Others is enabled. In addition, Aggregate settings will be necessary to display any values for the group.

Name

When Group Others is enabled, a name must be provided for the group row.

The Grouping section combines rows that have the same information in certain columns. Select the first Group by column. This will produce one row for each unique entry in that column.

When a Group by column is selected, a Then by field is added below to group by additional columns. One row will be shown for each unique combination of all group columns.

Click to delete a group column.

DataView Criteria Screen

The Criteria option switches to the DataView Criteria editing screen. This screen is used to define which columns will be available for criteria settings, and the conditions for each available column.


The Data Source View Criteria section lists the columns that can be used for criteria settings.

Select a column and click Add Criteria to add a column entry in the DataView Criteria section below.


The DataView Criteria section displays settings for each column added to the criteria.

Lock for Users

When this option is enabled, this criteria can only be set in dashboard designer mode. It will not be visible in analysis mode.

Required


Dynamic Allowed Values

When this option is enabled, a column from another dataview can be defined to provide the available criteria values. These values will be available in analysis mode when adding or modifying the criteria for this column.

Dataview

When Dynamic Allowed Values is enabled, select the dataview containing the column with the dynamic values.

Column

When Dynamic Allowed Values is enabled and a Dataview has been defined, select the column with the dynamic values.

When hovering the mouse over a column detail panel, a control bar appears at the top of the panel.

Remove

Removes the column from the list.

Hide / Show

Hides the column, but leaves it available for various functions. The column detail panel is collapsed to a narrow vertical bar with the Header label displayed. Click the collapsed panel to expand it again. The background will appear gray for hidden columns. Click the icon again to show the column.

Collapse

Collapse the column detail panel to a narrow vertical bar with the Header label displayed. Click the collapsed panel to expand it again.

Collapse All

Collapse all column detail panels to narrow vertical bars with the Header labels displayed. Click any collapsed panel to expand it again.

DataView Display Modes Screen

The Display option switches to the DataView Display Modes selection screen. This screen is used to select which display modes are appropriate for the data in the current dataview. Display modes that are enabled in this screen will be available for selection in the dashboard configuration and analysis modes.

The screen is composed of two sections.

The Preview section shows how the data will appear with the current settings. Click the Refresh Preview button to show the display mode selected as the default. Note that some view modes require additional settings that are only available in dashboard configuration or analysis modes, and cannot be displayed in the preview section.

The DataView Display Modes section displays all available view modes. Click on a display mode to enable (dark blue) or disable (light blue) each view mode. Click the box within an enabled view mode to make it the default mode.

Each display mode has specific data requirements, detailed below. Display modes that do not match the data should not be enabled.

Table

This is the standard table display, and can be used with any data that is organized into columns and rows.

Card

Displays the data as a series of cards, with one card for each row of data. This requires data to be organized into columns and rows.

Image


Articles


KPI

The Key Performance Indicator (KPI) report displays one record at a time, providing a single value from that record. An optional chart can be included to display trend values. This requires table data with one numerical column to serve as the Value Column and another column to provide the Trend Values. The data in the Trend Values must be comma-separated numerical values, without any spaces. Since the KPI report can only display one record at a time, criteria must be configured to filter the results.

Line Chart

A chart showing lines connecting data points across a horizontal category axis. This requires table data with one column to serve as the Category Column and at least one numerical column to provide the data points. Only numerical columns will be charted as data points, even if other columns are present.

Bar Chart

A chart showing horizontal bars representing data points arranged on a vertical category axis. This requires table data with one column to serve as the Category Column and at least one numerical column to provide the data points. Only numerical columns will be charted as data points, even if other columns are present.

Column Chart

A chart showing vertical bars representing data points arranged on a horizontal category axis. This requires table data with one column to serve as the Category Column and at least one numerical column to provide the data points. Only numerical columns will be charted as data points, even if other columns are present.

Area Chart

A chart showing lines connecting data points across a horizontal category axis, with the space between the line and the axis filled in with color. This requires table data with one column to serve as the Category Column and at least one numerical column to provide the data points. Only numerical columns will be charted as data points, even if other columns are present.

Pie Chart

A circular chart divided into segments. This requires table data with one column to serve as the Category Column and one numerical column to define the segments. Any other columns will be ignored.

Donut Chart

A ring-shaped chart divided into segments. This requires table data with one column to serve as the Category Column and one numerical column to define the segments. Any other columns will be ignored.

Radar Chart

A chart showing lines connecting data points around a circular category axis. This requires table data with one column to serve as the Category Column and at least one numerical column to provide the data points. Only numerical columns will be charted as data points, even if other columns are present.

Tree Map

A series of bars or squares with sizes relative to the selected value. This requires table data with one column to serve as the Label Column and one numerical column to define the relative sizes of the bars or squares. Note that the dataview must be set to Show Subtotal Rows and the Subtotal Levels must be set to at least Level 1.

Radial Gauge

A round gauge with a configurable range, containing one or more pointers displaying values within that range. This requires table data with one numerical column to provide the data points. Other columns can be included in the table for filtering and grouping purposes, but will not be used in the gauge.

Linear Gauge

A horizontal or vertical line gauge with a configurable range, with a colored line displaying a value within that range. This requires table data with one numerical column to provide the data point. Other columns can be included in the table for filtering and grouping purposes, but will not be used in the gauge.

Map


Weather Card


HTML


Dashboard Design Tool

The Dashboard tool is used to assign dataviews to the current layout and apply default configuration settings.

This is the default tool that opens when entering design mode, and the current dashboard will be displayed by default.


Open

Opens the Dashboards panel to load a different dashboard.

Save

Saves the current dashboard.

New

Opens the New Dashboard panel to create a new dashboard.

Options

Opens the Configuration panel to change the settings for the current dashboard.

Export

Opens a standard Save window to export the current dashboard to an XML file. Select a location, enter a filename, and click Save.

Import

Opens the Import Dashboard panel to import a dashboard file created with the Export option.

The Dashboard group contains the following options.

Layout

Opens the Select Layout panel to choose a different layout configuration for the dashboard.

Insert

Opens the Select Content panel to add a dataview configuration to the dashboard.

When the Dashboard window opens, the currently selected dashboard will open by default. Use the options in the Edit group to Open or Import an existing dashboard, or use New to create a new dashboard.

Proceed to the Dashboard Editing Screen section when the proper dashboard is displayed.

Dashboards Panel

The Dashboards panel opens to the right of the screen when selecting Open from the Edit group. Click X to close the panel again.

The dashboards are displayed by category. Each category can be expanded or collapsed using the and icons.

The User Dashboards category includes all dashboards that you have marked for Quick Access, currently or in the past.

Click Show All to display all available dashboards. This includes dashboards that you have created, dashboards that have been marked as available to everyone, and dashboards that you can access due to a security role.

Click the name of a dashboard to open it. Proceed to the Dashboard Editing Screen section.

New Dashboard Panel

The New Dashboard panel opens to the right of the screen when selecting New from the Edit group. Click X to close the panel again.

Name

Enter the name of the dashboard.

Description

Enter a description of the dashboard.

Layout

Select a layout configuration. Layouts can be created and customized in the Layout Design Tool section.

Icon

Select an icon to be displayed in the Quick Access group in analysis mode.

Lock dashboard customization

If the dashboard is unlocked, users will be able to customize many settings for the dashboard and dataviews, such as filtering and sorting. These custom settings only apply to their own view, and will not affect other users.

If the dashboard is locked, users can still select from the available display modes, but cannot modify or save custom settings.

Automatically refresh every

When activated, the dashboard will refresh all data at intervals entered in the Seconds field.


Select if the dashboard is private or shared. This affects the ability to see and edit the dashboard in the Dashboard Design Tool, and the ability to see the dashboard in Analysis mode.

· Only me

Only you will be able to see this dashboard.

· Everyone

The dashboard will be visible to all users.



Multiple roles can be provided, formatted as comma-separated and without spaces. If a user has at least one of these roles, they will be able to see the dashboard.

Click Create New Dashboard to display the dashboard in the Dashboard Editing Screen. Note that the dashboard is not yet saved at this point.

Dashboard Configuration Panel (Dashboard Configuration Mode)


This panel is used to edit the configuration options for the current dashboard.

The General category provides access to the general settings for the dashboard.

Name

Enter the name of the dashboard.

Description

Enter a description of the dashboard.

Icon

Select an icon to be displayed in the Quick Access group in analysis mode.

Lock dashboard customization

If the dashboard is unlocked, users in analysis mode will be able to customize many settings for the dashboard and dataviews, such as filtering and sorting. These custom settings only apply to their own view, and will not affect other users.

If the dashboard is locked, users can still select from the available display modes, but cannot modify or save custom settings.

Automatically refresh every

When activated, the dashboard will refresh all data at intervals entered in the Seconds field.


Select if the dashboard is private or shared. This affects the ability to see and edit the dashboard in the Dashboard Design Tool, and the ability to see the dashboard in Analysis mode.

· Only me

Only you will be able to see this dashboard.

· Everyone

The dashboard will be visible to all users.



Multiple roles can be provided, formatted as comma-separated and without spaces. If a user has at least one of these roles, they will be able to see the dashboard.

Created by

Identifies the date and time the dashboard was created, and the user who created it.

Last Modified by

Identifies the last date and time the dashboard was changed, and the user who made the changes.

The Appearance category contains settings for the dashboard background. Note that changes will not be visible in dashboard designer mode.

Host parameters Cell No


Position X and Position Y

Enter the base position of any background image file. Background repeat settings will be applied from this base point.

The position values are provided as a percentage of the dashboard area, and set the position of the center of the image file. For example, 50% for X and 50% for Y will center the image.

Color

Select the color of the dashboard background.

Image URL

The URL for a background image file can be entered. Entering a value in this field will remove any selection from the Image File field.

Image File

An image file can be selected from those uploaded in the Images Screen of the Configurator Design Tool. Selecting an image file will remove any URL from the Image URL field.

Background repeat

Select how the background image will be repeated.

· Initial


· Inherit


· No-repeat

The image will be displayed once at the base position.

· Repeat

The image will be repeated vertically and horizontally from the base position.

· Repeat-x

The image will be repeated horizontally from the base position.

· Repeat-y

The image will be repeated vertically from the base position.

Background attachment


Import Dashboard Panel

The Import Dashboard panel opens to the right of the screen when selecting Import from the Edit group. Click X to close the panel again.

This panel is used to import a dashboard that has been exported to a file.


The Options category controls how components will be imported. The following options are available for each component:

· None


· Add a new entity


· Add if not found






The following components can be set for import.

Dashboard

Select how the dashboard itself should be imported.

Data View Instance

The Data Views included in the dashboard can be imported along with the dashboard. Select how it should be imported.

Data View

The Data Views included in the dashboard can be imported along with the dashboard. Select how it should be imported.

Data Source View

The Data Sources included in the dashboard can be imported along with the dashboard. Select how it should be imported.

Layout

The Layout used for the dashboard can be imported along with the dashboard. Select how it should be imported.


Notes: If one of the Update Existing options are selected and more than one matching layout is found, the first matching layout will be updated.

If one of the Update Existing options are selected, the saved layout is updated. If that layout is currently open in the Layout Editor, it will not show any changes immediately. Re-open the saved layout to see the imported changes. If the layout is saved before the imported changes are re-loaded, it will overwrite the imported changes.

Select Layout Panel

The Select Layout panel opens to the right of the screen when selecting Layout from the Dashboard group. Click X to close the panel again.

This panel is used to apply a different saved layout to the current dashboard.

Each layout name is followed by the percentage size of the dashboard, as configured in the layout design. A preview of the cell division is displayed below the name.

Click a name to select and apply the new layout. Any dataviews already assigned to the dashboard will be re-assigned to the cells with the same cell number as in the previous layout. If no matching cell exists in the new layout, the dataview will be placed in the tray section at the bottom of the dashboard.

Note that the changes are not saved until the dashboard is saved.

Select Content Panel

The Select DataView panel opens to the right of the screen when selecting Insert from the Dashboard group or clicking the add icon in a cell or the tray section. Click X to close the panel again.

The DataViews category lists available dataview configurations.

Click Show All to display all available dataviews. This includes dataviews that you have created, dataviews that have been marked as available to everyone, and dataviews that you can access due to a security role.

To locate a specific dataview, enter text in the Filter field. The listed dataviews are filtered as you type.


Click a name to add the dataview or static content. If adding from a cell, the selection is added to that cell. If adding from the tray section or the Insert option, the selection is added to the tray section, but can then be moved to a cell.

The addition of the selected component is automatically saved, although no other changes to the dashboard are saved.

Dashboard Editing Screen

The main screen of the Dashboard tool shows the current cell layout and the dataview or content assignments.


Parameter fields can be added to the dashboard, allowing users to quickly enter or select values that will be used to filter dataview content.

Open the Select a parameter to add field and select one of the columns from any of the dataviews currently included in the dashboard. Click the Add icon to add the parameter.

Once a parameter has been added, it can be selected as a Criteria setting for dataviews.

If no parameter fields are configured for a dashboard, the cells will extend to use the extra space.

The main area of the dashboard displays the cells as configured in the selected layout. Each cell includes an add icon which opens the Select Content panel.

When a dataview or static content is assigned to a cell, it appears as a tab in the cell header, and is labeled with its default title. The delete icon removes the tab. The configuration icon opens the configuration panel to manage default settings for the tab, depending on the type of dataview or static content. Clicking the title itself shows or hides a sample of the data, which can be used to preview changes to the settings.

Tabs can be rearranged by dragging them between cells and the tray section.

At the bottom of the dashboard is the tray section. This contains additional tabs that are kept collapsed by default. Clicking one of these tabs in analysis mode expands it to full-screen view, and the Collapse icon returns it to the tray. This section is useful for providing additional information that does not need to be displayed in the main dashboard view.

DataView Configuration Panel (Dashboard Configuration Mode)

The Configuration panel opens to the right of the screen when clicking the configuration icon for a DataView tab, and contains settings for the current view. Click X to close the panel again.

These settings become the default configuration for the dataview, although many of these options can be overridden by each user in analysis mode.

The options are displayed by category. Each category can be expanded or collapsed using the and icons.

The General category includes the following options.

Title

Enter the title of the data view to be displayed at the top of the cell.

Display Mode

Select the default display mode. The available modes are defined in the Display screen of the dataview configuration.

Visible

If enabled, the dataview will be visible at all times. If disabled, the dataview will be hidden when the dashboard loads. If another dataview is linked to the current dataview, activating that link will reveal and refresh the current dataview.

Background Image URL

This feature is not functional at this time.

Trace Info


Click Revert default configuration to reset the data view to its original configuration. This deletes any custom configuration saved for the view.

The Appearance category includes the following options.

Display Window Title Bar

If enabled, the title bar will be displayed at the top of the cell. If disabled, the titles of all dataviews within the cell will be hidden, as well as the Control icon.

Note that hiding the title bar will prevent access to this settings page in analysis mode. Also, if the title bar is hidden for a tab in the tray area, the tab will still expand but the icon will not be available to collapse the tab again.

Display Toolbar

If enabled, the Control icon will be displayed to the left of the dataview name, providing access to the configuration options for that data view. If disabled, the Control icon will not be displayed.

Note that hiding the control icon will prevent access to this settings page in analysis mode.

Allow Maximize

If enabled, the Expand icon will be displayed at the right of the title bar, allowing the cell to be expanded to fill the dashboard. If disabled, the Expand icon will not be displayed.

Note that if this option is disabled for a tab in the tray area, the tab will still expand but the icon will not be available to collapse the tab again.

Display Criteria Values

Select how criteria will be displayed in the tab.

· Hidden

Criteria will not be displayed in the cell, and can only be viewed in the configuration.

· Title Button

The Criteria icon will be displayed in the top right of the cell whenever there are criteria rules applied to the current data view. The user can click the icon to view the criteria.

· In Title

The criteria will be displayed at the end of the tab title whenever there are criteria rules applied to the current data view.

Display Links

This feature is currently inactive.

Maximum Number Of Rows

Enter the maximum number of rows to be displayed. The See All icon becomes available in the top right of the cell, which will show all rows.

Tab Index

When multiple dataviews are included in a cell, the Tab Index controls the order in which they will be displayed. Enter the number for the current dataview.

Tab Title

This feature is currently inactive.

The Columns category controls the configuration of each data element in the view.

The top table is used to select each element by Title, displaying the configuration settings for each. The Data Type column identifies the type of data. Click the Show icons to set whether the column is shown or hidden . Click and drag the Move icon to change the order of the columns.

Title

Enter the name of the data element. This will serve as the column name for tables, label for card layout, or legend entry for charts.

Format

Select a pre-set format or enter the formatting code to define how the value is displayed. See the Data Formatting Codes section for instructions on formatting codes.

On attaching a DataView to the cell, the formats are defaulted to those defined in the DataView configuration. Defining a different format here will override the original setting. Note that the codes provided here can be overridden in Analysis mode.

Format when exporting to Excel

Select a custom format for when the data is exported. This uses the Excel formatting rules, which may not match the display Format defined above.

Alignment

Select if the data should be aligned to the left, centered, or the right.

Width

Enter the column width, in pixels. Enter zero to return to the default width.

Summarize As

Select what value will be displayed in the Total line.

· None

No summary value will be displayed.

· Average

Displays an average of all rows.


Displays an average of all rows that include a value. Rows without a value in this column are omitted from the average.



· Count

Displays the total number of rows.


Displays the total number of rows that include a value. Rows without a value in this column are not counted.



· Maximum

Displays the highest value in the column.

· Minimum

Displays the lowest value in the column, including zero or no value.


Displays the lowest value in the column, including zero.



· Sum

Displays the total of all values in the column.

Display As

This option is available for numeric values.

· Value

Displays the straight value.

· Running total

Displays a total of the current value plus all preceding values in the column.

· Group running total

Displays a total of each group plus all preceding group values in the column.

· Percent to total

Displays the current value as a percentage of the total value for the column.

· Percent to group


Template


The Data Options category includes settings grouped into tabs, detailed below.

The Sorting & Sub-Totals tab includes the following options.

Sort by

Select the first sorted column. Click the arrows to sort in ascending or descending order. Click to delete the line. When a Sort by column is selected, a Then by field is added below.

Then by

Select all additional columns to sort by, in order. Click the arrows to sort in ascending or descending order. Click the to delete the line.

Subtotal Options

Click one or more options for displaying totals and subtotals.

· Show Data Rows

Select this option to include the individual data rows. Without this option, only the selected total and subtotal lines will be displayed.

· Show Subtotal Rows

Displays a subtotal row for each unique entry in the selected Sort by column.

· Show Grand Total

Displays a grand total row at the bottom of the table.

Subtotal Levels

Select how many groups defined in the Grouping section should have a subtotal. This setting can exceed the number of defined groups, and will apply if additional groups are set in analysis mode.

The Filtering tab lists all current filter rules.

The title provides a summary of the filter conditions. Click and drag the Move icon to change the order of the rules. Click to delete the rule.

Click the title to view an existing filter rule, or click the Add new rule icon to create a new rule. See the Managing Filter Rules section for details.

The Conditional Formatting tab allows special formatting rules to be applied when certain conditions are met.

The title provides a summary of the formatting conditions. Click and drag the Move icon to change the order of the rules. Click to delete the rule.

Click the title to view an existing formatting rule, or click the Add new rule icon to create a new rule. See the Managing Conditional Formatting Rules section for details.

Base criteria can be applied to a dataview at the configuration level. Criteria rules are high-level conditions that restrict the data being brought into the dataview. The Criteria tab displays the current criteria, and allows them to be adjusted or deactivated for the current dashboard.

Source Value

Displays the name of the data element. This data may not be included in the dataview itself.

Comparison

Select how the data will be evaluated.

· Equal

The Source Value is equal to the Comparison Value.

· Not equal

The Source Value is not equal to the Comparison Value.

· After

The Source Value is greater than the Comparison Value.

· After or equal

The Source Value is greater than or equal to the Comparison Value.

· Before

The Source Value is less than the Comparison Value.

· Before or equal

The Source Value is less than or equal to the Comparison Value.

· Between

The Source Value falls between the two Comparison Values.

· Not between

The Source Value does not fall between the two Comparison Values.

· Contains

The Source Value includes the full Comparison Value anywhere within the data.

· Does not contain

The Source Value does not include the full Comparison Value anywhere within the data.

· Starts with

The Source Value begins with the full Comparison Value.

· Does not start with

The Source Value does not begin with the full Comparison Value.

· Is empty

The Source Value is blank. No Comparison Value is required for this option.

· Is not empty

The Source Value contains any value at all. No Comparison Value is required for this option.

· Ends with

The Source Value ends with the full Comparison Value.

· Does not end with

The Source Value does not end with the full Comparison Value.

· In list

The Source Value matches at least one entry in the Comparison Values.

· Not in list

The Source Value does not match any entry in the Comparison Values.

Comparison Data Type

Depending on the selected Comparison, select what type of data will be used for the comparison. Additional fields may be added below for entry or selection of values.

· Not used


· Input Value

Uses static values entered in this configuration.

· Query String


· Dashboard Parameter

Uses parameter fields configured for the current dashboard. This allows users to enter the comparison values.

· System Value

Uses system data about the user or application.

Comparison Values

Depending on the selected Comparison and Comparison Data Type, additional information may be required. Fields will be added for the entry or selection of the comparison values.

For a list of values, click the Add new list item icon to add additional fields, or click the Delete icon to remove a field.

The Ranking tab allows one column in the dataview to be set for ranking.

Ranking Column

Select the column to be used for ranking.

Limit To

The ranking can limit the number of results displayed in the dataview. Select if the Top values or Bottom values should be displayed, enter the value, and select if it should be based on the value of the Rows or the Percentage.

Group Others

If there are more rows than will be included in the ranking display, they can be grouped. When Group Others is enabled, an extra row will be displayed to represent all remaining rows. If the option is disabled, the extra rows will not be displayed.

The Name field is required when Group Others is enabled. In addition, Aggregate settings will be necessary to display any values for the group.

Name

When Group Others is enabled, a name must be provided for the group row.

The Links tab allows columns or entire rows to affect other dataviews, navigate to other dashboards, or open external websites.

Click the title to view an existing link configuration, or click the Add new link icon to create a new link. Click to delete the link. See the Managing Link Configurations section for details.

The Chart Options category provides settings for Chart display types. The settings are grouped into tabs, detailed below.

The General tab includes the following options.

Category Column

Select the column that will serve as the category axis or segments.

Show Category Axis

This field is available for line, bar, column, and area charts. When enabled, the category axis is segmented and labeled with the values from the Category Column.

Title

This field is available for line, bar, column, and area charts when Show Category Axis is enabled. A label can be added for the category axis.

Show Legend

When enabled, a legend is displayed in the chart, aligned according to the Legend Alignment setting. For pie and donut charts, the legend will display the values from the Category Column. For line, bar, column, area, and radar charts, the legend will display the names of the numerical data elements being charted.

Legend Alignment

When Show Legend is enabled, select where the legend will be displayed around the chart.

Show Data Labels

When enabled, each data point or segment will be labeled with a custom value configured in the Define Data Label field.

Define Data Label

When Show Data Labels is enabled, the label can be assembled from data elements in the chart. Selecting one of the elements below will add it to the label. Entries in the label can be deleted, but the entire element must be deleted.

If no label is defined, it will default to just the value.

· Value

Displays the value of the data point or segment.

· Category

Displays the value of the Category Column.

· Name

Displays the name of the numerical data element.

· Stack Value


· Percentage


Show Tooltips

When enabled, hovering the mouse over a data point or segment will display a tooltip with custom content configured in the Define Tooltip field.

Define Tooltip

When Show Tooltips is enabled, the tooltip content can be assembled from data elements in the chart. Selecting one of the elements below will add it to the label. Entries in the content can be deleted, but the entire element must be deleted.

If no content is defined, it will default to just the value.

· Value

Displays the value of the data point or segment.

· Category

Displays the value of the Category Column.

· Name

Displays the name of the numerical data element.

· Stack Value


· Percentage


The Series tab provides control over the how numerical data elements can be combined and displayed.

Stacked Series

This option enables the stacking of data elements. If disabled, all data elements will be charted separately.

All columns of the same Type will be stacked in the order they appear in the list. This means that the first column’s data points will appear in the chart at the exact position for their values, and the values from the other associated columns will be cumulative. Note that any data labels or tooltips that include the values will display the original values, and not the cumulative values.

Column Selection

Displays the current column configurations.

Click and drag the Move icon to change the order of the columns. Click to delete the column.

To add a column to the list, select the Series Column and Series Type, then click Add Series.

Series Column

Select the column to be added.

Series Type

Select the chart type for the new column.

· Default

The column will be displayed as the data type selected as the Display Mode in the General category. Note that while this appears as a different type, it will still stack (if enabled) with other columns of the same type as the Display Mode.

· Line

The column will be displayed as a line chart. This type can be combined with Bar, Column, and Area types.

· Bar

The column will be displayed as a horizontal bar chart. If combined with Line, Column, or Area types, this will instead be rendered as a Column chart, and will be stacked (if enabled) with other columns of type Bar and Column.

· Column

The column will be rendered as a vertical column chart. This type can be combined with Line, Bar, and Area types.

· Area

The column will be rendered as a shaded area chart. This type can be combined with Line, Bar, and Column types.

· Pie

The column will be rendered as a pie chart. This type is not compatible with other chart types.

· Radar

The column will be rendered as a radar chart. This type is not compatible with other chart types.

Compatible types of chart can be combined, with each type forming a new stack (if enabled). The same columns can be added multiple times in order to overlap effects.

The Value Axis tab provides settings for the value axis in certain chart types.

Show Value Axis

The value axis can be enabled or disabled. The value axis is not required for chart types such as Pie Charts and Donut Charts, and will have no effect if enabled For other chart types, disabling the value axis will only mark values that intersect the Category Axis.

Title

A title can be provided for the value axis.

Minimum and Maximum

These settings define the value range of the chart. Setting either option to Auto will cause the value axis to automatically scale to a bit less than the minimum charted value or to a bit more than the maximum charted value, respectively. Providing specific values for either setting will lock the axis to that limit, cutting off any values that go beyond that limit.

Show Axis Labels

If enabled, the value axis will display values at the major gridline points.

Show Major Gridlines

If enabled, gridlines will be displayed at the major gridline points.

Show Minor Gridlines

If enabled, gridlines will be displayed at the minor gridline points.

Show Major Ticks

If enabled, the value axis will display tick marks at the major gridline points.

Show Minor Ticks

If enabled, the value axis will display tick marks at the minor gridline points.

The Table Options category provides settings for Table display types.

Display Headers

If enabled, a header row will display the Title for each column, as defined in the Columns category.

Allow Inline Filtering

If enabled, a filter icon will be available to apply custom filters for each column.

Page Size

Limits the table to a specific number of rows, paging the results when necessary. A value of zero disables paging, causing all values to be displayed. For tables that are expected to have a large number of rows, enabling paging can improve both the usability and performance.

Row Height

Defines the minimum height of the table rows.

The KPI Options category provides settings for KPI report display types.

Value Column

Select a column to provide the primary value that will be displayed.

Color Column


Trend Value Column

A column can be selected to provide the trend data. If no column is selected here, the Value Column number will be displayed in the center of the cell. If a column is selected, the Value Column number will be displayed to the left of the cell, with a chart containing the trend data displayed to the right of the value.

Trend Display Mode

If a Trend Value Column has been defined, select how the chart will be displayed.

The Table Options category provides settings for Table display types.

Number of Columns

Enter the number of columns to be displayed.

Alignment

An alignment can be applied for all fields. If no alignment is selected, the default alignments configured in the DataView will be applied for each field. This alignment does not apply to the labels column, which is always right-aligned.

Flow

When Number of Columns is set to more than 1, select how the fields will be organized across the columns.

· Vertical

Fields will be arranged vertically, divided among the columns.

1 3

2 4

· Horizontal

Fields will be arranged horizontally, one row at a time.

1 2

3 4

The Gauge Options category provides settings for Gauge display types, grouped into tabs.

The Pointers tab provides settings for the pointers in the gauge.

Pointer Column

Select the column that contains the pointer values.

Number of Pointers

The gauge can display up to ten pointers, one for each value in the column. The pointers will alternate in color. If the column contains more values than the available pointers, the first values will be displayed.

Pointer Style

Select the size of the pointer. For radial gauges, this controls the size of the circle at the center of the gauge.

Orientation

This field is available for the LinearGauge style. Select if the scale should be vertical or horizontal.

Is Percent?

Converts decimal percentage values to whole numbers.

The Ranges tab applies color coding to value ranges within the gauge.

Range List

Displays the currently configured ranges.

Click to delete the column.

To add a range, enter the From and To values, select a Range Color, then click Add Range.

To edit a range, select it from the list, modify the values, then click Update Range.

From

Enter the lower value of the range. Note that ranges cannot overlap.

To

Enter the higher value of the range. Note that ranges cannot overlap.

Range Color

Select the color for the range.

The Scale tab provides settings for the numeric scale.

Scale Minimum and Scale Maximum

Enter the minimum and maximum values of the scale. If either value is left at zero, the minimum or maximum values from the data will be used.

Major Unit

The major ticks, and possibly labels, will be placed at every multiple of the provided value. If the value is zero, the system will assign an appropriate value according to the scale.

Minor Unit

The minor ticks between the major ticks will be placed at every multiple of the provided value. If the value is zero, the system will assign an appropriate value according to the scale.

Show Labels

If enabled, labels will be displayed at every major tick.

Define Label

When Show Labels is enabled, the label can be assembled from the value and custom text. Selecting Value from the drop-down will add it to the label, and additional text can be added before or after.

Position

Select if the ticks and labels should be displayed inside the range area or outside.

Start Angle and End Angle

These fields are available for radial gauges. These values define the total range occupied by the gauge.


The Treemap Options category provides settings for Treemap display types.

The following options are available.

Value Column

Select the numerical column that contains the values for the bars or squares.

Label Column

Select the column to provide the labels for the bars or squares.

Tree Map Type

Select the type of tree map.

· Square

A series of tiles, arranged from the top-left (largest) to bottom-right (smallest).

· Vertical

A series of bars, arranged from top (largest) to bottom (smallest).

· Horizontal

A series of bars, arranged from left (largest) to right (smallest).


Static Contents Configuration Panels (Dashboard Configuration Mode)

The Configuration panel opens to the right of the screen when clicking the configuration icon for any Static Contents cell, and contains settings for the current cell. Click X to close the panel again.

These settings become the default configuration for the cell, although many of these options can be overridden by each user in analysis mode.

The options are displayed by category. Each category can be expanded or collapsed using the and icons.

The General category includes the following options.

Title

Enter the title of the tab to be displayed at the top of the cell.

Display Mode

Displays the format of the tab. For column cell style cells, this is preset to HTML.

Visible

If enabled, the tab will be visible at all times. If disabled, the tab will be hidden when the dashboard loads. If another tab is linked to the current tab, activating that link will reveal and refresh the current tab.

Trace Info


Click Revert default configuration to reset the tab to its original configuration. This deletes any custom configuration saved for the tab.

The Appearance category includes the following options.

Display Window Title Bar

If enabled, the title bar will be displayed at the top of the cell. If disabled, the titles of all tabs within the cell will be hidden, as well as the Control icon.

Note that hiding the title bar will prevent access to this settings page in analysis mode. Also, if the title bar is hidden for a tab in the tray area, the tab will still expand but the collapse icon will not be available to collapse the tab again.

Display Toolbar

If enabled, the Control icon will be displayed to the left of the tab name, providing access to the configuration options for that tab. If disabled, the Control icon will not be displayed.

Note that hiding the control icon will prevent access to this settings page in analysis

bridge user guide - smartview · web view2019. 7. 21. · with a single cell selected, this...

Documents