EspressDashboard User's Guide
Q. Quick Start
Q.1. Overview
Q.1.1. Setup
Q.2. Getting Started
Q.2.1. Create a User
Q.2.2. Start the Organizer
Q.2.2.1. Login as User
Q.2.2.2. Add a Project
Q.2.2.3. Inserting a File
Q.3. Setup Data Sources
Q.3.1. Create a Data Registry
Q.3.1.1. Setup Database Connections
Q.3.1.1.1. Setup a JDBC Connection
Q.3.1.2. Create a Query
Q.3.1.2.1. Add Query Parameters
Q.3.1.3. Create a Data View
Q.3.1.3.1. Query a Data View
Q.3.1.4. Setup a Text Data Source
Q.4. Charting
Q.4.1. Chart Mapping
Q.4.1.1. Column Chart
Q.4.1.1.1. Add a Data Series
Q.4.1.1.2. 3D Column Chart
Q.4.1.2. Pie Chart
Q.4.1.3. Stack Column Chart
Q.4.2. Basic Chart Formatting
Q.4.2.1. Axis Options
Q.4.2.2. Modify Color and Font
Q.4.2.3. Add Titles
Q.4.2.4. Customize Plot Area
Q.4.3. Advanced Charting Features
Q.4.3.1. Time-Series Zooming
Q.4.3.2. Control Areas
Q.5. QuickDesigner
Q.5.1. Create a Query
Q.5.2. Create a Report
Q.5.2.1. Format Report Elements
Q.5.2.2. Save the Report
Q.5.3. Create a Chart
Q.5.3.1. Format Chart Elements
Q.5.3.2. Save the Chart
Q.6. Maps
Q.6.1. Google Maps
Q.6.1.1. Creating Coordinates
Q.6.1.2. Creating Google Map
Q.6.1.2.1. Configuring Tooltips
Q.6.1.2.2. Setting Drill-Downs
Q.6.2. SVG Maps
Q.6.2.1. Setting SVG Map Thresholds
Q.6.2.1.1. Adding a Map Title
Q.6.2.2. Setting SVG Map Drill-Downs
Q.7. Publishing
Q.7.1. Dashboards
Q.7.1.1. Create a Dashboard
Q.7.1.2. Save the Dashboard
Q.7.1.3. Export Dashboard to PDF
Q.7.2. URLs
Q.7.3. The Menu Page
Q.8. Alerts
Q.8.1. Alerts in Charts
Q.8.2. Alerts in reports
Q.8.3. Alerts in Maps
Q.8.4. Alerts in Dashboards
Q.8.5. Alert monitoring
1. Administration
1.1. Overview & Architecture
1.1.1. EDAB Components
1.1.2. EDAB Architecture
1.2. New Features List V6.6
1.2.1. New EspressDashboard Features
1.2.2. New Chart Features
1.3. Installation and Configuration
1.3.1. Installing EDAB
1.3.1.1. Re-Install/Update
1.3.2. Configuration
1.3.2.1. The EDAB Database
1.3.2.1.1. Using a Different Database
1.3.2.1.2. Running HSQL in Client-Server Mode
1.3.2.1.3. Upgrading EDAB Database from previous version of EDAB
1.3.2.2. Starting the Server
1.3.2.3. Increasing maximum memory heap size for applets
1.3.3. Backward compatibility patches
1.4. Administration
1.4.1. The Console Interface
1.4.1.1. User List
1.4.1.1.1. Importing Users and Groups
1.4.1.1.2. Using Existing Users/Groups
1.4.1.1.3. Setting User/Group Security Levels
1.4.1.2. Setting Info
1.4.1.3. Server Options
1.4.1.3.1. Secured Parameter
1.4.1.4. LDAP Settings
1.4.1.5. Customization
1.4.2. User Settings
1.A. EDAB Details Log
1.B. Server Commands
2. Organizer
2.1. Using the Organizer
2.1.1. Starting the Organizer
2.1.2. The Organizer Interface
2.1.2.1. The Organizer Menus
2.1.2.1.1. File Menu
2.1.2.1.2. Edit Menu
2.1.2.1.3. Publish Menu
2.1.2.1.4. View Menu
2.1.2.1.5. Monitoring Menu
2.1.2.1.6. Option Menu
2.1.2.2. The Organizer Toolbar
2.1.3. Projects and Folders
2.1.3.1. Creating and Modifying Projects and Folders
2.1.4. Files
2.1.4.1. Adding and Modifying Files
2.1.4.2. Arranging Files
2.1.4.3. Dashboard and Map Packages
2.1.5. URL Mapping
2.1.6. Repairing Broken Links
2.1.7. Update Directory
2.1.8. Searching in Organizer
2.1.9. Limiting Browse Directories
2.2. Security and Security Administration
2.2.1. Security Concepts
2.2.2. Setting User Privileges
2.2.2.1. Changing Ownership
2.2.2.2. Folder/File Permissions
2.2.3. Security Levels
2.2.3.1. Associating Security Levels with Users and Groups
2.3. Working with Data Sources
2.3.1. Managing Data Registries
2.3.1.1. Exporting/Importing Data Registries
2.3.1.2. Data Registry Privileges
2.3.2. The Data Source Manager
2.3.2.1. Using Data Source Manager
2.3.2.2. Data Source Node Locking
2.3.3. Data from a Database
2.3.3.1. JNDI Data Sources
2.3.3.2. Queries
2.3.3.2.1. Using Query Builder
2.3.3.2.1.1. Tables
2.3.3.2.1.2. Joins
2.3.3.2.1.3. Columns
2.3.3.2.1.4. Using Database Functions
2.3.3.2.1.5. Adding Extra SQL
2.3.3.2.1.6. Query Output
2.3.3.2.2. Parameterized Queries
2.3.3.2.2.1. Multi-Value Parameters
2.3.3.2.2.2. Initializing Query Parameters
2.3.3.2.2.3. Cascading Parameters
2.3.3.2.2.4. All Parameters
2.3.3.2.3. Entering SQL Statements
2.3.3.2.3.1. Calling Oracle Stored Procedures
2.3.3.3. Data Views
2.3.3.3.1. Data View Parameters
2.3.3.3.2. Updating Data View Queries
2.3.3.4. Editing Queries
2.3.3.5. Editing Database Connections
2.3.3.6. Troubleshooting Database Connections
2.3.4. Data from XML and XBRL Files
2.3.4.1. XMLQueries
2.3.4.1.1. XML Parameters
2.3.5. Data from Text Files
2.3.5.1. Formatting Requirements for Text Files
2.3.5.2. Data Types and Format for Text Files
2.3.6. Data from Class Files
2.3.6.1. Parameterized Class Files
2.3.7. Data from EJBs
2.3.8. Data from SOAP with WSDL support
2.3.9. Data from Salesforce
2.3.10. Data from Excel files
2.3.11. Using Data for Charts
2.3.11.1. Using Multiple Data Sources
2.3.11.2. Change Data Source
2.3.12. Data Source Updating
3. Designing Reports & Charts
3.1. Introduction to Chart Designer
3.1.1. Working with Charts
3.1.2. Starting Chart Designer
3.1.3. Selecting a Data Source
3.2. Charting Basics
3.2.1. What is a Chart
3.2.2. Basic Data Mapping
3.2.3. Saving and Exporting Charts
3.2.3.1. Saving Chart Definitions
3.2.3.2. Generating Image Files
3.3. Chart Types and Data Mapping
3.3.1. Data Mapping
3.3.1.1. Data Transposition
3.3.2. Column Charts
3.3.2.1. Data Mapping
3.3.3. Bar Charts
3.3.3.1. Data Mapping
3.3.4. XY(Z) Scatter Charts
3.3.4.1. Data Mapping
3.3.5. Line Charts
3.3.5.1. Data Mapping
3.3.6. Stack Column Charts
3.3.6.1. Data Mapping
3.3.7. Stack Bar Charts
3.3.7.1. Data Mapping
3.3.8. Pie Charts
3.3.8.1. Data Mapping
3.3.9. Area Charts
3.3.9.1. Data Mapping
3.3.10. Stack Area Charts
3.3.10.1. Data Mapping
3.3.11. High-Low Charts
3.3.11.1. Data Mapping
3.3.12. HLCO Charts
3.3.12.1. Data Mapping
3.3.13. Percentage Column Charts
3.3.13.1. Data Mapping
3.3.14. Doughnut Charts
3.3.14.1. Data Mapping
3.3.15. Surface Charts
3.3.15.1. Data Mapping
3.3.16. Bubble Charts
3.3.16.1. Data Mapping
3.3.17. Overlay Charts
3.3.17.1. Data Mapping
3.3.18. Box Charts
3.3.18.1. Data Mapping
3.3.19. Radar Charts
3.3.19.1. Data Mapping
3.3.20. Dial Charts
3.3.20.1. Data Mapping
3.3.20.2. Gauges
3.3.21. Gantt Charts
3.3.21.1. Data Mapping
3.3.22. Polar Charts
3.3.22.1. Data Mapping
3.3.23. Changing Data Mapping or Data Source
3.4. The Chart Designer Interface
3.4.1. The Designer Menus
3.4.1.1. File Menu
3.4.1.2. Insert Menu:
3.4.1.3. Format Menu
3.4.1.4. Type Menu
3.4.1.5. Drill-Down Menu
3.4.1.6. Data Menu
3.4.1.7. Layout Menu
3.4.2. The Designer Toolbar
3.4.3. Color, Color set, Pattern, and Font Panels
3.4.3.1. Color Panel
3.4.3.2. Color Set Panel
3.4.3.2.1. Save Colors for Categories feature
3.4.3.3. Pattern Panel
3.4.3.4. Font Panel
3.4.4. The Navigation Panel
3.4.5. The Viewport
3.4.5.1. The Chart Canvas
3.4.5.1.1. Background Images
3.4.5.2. Moving and Sizing Chart Elements
3.4.6. Adding Chart Elements
3.4.6.1. Adding Text
3.4.6.1.1. TextVariables
3.4.6.1.2. Text Replacement
3.4.6.1.3. Automatic Text Re-sizing
3.4.6.1.4. Text Cropping
3.4.6.2. Adding Lines
3.4.6.2.1. Line and Point Formatting
3.4.6.2.2. Floating Lines
3.4.6.2.3. Fixed Horizontal/Vertical Lines
3.4.6.2.4. Trend Lines
3.4.6.2.4.1. Normal Distribution Curve
3.4.6.3. Adding Control Areas
3.4.6.4. Adding Tables
3.4.6.5. Adding Hyperlinks
3.4.6.5.1. Viewing Hyperlinks
3.4.7. Formatting Chart Axes
3.4.7.1. Axis Scale
3.4.7.2. Axis Elements
3.4.7.2.1. Axis Label Formatting
3.4.8. Formatting Plot/Data Elements
3.4.8.1. Data Properties
3.4.8.2. Date/Time Based Zooming
3.4.8.2.1. Adding Zooming
3.4.8.2.2. ZoomingInChartViewer
3.4.8.3. Data Ordering
3.4.8.3.1. Top/Bottom N Charts
3.4.8.4. Histograms
3.4.8.5. Formatting Plot Area
3.4.8.6. Formatting Chart Legend
3.4.8.7. 3D Display Options
3.4.8.8. Data Border
3.4.8.9. Aggregation
3.4.9. Chart-Specific Options
3.4.9.1. Bubble Charts
3.4.9.2. Dial Charts
3.4.9.2.1. Gauge Images
3.4.9.3. Overlay Charts
3.4.9.4. Pie Charts
3.4.9.5. Line Charts:
3.4.9.5.1. Double Value Line Charts
3.4.9.6. HLCO Charts
3.4.9.7. Box Charts
3.4.9.8. Stack Area Charts
3.4.9.9. Gantt Charts
3.4.9.10. Radar Charts
3.4.9.11. Scatter Charts
3.4.9.12. Polar Charts
3.4.9.13. Column Charts with Series
3.4.9.14. Column/Bar Charts without Series
3.4.9.15. Two-Dimensional Line Combination Charts
3.4.9.16. Doughnut Charts
3.5. Chart Drill-Down
3.5.1. Data Drill-Down
3.5.1.1. Adding Data Drill-Down
3.5.2. Dynamic Data Drill-Down
3.5.3. Parameter Drill-Down
3.5.3.1. Adding Parameter Drill-Down
3.6. Saving & Exporting Charts
3.6.1. Saving Charts
3.6.1.1. Working with Templates
3.6.1.2. Saving XML Templates
3.6.2. Exporting Charts
3.6.2.1. PDF Font Mapping
3.6.2.1.1. PDF Font Mapping Import/Export
3.7. Introduction to QuickDesigner
3.7.1. Starting QuickDesigner
3.7.2. Selecting a Data Source
3.7.2.1. Changing Data Source
3.8. QuickDesigner Queries
3.8.1. Selecting Fields
3.8.1.1. Building Columns
3.8.1.2. Querying Encrypted Data
3.8.2. Setting Conditions
3.8.2.1. Previewing Query Results
3.8.2.2. Parameterized Queries
3.8.2.2.1. Initializing Query Parameters
3.8.2.3. Saving Queries
3.8.2.4. Viewing SQL Query
3.8.2.5. Aggregation Alias
3.8.3. Editing Queries
3.9. Data Mapping
3.9.1. Report Mapping Options
3.9.2. Report Styles
3.9.3. Chart Mapping Options
3.9.4. Changing Data Mapping
3.10. The QuickDesigner Interface
3.10.1. The QuickDesigner Toolbar
3.10.1.1. Using the Toolbar
3.10.2. Inserting and Formatting Report Elements
3.10.2.1. Font, Color, and Border Options
3.10.2.2. Data Formatting for Formulas and Column Fields
3.10.2.3. Inserting Elements
3.10.2.3.1. Text Variables
3.10.2.3.2. Inserting/Editing Aggregations
3.10.2.3.3. Inserting/Editing Charts
3.10.2.4. Alerts for Report Elements
3.10.2.5. Sizing Report Elements
3.10.2.5.1. Re-size to Fit Content
3.10.3. Ordering and Sorting
3.10.3.1. Changing Column Order
3.10.3.2. Sorting
3.11. Saving and Exporting Reports
3.11.1. Saving Reports
3.11.2. Exporting Reports
3.11.2.1. Page Setup
3.11.2.2. Page Display
3.12. Charts in QuickDesigner
3.12.1. The QuickDesigner Toolbar
3.12.1.1. Using the Toolbar
3.12.2. Positioning and Sizing Charts
3.12.2.1. Setting Canvas Size
3.12.2.2. Setting Chart Position and Size
3.12.2.3. 3D Chart Options
3.12.3. Font and Color Options
3.12.3.1. Adding/Editing Chart Titles
3.12.3.1.1. Text Variables
3.12.3.2. Setting Chart Fonts
3.12.3.3. Setting Chart Colors
3.12.4. Formatting Chart Axes
3.12.4.1. Setting Axis Scale
3.12.4.2. Setting Axis Elements
3.12.4.2.1. Axis Label Formatting
3.12.5. Formatting Plot/Data Elements
3.12.5.1. Data Properties
3.12.5.2. Line And Point Formatting
3.12.5.3. Data Ordering
3.12.5.4. Formatting Plot Area
3.12.5.5. Formatting Chart Legend
3.12.6. Chart-Specific Options
3.12.6.1. Dial Charts
3.12.6.2. Pie Charts
3.12.6.3. HLCO Charts
3.12.6.4. Gantt Charts
3.12.6.5. Polar Charts
3.13. Saving & Exporting Charts
3.13.1. Saving Charts
3.13.2. Exporting Charts
3.14. QuickDesigner Dataview Query Secured Parameters
4. Designing Maps
4.1. Introduction to EDAB Maps
4.2. Starting Map Builder
4.3. Google Maps
4.3.1. Generating Google Maps API Key
4.3.2. Selecting Data Source
4.3.3. Creating Coordinates
4.3.3.1. From Data Source
4.3.3.2. Geocoding
4.3.3.3. Manually
4.3.4. Operating Coordinates Designer
4.3.5. Coordinates Mapping
4.3.6. Creating Google Maps
4.3.6.1. Google Maps Tooltips
4.3.6.2. Google Maps Drill-Downs
4.3.6.3. Google Maps Titles
4.3.7. Google Maps Data Sources
4.4. SVG Maps
4.4.1. Setting Area IDs Using Inkscape Editor
4.4.2. Area ID Mapping
4.4.3. Creating SVG Map in EDAB Map Builder
4.4.4. Setting Thresholds
4.4.4.1. Setting Legend
4.4.5. Setting Drill-Downs for SVG Maps
4.4.6. Setting Titles for SVG Maps
4.4.7. Setting Tooltips for SVG Maps
4.5. Map Viewer
4.5.1. Writing Map Viewer URL
4.6. Migrating Maps
4.A. List of SVG Map Images
5. Designing Dashboards
5.1. Dashboards
5.1.1. Creating Dashboards
5.1.1.1. The Dashboard Builder Toolbar
5.1.1.2. Adding Charts, Reports and Maps
5.1.1.2.1. Moving and Resizing Charts, Reports and Maps
5.1.1.3. Shared Parameters
5.1.1.3.1. Arranging shared parameters
5.1.1.3.2. Parameter Range
5.1.1.4. Inserting Labels
5.1.1.5. Adding Dashboard Background
5.1.1.6. Additional Dashboard Options
5.1.1.7. Drill-Down
5.1.1.7.1. Drill-Down to Dashboard
5.1.1.8. Folders
5.1.1.9. Template Linkage
5.1.2. Saving Dashboards
5.1.3. Dashboard Preview
5.1.3.1. The Preview Toolbar
5.1.3.2. The Preview Options
5.1.4. Dashboard Migration
5.1.4.1. Migrating from previous EDAB versions
6. Publishing (Menu & URLs)
6.1. The Menu Page
6.1.1. Launching the Menu Page
6.1.2. Using the Menu Page
6.1.2.1. Viewing Dashboards
6.1.3. Mobile MenuPage
6.2. Dashboard URLs
6.2.1. Generating URLs in Organizer
6.2.1.1. Running Dashboard URLs
6.2.2. Writing Dashboard URLs
6.2.2.1. URL Syntax
6.2.2.2. URL Parameters
7. Programming
7.1. Managing Users and Groups
7.1.1. Introduction
7.1.2. Users and Groups
7.1.2.1. Creating Users and Groups
7.1.2.2. Deleting Users and Groups
7.1.3. Single Sign-On
7.1.4. Login Listener
7.1.5. Javadoc
7.1.6. Summary
7.2. EDAB Menu API Overview
7.2.1. Introduction and Setup
7.2.2. Using the API
7.2.2.1. Creating and Customizing an EDAB Menu
7.2.2.1.1. Connecting to EDAB Server
7.2.2.1.2. Getting User Menu Page
7.2.2.1.3. Getting all Visible Nodes
7.2.2.1.4. Getting the Node Details
7.2.2.1.5. Getting the File Details
7.2.2.2. Exporting Reports/Charts using the LookupServlet Servlet
7.2.3. Javadoc
7.2.4. Summary
7.3. Organizer
7.3.1. Introduction
7.3.2. Look and Feel
7.3.3. Inserting and Removing Items
7.3.4. Javadoc
7.3.5. Summary
7.4. Menu Page Listener
7.4.1. EDAB Listener Manager
7.4.1.1. Deploying the Listener Manager
7.4.2. Using the Menu Page Listener
7.5. Class File Data Source
7.5.1. Non Parameterized
7.5.2. Parameterized
7.5.3. Custom Selection Choices
8. Configuration
8.1. Using Other Databases
8.1.1. Create Table Scripts
8.1.1.1. Database Specific Notes
8.1.1.1.1. DB2
8.1.1.1.2. MS SQL Server
8.1.1.1.3. MySQL
8.1.1.1.4. Oracle
8.1.2. Specifying the Database Connection
8.1.3. Migrating the EDAB Database
8.2. Integrating Existing Users/Groups
8.2.1. Using a Database
8.2.2. Implementing UserSecurityProvider
8.2.2.1. Deploying UserSecurityProvider
8.3. Using Other Application Servers
8.3.1. Tomcat 4.1/5.x/6.0.x/7.0.x
8.3.2. Resin
8.3.2.1. Resin 3.x/4.x
8.3.2.2. Resin 2.1.12
8.3.3. WebLogic Server
8.3.3.1. WebLogic Server 9.2/10.3
8.3.3.1.1. WebLogic Server 8.1
8.3.3.1.2. WebLogic Server 7.0
8.3.3.1.3. WebLogic Server 7.0 - Quick Deployment
8.3.4. WebSphere
8.3.4.1. WebSphere 7.1
8.3.4.2. WebSphere 5.0/6.1
8.3.4.3. WebSphere on z/OS
8.3.5. JBoss 3.2.3 (with Tomcat 5.0) / JBoss 4.0.5/6.0.0
8.3.6. Oracle Containers for J2EE (OC4J) 10g (9.0.4.0/10.1.3.5)
8.3.7. Oracle Application Server 10g R3 (10.1.3)
8.3.8. GlassFish Server 3.0.1
8.4. Clustering/Load Balancing
8.4.1. Tomcat 5.0
8.4.1.1. Running EDAB in a Tomcat Cluster
8.4.1.2. Set up EDAB clustering using Apache Web Server and Tomcat
8.4.2. JBoss 3.2.5 (with Tomcat 5.0)
8.4.2.1. Running EDAB in a JBoss Cluster
8.4.3. JRun 4 (with Apache Web server)
8.4.3.1. Running EDAB in a JRun Cluster
8.4.4. WebSphere 6.0
9. Internationalization
9.1. Internationalizing EDAB
9.1.1. Specifying Locales
9.1.1.1. Locale-Specific Formatting
9.1.1.2. Setting Time Zones and Locales Using the API
9.1.2. Language and Encoding
9.1.2.1. EDAB Language Translation
9.1.2.1.1. Upgrading Language File
9.1.2.2. Displaying Foreign Characters
9.1.2.3. Entering Foreign Characters
9.1.2.4. XML Encoding
9.1.2.5. Exporting With Foreign Characters
9.1.2.6. Specifying Encoding for Text Data Files
10. Alerts
10.1. What is an Alert
10.2. Specifying alerts
10.2.1. Google Maps
10.2.2. SVG Maps
10.2.3. Charts
10.2.4. Reports
10.3. Alert types
10.3.1. Dashboard alerts
10.3.2. Visual alert display
10.3.3. User interface
10.4. Monitoring
10.4.1. Alert notifications
10.4.2. Failed emails
10.4.3. User interface
10.4.3.1. Create/Edit monitoring dialog
10.4.3.1.1. Email Delivery Options
10.4.3.1.2. FTP Delivery Settings
10.4.3.2. Monitoring list
10.4.4. Monitoring log
10.5. Handling special situations
10.5.1. Change in script/control area/range
10.5.2. Missed monitoring jobs