Essentials Bundle Documentation

Support

Welcome to Essentials Bundle Documentation. If you prefer a single document you can simply print this page to retrieve this document in its entirety. For more resources, visit our searchable learning center.

Table of Contents

Install


Filtered Summary


Background Builder


Dynamic Sort


Input Manager


Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Install Instructions

Back Support

Computer Configuration (Pre-Install)

Are you trying to install a trial version? CLICK HERE

1. System Configuration- Ensure that you have disabled UAC (Vista Only).
Disable UAC Instructions

2. Computer User Security Rights- To install and use add-on components, you will be required to have administrative rights on your computer to install software. To review if your profile has these rights, right click on the Xcelsius program and "Run as Administrator." If you are prompted for a login you will need to contact your IT department to obtain the necessary access rights to your PC.

Run the Add-On Install Wizard for Registration

1. Open the install EXE
2. Accept the terms of use and click Next
3. Enter your license key
Where to obtain your license key 

 
4. Select a folder on your computer where you will extract and access the XLX add-on package, documentation, and templates after completely the install wizard.

IMPOTANT NOTE: The component installer will NOT install directly into SAP BusinessObjects or Xcelsius. Instead it will unzip the XLX file and component resources (documentation, templates links)
5. Click Install
The install wizard will place the .XLX files, documentation, and templates into the directory defined in step 4.
6. Click Finish

Install the XLX Add On

1. Open SAP BusinessObjects Dashboards, Xcelsius, or SAP Crystal Dashboard Design
2. Go to File>Add-On Manager
3. Install Add-On
4. Navigate to the directory chosen during the install wizard process
5. Select the XLX file.
6. Click "Close"
7. "Save and Close"
8. Save your dashboard
9. Re-open SAP BusinessObjects Dashboards, Xcelsius or SAP Crystal Dashboard Design
10. Your component is now ready to use

The following video illustrates how to quickly install your new plugin component inside of Xcelsius, SAP BusinessObejcts Dashboards, or SAP Crystal Dashboard Design.


Don't see the video? Click here to view the MP4

More Resources

View Jumpstart Videos- Visit our learning center to watch jumpstart videos and best practices documents. Visit the Learning Center

Use Templates- Use the free templates included with your Centigon Solutions product or trial download. Learn by example using pre-built templates from Centigon Solutions. 
Get Additional Free Templates

Contact us if you have any questions or issues and our sales and support team is more than happy to assist you. »Contact Us

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

Title- Enter or bind text that is displayed at the top of the background component. The title size, alignment, and style can be modified in the Appearance tab.

Image- Select one of 20 professionally designed background image overlays to enhance the dashboard aesthetics. The images consist of stylized gradients that add depth to the Background Builder’s color.

Texture- Add additional depth with opaque textures. Textures are tiled across the background as it is re sized on the canvas. Background Color- Click on the color chooser icon to select a color from a standard web palette. This color chooser does not inherit the color options from Xcelsius. Custom colors must be added in a hexadecimal color code for custom colors.

Transparency- The background transparency will affect the entire Background Builder component and all selected Textures and Images.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Appearance Tab

Back Support

Show Title- Enabling the check box will display the Title property.

Title Properties- Change the Title properties including font, text size, color, style and alignment.

Letter Spacing- Modify the spacing between letters within the Title text.

Corner Radius- Modify the corner radius resulting in rounded or squared edges. Reducing the corner radius to 0, results in squared corners.

Shadow- The drop shadow will create depth to a background component. A drop shadow is typically grey scale but can be changed to another color. To remove the drop shadow, move the distance slider to the left.

Bevel- The inner bevel provides a subtle depth to a Background Builder component, specifically when layering backgrounds on top of each other.

Show Header- The header toggle provides an opaque header graphic, located at the top of the Background Builder component. This header is typically used to create contrast or encloser for a title or important information.

Show Header Highlight- The header highlight is a subtle graphical highlight located at the top of the background builder that can be turned off by de-selecting the check box.

Header Height- Expand or reduce the size for an enabled Header by dragging the slider.

Show Footer- The header highlight is a subtle graphical highlight located at the bottom of the background builder that can be turned off by de-selecting the check box.

Footer Height- Expand or reduce the size for an enabled Footer by dragging the slider.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

Source Data- Data Range to be filtered and/or summarized. Upon binding the Source Data, the Columns list box is populated with a list of each column.

BI4 Direct Binding to Query Browser- Available with Essentials Bundle v3 and SAP BusinessObjects Dashboards v6.0.3 and later, a direct binding button allows for measures and dimensions from a query to be re-used as the source for Filtered Summary. Upon configuring the binding options, the columns will appear inside of Filtered Summary.

Source Data

Destination Range- Data range where the filtered and/or summarized data is inserted. The destination should contain the same number of columns as the source data. Upon binding data to the Source Data property, a list of columns will be populated within the Columns list box.

Enable Summary Calculations- Toggle for turning the summarization feature on or off. Summary calculations drive dynamic aggregation of Source Data before it is inserted into the Destination Range. Checking Summary Calculations will enable the Aggregate Column Index and Calculation Type properties. Toggling the Summary Calculations off will allow a developer to utilize Filtered Summary for its dynamic filtering capabilities only.Aggregate Column Index

Aggregate Column Index- Entered as a single numeric value, the Aggregate Column property identifies the column for which the Source Data is aggregated by. The default Aggregate Column Index is 1, meaning the data is summarized by the first column. Leaving the property blank will enable the default column (1). A bound Aggregate Column index will re-execute the summarization calculation each time the index number is changed.

Multi-Column Aggregation with Column Index- to aggregate data with multiple columns Filtered Summary accepts a comma separated value representing the columns that will be aggregated.

Example: "1,3" as the Column Index will merge using columns 1 & 3 together.

Column Filters and Calculations

Columns

A list of columns is automatically by the Source Data property, and generates a list of bound columns. Each column within filtered summary is controlled individually. Detailed control over each individual column within the Filtered Summary to ensure a scalable and maintainable solution for filtering, searching, and aggregating data dynamically during runtime. The following column properties are set for each column. Column Name- Identify each column with a name to provide context for the dashboard developer. The column names are specifically designed for the Xcelsius developer and do not affect runtime functionality.

Default: The default column names are the word “Column” + column number.

Column Filter- Filter data from the source data range using Column Filter values. Each column is capable of containing one or multiple filters, resulting in tremendous control over what data is displayed in the Destination range. Multiple filters can be assigned to a Column Filter property using a comma separated list. Example: “west, east, north”

Default- Column Filter is an optional property with a default of ALL (*). A blank value or wildcard symbol “*”
within the Column Filter cell will result in ALL records being displayed.

Filter Types

Filter Type- Define how the data will be filtered using the Filter Type. Only one filter type can be applied per column.

Using Wildcards: By default, you can enter the value "*" as a wildcard which will return all values for that column. You can also change the definition of this wildcard character in the Behavior Tab.

Equals- Filter data as an exact match to the Column Filter Values.

Contains- Filter data as when the data contains the Column Filter values

\Not Equal- Filter data as that is NOT am exact match to the Column Filter Values.

Greater Than- Filter Data where the numeric values are greater than the Column Filter Values

Less Than- Filter Data where the numeric values are less than the Column Filter Values

Between- Filter Data where the numeric values are less than the Column Filter Values

Example "1,5" as a Column Filter Value where Between is the filter type will only display records where the values are between 1 and 5. You must always place the lower limit first and upper limit second.

Calculation Types

Calculation Type- Select one of 4 calculation types to filtered data to enable dynamic summarization of data before it is inserted into the destination range. The Calculation Type is activated when the Enable Summary
Calculations property is checked. The data aggregation is driven by the Aggregate Column Index property. Each column is controlled independently as the data is aggregated as a List, Count, Sum, or Average. List- List will filter the column and place the list of unique values into the destination as a comma separated string.

Count- Count will provide a numerical count of the number of records.

Sum- Calculate the sum of all values for each record within the column

Average- Calculate average of all values for each record within the column.

List Destination- Destination range where distinct values within the Source Data column are inserted. Each column can contain a unique List Destination thus creating a effective method for capturing unique values within each column of source data.

Filtered Summary

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Behavior Tab

Back Support

Include Total- Include a total calculation displayed at as the first or last row within the Destination Range. The total calculation will only calculate and sum each destination column containing numeric values. The left-most column will display Total Title. All other dimensional values are displayed as N/A.

By default the Total property is disabled.

Total Title- Displayed in the left-most column of the Filtered Summary destination range, the Total Title label can be customized to any value.

Total Location- Move the total value to the top or bottom of the destination range based on your dashboard requirements.

Total

Wildcard Character-

The wildcard character is used for filtering data and can be applied as any Column Filter. To change the Wildcard to a more meaningful value like "All" or another value that is aligned to the business users, simply bind the wildcard character property to a cell containing text. Filtered Summary will use this new value as the wildcard.

The default wildcard character is "*"

Wildcard

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Preview Tab

Back Support

Preview Data- Intended to simplify the dashboard development process the preview window will display the resulting Filtered Summary data as it would appear in the Destination Range during runtime. Intended for design and debugging, dashboard developers can easily refine properties and test the Filtered Summary calculations to ensure the data output is correct.

Copy to Clipboard- Clicking on the copy to clipboard icon will copy the Destination Range as tab delimited values which can be pasted back into the Xcelsius dashboard. This capability streamlines Xcelsius developer’s ability to mock-up charts and tables using a true representation of the filtered/summarized data.

copy to clipboard

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved


Using Filtered Summary

Back Support

01. Bind the Source Data to a range that will be summarized, then inserted into a destination. Upon binding the Source Data, the Columns list box will populate with a list of columns, which can be configured individually.

02. Bind the Destination Range, where the filtered summary data is inserted. The destination range should have the same number of columns as the Source Data.

Step3

03. With Enable Summary Calculations checked, Bind the aggregate column index to a single cell. The column index is a numeric position starting at the left most column within the source data dictates how the remaining columns are filtered. The data is aggregated using the values present in the in the column.

04. Insert Column names to identify each column to improve development and maintenance.

05. Bind the Column Filter to a cell containing a single or comma separated value. Leaving any column filter un-bound will result in an ALL selection.

07. Select the Filter type from Equals or Containing to control how the data within each column is filtered.

08. Select the calculation type to control the column calculation. (Comma separated list, count, sum, or average).

step8

09. Bind the List Destination to capture all unique values within the column. The list destination can be re-used by other Xcelsius components as labels.

Behavior Tab

10. Check Include Total to insert the Total calculation within the Destination Range

11. Toggle the Total Location from Top to Bottom

step11

Preview Tab

12. Click on the Preview Data button to view the Filtered Summary output that will be generated during SWF runtime. If changes to the General tab properties are made, re-clicking Preview Data will generate new results.

13. Click on the Copy to Clipboard icon. The output data can be pasted back into the Xcelsius/Excel spreadsheet where the Filtered Summary Destination Range is bound.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Using Filtered Summary

Back Support

01. Bind the Source Data to a range that will be summarized, then inserted into a destination. Upon binding the Source Data, the Columns list box will populate with a list of columns, which can be configured individually.

02. Bind the Destination Range, where the filtered summary data is inserted. The destination range should have the same number of columns as the Source Data.

Step3

03. With Enable Summary Calculations checked, Bind the aggregate column index to a single cell. The column index is a numeric position starting at the left most column within the source data dictates how the remaining columns are filtered. The data is aggregated using the values present in the in the column.

04. Insert Column names to identify each column to improve development and maintenance.

05. Bind the Column Filter to a cell containing a single or comma separated value. Leaving any column filter unbound will result in an ALL selection.

07. Select the Filter type from Equals or Containing to control how the data within each column is filtered.

08. Select the calculation type to control the column calculation. (Comma separated list, count, sum, or average).

step8

09. Bind the List Destination to capture all unique values within the column. The list destination can be re-used by other Xcelsius components as labels.

Behavior Tab

10. Check Include Total to insert the Total calculation within the Destination Range

11. Toggle the Total Location from Top to Bottom

step11

Preview Tab

12. Click on the Preview Data button to view the Filtered Summary output that will be generated during SWF runtime. If changes to the General tab properties are made, re-clicking Preview Data will generate new results.

13. Click on the Copy to Clipboard icon. The output data can be pasted back into the Xcelsius/Excel spreadsheet where the Filtered Summary Destination Range is bound.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

Source Value- Bind a single cell as the source data for Input Manager. The Source Value cell is typically controlled through another Xcelsius single value or text input component. Note: Do not place Excel logic into the Source Value cell.

Destination Range- A single column, row, or range of data where Source Values are distributed based on the Row and
Column Index values..

Row Index- A single value that controls the row where the Source Value is inserted within the Destination Range.

Column Index- A single value that controls the column where the Source Value is inserted within the Destination Range.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Behavior Tab

Back Support

Trigger Insert to Destination Range-

Provides precise control to when the Source Value is inserted into the Destination Range.

Input Manager

Source Data or Row/Column Index changes- Triggers Input Manager to insert the Source Value into the Destination Range when the Source Value or Row/Column Indexes change.

Source Value changes-Triggers Input Manager to insert the Source Value into the Destination Range only when the Source Value changes.

Destination Range changes- Triggers Input Manager to insert the Source Value into the Destination Range only when value(s) within the Destination Range change.

Trigger Source Value Lookup:

Triggers the Input Manager lookup capability where a Destination Range value is inserted into the Source Value cell.


Destination Index Changes- Triggers the Source Value to Lookup a Value from the Destination when the Row or Column Index values change.

Source Value Changes- Triggers the Source Value to Lookup a Value from the Destination when the Row or Column Index values change.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Configuring Input Manager

Back Support

01. Bind the Source Value property to a single cell. This cell can be controlled by a single value component, input text, or formula.

02. Bind the Destination Range to a single column. The Source Value will be distributed into the Destination Range based on the Row Index value.

03. Bind the Row Index to a single cell to control the position within the Destination Range, where the Source Data is inserted.

Behavior Tab

04. In the Behavior tab, select the Update Destination Range property based on the dashboard design requirements. This property dictates when a Source Value will be inserted into the Destination Range:

1.Trigger when the Source Value changes (Figure 1)


2. Trigger when the Row Index changes (Figure 2).

An additional Source Value Lookup property, will lookup the current Destination Range value as the Row Index changes (Figure 3). This option is powerful for calculators where the Source Value needs to be modified multiple times, or when the default Destination Range values are different from the Source Value.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

Source Data- Source data that is sorted based as a vertical
table, based on Dynamic Sort properties.

BI4 Direct Binding to Query Browser- Available with Essentials Bundle v3 and SAP BusinessObjects Dashboards v6.0.3 and later, a direct binding button allows for measures and dimensions from a query to be re-used as the source for Dynamic Sort.

Source Data


Sort Option- Choose between sorting the Source Data in place or inserting the sorted data into a Destination Range.

Note: Source Data containing formulas should always be sorted to a destination rather than sorting the source data

Destination- The destination range where sorted data is inserted. Destination range is only enabled when the Sort
Option is set to “Sort to Destination Range.”

Sort by Column(s)- Sort one or multiple columns of data using numeric values to identify column indexes. When a Sort by Column changes, the data source will re-sort based on the
column number(s).

A Sort by Column with the value of “1” represents the left most column of the Source Data. Multiple sort columns are defined by binding one or multiple cells containing numeric values. The order for which values are defined in the sort column range dictates the sort order.

Example: In the example below, the Sort Column property is bound to a range containing the values 1 and 3. This indicates that dynamic sort will first sort by column 1 and then column 2.

IMPORTANT NOTE: When binding multiple cells to the Sort Column property, using the sort icon for toggling ascending and descending order will only affect the first defined sort column.

Column Sort Type(s)- Toggle between ascending and descending order for each Sort Column value. The following should be defined within the Column Sort Types property:

Ascending = “0” or “ascending”
Descending = “1” or “descending”

Changing the Sort type during runtime will re-sort the entire data range.

NOTE: The default value for an undefined Column Sort Type is ascending.

Example: In the example below, the Sort Columns are 1 and 3. The 2 value range identifies column 1 as ascending and column 3 as descending. The Dynamic Sort component will sort the data according to these definitions and output the sorted data correctly

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Behavior Tab

Back Support

Ignore End Blanks in Data- Ignore end blanks will exclude blank cells at the end of the source data range from being included as part of the sort. Without Ignore End Blanks enabled, blank cells are populated at the beginning or end of
the source data range depending on the sort order.

Re-sort when Data Source Changes- Trigger the sort component anytime source data or column index changes. This trigger behavior provides granular control when data is
re-sorted.

Dynamic Visibility- Dynamic Visibility will enable Dynamic Visibility to show or hide with the dashboard.

Status- Status lets you select a cell in the embedded spreadsheet to control the visibility of the component. If the value in the Status cell equals the value of the Key, the component will be displayed.

NOTE: Do not link Status to a cell or range of cells that are already linked within the same component (for example, Data ranges). The overlap will cause those data sources in the component to not refresh if changed dynamically.

Key-Key lets you specify the value that the Status must match for the component to become visible. Enter the value in the box or use the cell selector to bind the value to a cell in the embedded spreadsheet.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Appearance Tab

Back Support

Show Sort Button- Hide the sort component in scenarios where dashboard users do not toggle between ascending and descending order by de-selecting this option.

Icon Color- Modify the icon color using a color picker or bind, the color using a hexadecimal color definition.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved