CSV Connector Documentation

Support

Welcome to CSV Connector 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


CSV File Configuration


CSV Connector Connection


Export Component


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 BusinessObjects 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 per-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

CSV Connectivity Overview

Back Support

CSV Connector V3 offers two elements that can be used together or independent of each other:

CSV Connector Data Connection
CSV Connector is configured as an Xcelsius data connection allowing you to connect directly to CSV (comma separated), tab delimited or semi-colon delimited data. Load CSV data from a web server or local file system without dependencies on web services or server-side scripts. Generate a preview of the data within the property sheet and bind your data with point and click ease. See how CSV Connector works

CSV Export Components
With Flex 4 platform support, CSV Connector now offers a a new data export component, allowing business users to copy data to their clipboard or export data to their desktop with no server software required. CSV Export components are avaialble in the "Other" folder in the components window.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Definition Tab

Back Support

CSV Data URL- CSV URL- Define absolute or relative URL for the CSV file. CSV Connector supports http:// for remote CSV files and file:// for files located on a local or network drive.

Data Destination- Bind the data range where the CSV data will be loaded into during runtime.

Start/End Column Index- Define optional starting and ending index (numeric value) columns that you would like to load into the Xcelsius model. Leaving these properties blank will load all data. A modification to any of these properties can be previewed on the “Data Preview” tab.

Start/End Row Index- Define optional starting and ending index (numeric value) rows that you would like to load into the Xcelsius model. Leaving these properties blank will load all data. A modification to any of these properties can be previewed on the “Data Preview” tab.

Filter Columns- To refine the CSV data loaded into your Xcelsius model, you can utilize CSV Connector filtering
capabilities. The CSV filter will evaluate each column within your data before it is loaded into your Xcelsius dashboard, facilitating a more scalable dashboard solution when large data volume requirements exist.

Define your filter range- CSV Filters should be bound to a cell range (row) with the same number of columns as the
destination range.

Display all rows (wild card)- If you do NOT want to filter a specific column within your range, you can simply enter an asterisk (“*”) which notifies the filter property

filters

Column Calculations- CSV Connector can dynamically aggregate data contained in a CSV file before it is loaded into the dashboard. Column Calculations identifies how each column of data is in the destination range is aggregated. Each column requires a column calculation key listed below.

Define column calculations range- CSV column calculations should be bound to a cell range (row) with the same number of columns as the destination range

Define calculation values
1= List- Comma separated
2= Count- # Rows
3= Sum- Sum of values
4= Average- Average of values

table

Column Calculations Index- Single value index that identifies the column where calculations are applied. CSV Connector will locate all distinct values within the column and then run calculations for all other columns based on column calculation definitions.

Delimiter- CSV Connector can use one of 3 popular delimiters including Comma “,” Semicolon “;” and Tab “ “.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Data Preview Tab

Back Support

Preview Data- Load the entire CSV file into the preview window. Preview data will recognize Start/End Row & Column Index and filter row properties to provide a true representation of the exact data that will be loaded into your Xcelsius dashboard.

Copy to Clipboard- Simplify the dashboard development process by copying the CSV data to your system clipboard. With the data available in your system’s clipboard you can paste it directly into your Excel worksheet within the Xcelsius development environment, thus making it easier to mock-up your data and build visualization.

clipboard

Column/Row Count- View the total number of rows and columns within your CSV file.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Usage Tab

Back Support

Refresh on load- Load CSV data when the SWF file is first loaded and initialized

Refresh on interval- Load CSV data on a interval in seconds or minutes

Refresh trigger cell- Define a trigger cell that serves as a listener for an event within your dashboard.

When value change- When the trigger cell value changes, the CSV connection will refresh.

When value becomes- When the trigger cell equals this value, the CSV connection will refresh

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Export Overview

Back Support

CSV Export Button is available in the "Other" tab within the SAP Dashboards Components window.

export

When dragging the export button onto the desktop, a basic icon is displayed. data export component, allowing business users to copy data to their clipboard or export data to their desktop with no server software required. When

Export Data- Source data that will be exported to a CSV file or to the system clipboard.

Export to File- Export to file will automatically prompt a dashboard end user where they can chose the destination on their hard drive to save a file. The resulting file can be saved as CSV or TXT.

Copy to Clipboard- Copy to clipboard will save the data bound to the Export Data property to the system clipboard where it can be pasted into another program.

Note for copy to clipboard: When exporting data to the clipboard, if Excel is where the data will be pasted, use the Tab delimited format.

Delimiter Type- The delimiter type will modify how data is delimited (separated) which also adjusts the type of output. CSV Export Button offers Comma Delimited or Tab Delimited files.

Comma- A comma delimited format is most commonly used in conjunction with Excel. Using Comma delimiters will insert a "," between each file.

Note for exporting to a file: When exporting data, if you would like to open the file immediately with Excel, use Comma delimiter

Tab- A tab delimited format is commonly used in TXT exports or when pasting into Excel.

Appearance

Show Artwork- Unchecking "Show Artwork" will hide the standard icon but still allow end users to click on the component hotspot to trigger an export.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Export- Deprecated

Back Support

The Export tab in CSV Connector has been deprecated with version 3. When opening an XLF that was built with CSV Connector V2, CSV Connector V3 will automatically display the Export tab. Any new CSV Connections created will NOT include the Export tab.

All export capabilities have been replaced by the new Export Components.

More abou the Export Tab- CSV Connector by itself is NOT capable of physically generating files on your desktop or on a server. This is due to Flash restrictions that actually protect your computers from malware. CSV Connector relies on basic web services to transact data from the Flash runtime to generate output files. In an effort to facilitate rapid innovation and adoption, Centigon Solutions has released these services as open source projects independent from CSV Connector.Regardless of platform, browser, or scripting language CSV Connector can communicate with any export services written in .NET, PHP, and J2EE.
http://code.google.com/p/csv-export-webservice

CSV Export Service URL- The service that will consume exported CSV data and then generate the output file. The export service URL will always start with HTTP(S) and connect to a service located on a web/application server. The

*The CSV Export service is NOT a URL to the CSV file that you save to but rather a service that will create the CSV file(s).

URL is WSDL- For advanced services, CSV Connector can utilize a WSDL to simplify the development process. Reference documentation or contact your service administrator to indicate if the service URL is a WSDL.

Open CSV After Save- Following the successful CSV data export and creation of a file, the connector will open the file in a new browser window automatically.

Source Data- CSV Connector export uses a seperate Source Data property than the “Definition” tab to enable you to export independant of loading data. This property defines the data that you will export.

NUMBER FORMATTING- CSV Connector will NOT inherit cell number formatting.

Export File Name- The name of the CSV File that is generated after exporting data. When defining the file name you will need
to include the .CSV extension.
Example: yourfilename.csv

Export File Path- The path where the CSV file will be saved. The file path is ALWAYS relative to the service URL unless
your developer have customized the export services.

Example: “subdirectory/”
Returned URL- CSV will wait for a response from the export service to return the absolute URL for the CSV file that was
generated.

Open File After Save- Enabling “Open After Save” will trigger CSV Connector will automatically open the exported
file in a browser upon successful export.

Refresh trigger cell- Define a trigger cell that serves as a listener for an event within your dashboard.
When value change- When the trigger cell value changes, the CSV connection will refresh.

When value becomes- When the trigger cell equals this value, the CSV connection will refresh.

Advanced Web Service Options:

The advanced web service options are designed to give developers flexibility and control over the parameter values that are passed to their custom export service during export operations.

File Parameter Name- The File Parameter Name property may be changed if you are using an HTTP Service, to change the name of the File Parameter from its default, which is currently fileName as shown in the URL example below. This will change the value of the parameter name that is appended to the URL, enabling you to use a custom parameter name for this particular parameter in your custom HTTP Service.
i.e. http://...&fileName=exportFileNameValue;

File Path Parameter Name- The File Path Parameter Name property may be changed if you are using an HTTP Service, to change the name of the File Path Parameter from its default, which is currently filePath as shown in the URL example below. This will change the value of the parameter name that is appended to the URL, enabling you to use a custom parameter name for this particular parameter in your custom HTTP Service.
.e. http://...&filePath=exportFilePathValue;

Content Parameter Name- The Content Parameter Name property may be changed if you are using an HTTP Service, to change the name of the Content Parameter from its default, which is currently content as shown in the URL example below. This will change the value of the parameter name that is appended to the URL, enabling you to use a custom parameter name for this particular parameter in your custom HTTP Service.
i.e. http://...& content=exportContent;

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved


Connect to CSV Files on a Web/ Application Server

Back Support

Relative Path example: data/xyz.csv

When connecting your Xcelsius SWF to a CSV file, where the SWF exists on the same server as the CSV, you can utilize a relative URL without any additional configuration. In the example above the “xyz.csv” file is located in a subdirectory called “data.” If the SWF and CSV file were in the same directory, you could use “xyz.csv.”

Relative will NOT work inside of Xcelsius development environment or in Preview mode because preview SWFs are generated in the TEMP directory, which is not relative to the CSV file.

Absolute Path example: http://servername/data/xyz.csv

When connecting your Xcelsius SWF to a CSV file, where the SWF exists on the local PC or on a different server, you can utilize an absolute URL. This configuration requires a cross domain policy file, which grants access for the flash player to load data into the SWF.

The crossdomain.xml file should be loaded into the root directory of the web/ application server where you CSV file exists.
Example IIS root: /intetpub/wwwroot
Example Tomcat root: /webapps/ROOT

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Connect to CSV Files on your Desktop or File Share

Back Support

Relative Path example: data/xyz.csv
When connecting your Xcelsius SWF to a CSV file, where the SWF exists on the same site or local PC directory structure as the CSV, you can utilize a relative URL without any additional configuration. In the example above the “xyz.csv” file is located in a sub-directory called “data.” If the SWF and CSV file were in the same directory, you could use “xyz.csv.”

Absolute Path example: file://c:/data/xyz.csv
When connecting your Xcelsius SWF to a CSV file, where the SWF exists on the local PC but in a different directory, you can use a “file://” prefix to define an absolute path to the file.

*A SWF that is accessed from a web/application server cannot access CSV files on the local file system due to flash
security settings.

*To load CSV data from the local file system using an absolute URL you will first modify your Flash Player Global Security Settings and grant access to the local drive where your CSV data is located. See instructions below for detailed instructions.

FlashSecurity

Configure your PC to load CSV data from your local PC file system:

  1. Open Global Flash Player Security dialogue
  2. Upon opening the Flash Player Security settings, you will add the directory or network location where your CSV file is located. In the example shown below, the flash player can access any directory on the C: drive to load data into a SWF.
  3. Upon making changes, you can close your browser window and re-launch your Xcelsius generated SWF.

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Behavior Tab

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Configuring Input Manager

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

General Tab

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Behavior Tab

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved

Appearance Tab

Back Support

 

Back

Copyright 2012 Centigon Solutions, Inc. All Rights Reserved