1.) ERES Report API
|
| |
1.1.) Introduction and Setup
|
| |
1.2.) Recommended Approach for using Report API
|
| |
1.3.) Interaction with ERES Server
|
| |
1.4.) Connecting to ERES Server
|
| |
1.5.) Using the API
|
| |
|
1.5.1.) Loading a Report
|
| |
|
|
1.5.1.1.) Sub-Reports, Charts and Drill Down Reports
|
| |
|
|
1.5.1.2.) PAK File
|
| |
|
|
1.5.1.3.) Backup Data
|
| |
|
|
1.5.1.4.) Parameterized Reports
|
| |
|
|
|
1.5.1.4.1.) Object Array
|
| |
|
|
|
1.5.1.4.2.) getAllParameters method
|
| |
|
|
1.5.1.5.) Secure Reports
|
| |
|
1.5.2.) Applying a Report Template
|
| |
|
1.5.3.) Modifying Data Source
|
| |
|
|
1.5.3.1.) Data from a Database
|
| |
|
|
|
1.5.3.1.1.) Parameterized
|
| |
|
|
|
1.5.3.1.2.) JNDI
|
| |
|
|
1.5.3.2.) Data from a Data File (TXT/DAT/XML)
|
| |
|
|
1.5.3.3.) Data from an XML Data Source
|
| |
|
|
1.5.3.4.) Data from Custom Implementation
|
| |
|
|
|
1.5.3.4.1.) Parameterized
|
| |
|
|
1.5.3.5.) Data Passed in an Array in Memory
|
| |
|
|
1.5.3.6.) Drill Down with DrillDownReportServlet
|
| |
|
1.5.4.) Modifying Column Mapping
|
| |
|
1.5.5.) Report Components
|
| |
|
|
1.5.5.1.) ReportElement
|
| |
|
|
1.5.5.2.) ReportCell
|
| |
|
|
1.5.5.3.) ReportSection
|
| |
|
|
1.5.5.4.) ReportColumn
|
| |
|
|
1.5.5.5.) ReportTable
|
| |
|
|
1.5.5.6.) ReportImage
|
| |
|
|
1.5.5.7.) ReportChartObject
|
| |
|
|
1.5.5.8.) ChartObject
|
| |
|
|
1.5.5.9.) ReportDocument
|
| |
|
|
1.5.5.10.) ReportRTFObject
|
| |
|
|
1.5.5.11.) SubReportObject
|
| |
|
|
1.5.5.12.) ReportGrid
|
| |
|
|
1.5.5.13.) ReportLine
|
| |
|
1.5.6.) Modifying Report Attributes
|
| |
|
|
1.5.6.1.) Adding New Cells
|
| |
|
|
1.5.6.2.) Adding Images/Charts
|
| |
|
|
1.5.6.3.) Adding Hyperlinks
|
| |
|
|
1.5.6.4.) Adding GridLines and Lines
|
| |
|
|
1.5.6.5.) Adding Rich Text Field Objects
|
| |
|
|
1.5.6.6.) Adding Nested Sections
|
| |
|
|
1.5.6.7.) Modifying Background Color, Font .....
|
| |
|
|
1.5.6.8.) Modifying the Format
|
| |
|
|
1.5.6.9.) Modifying a Column to Show Bar Codes
|
| |
|
|
1.5.6.10.) Modifying a Report to be a Top N Report
|
| |
|
|
1.5.6.11.) Cell Scripts
|
| |
|
1.5.7.) Exporting the Report
|
| |
|
|
1.5.7.1.) Multiple Page Exporting
|
| |
|
|
1.5.7.2.) Memory Optimized Exporting
|
| |
|
|
1.5.7.3.) PDF Exporting Options
|
| |
|
|
1.5.7.4.) Exporting HTML/DHTML Content with Style Sheets
|
| |
|
|
1.5.7.5.) HTML Block Export
|
| |
|
|
1.5.7.6.) Custom Links for Multi-page DHTML/HTML Export
|
| |
|
|
1.5.7.7.) Setting the Pixels Per Inch Ratio for DHTML/HTML Export
|
| |
|
|
1.5.7.8.) Pre-load Charts
|
| |
|
|
1.5.7.9.) IExportThreadListener for .view files
|
| |
|
|
1.5.7.10.) Record File Exporting
|
| |
|
|
1.5.7.11.) Streaming Reports
|
| |
|
|
|
1.5.7.11.1.) RPTImageGenerator
|
| |
|
|
|
1.5.7.11.2.) DrillDownReportServlet
|
| |
|
|
|
1.5.7.11.3.) Generating HTML Parameter Page
|
| |
|
|
|
1.5.7.11.4.) Utilizing Cascading Style Sheets (CSS)
|
| |
|
|
|
1.5.7.11.5.) Customize the Parameter Page
|
| |
|
1.5.8.) Calling Report Designer from Report API
|
| |
|
|
1.5.8.1.) Specify a Report Template
|
| |
|
|
1.5.8.2.) Specify a Data Registry
|
| |
|
|
1.5.8.3.) Specify a DBInfo Object (Database Information)
|
| |
|
|
1.5.8.4.) Open Query Builder with a Specified DBInfo Object (Database Information)
|
| |
|
|
1.5.8.5.) Open Report Designer with a Specific Class File Data Source
|
| |
|
|
1.5.8.6.) Open Report Designer with Custom Functions
|
| |
|
|
1.5.8.7.) Open Report Designer with Pre-set Directories
|
| |
|
|
1.5.8.8.) Open Report Designer with Modified Menubar and Toolbar
|
| |
|
|
1.5.8.9.) Open Report Designer with Skipped Wizard Steps
|
| |
|
|
1.5.8.10.) Open Report Designer with Customized Messages and Chart Designer
|
| |
|
1.5.9.) Changing Report/PageViewer Options
|
| |
1.6.) Javadoc
|
| |
1.7.) Swing Version
|
| |
1.8.) Summary
|
2.) ERES Chart API
|
| |
2.1.) Introduction and Setup
|
| |
2.2.) Recommended Approach for using Chart API
|
| |
2.3.) Interaction with ERES Server
|
| |
2.4.) Connecting to ERES Server
|
| |
2.5.) Using the API
|
| |
|
2.5.1.) Loading a Chart
|
| |
|
|
2.5.1.1.) Parameterized Charts
|
| |
|
|
|
2.5.1.1.1.) Object Array
|
| |
|
2.5.2.) Applying a Chart Template
|
| |
|
2.5.3.) Modifying Data Source
|
| |
|
|
2.5.3.1.) Data from a Database
|
| |
|
|
|
2.5.3.1.1.) JNDI
|
| |
|
|
2.5.3.2.) Data from a Data File (TXT/DAT/XML)
|
| |
|
|
2.5.3.3.) Data from an XML Data Source
|
| |
|
|
2.5.3.4.) Data from Custom Implementation
|
| |
|
|
2.5.3.5.) Data passed in an Array in Memory
|
| |
|
2.5.4.) Modifying Chart Attributes
|
| |
|
|
2.5.4.1.) Modifying Color, Font, ...
|
| |
|
|
2.5.4.2.) Setting Predefined Patterns
|
| |
|
|
2.5.4.3.) Setting Customized Patterns
|
| |
|
|
2.5.4.4.) Modifying Size
|
| |
|
|
2.5.4.5.) Modifying Date/Time Zoom Charts
|
| |
|
|
2.5.4.6.) Modifying Chart in Report
|
| |
|
2.5.5.) Exporting the Chart
|
| |
|
|
2.5.5.1.) Record File Exporting
|
| |
|
|
2.5.5.2.) Streaming Charts
|
| |
|
2.5.6.) Changing Chart Viewer Options
|
| |
2.6.) API Only Features
|
| |
|
2.6.1.) Visual
|
| |
|
|
2.6.1.1.) Canvas/Plot
|
| |
|
|
|
2.6.1.1.1.) Customizable Message for No-Data-In-Plot
|
| |
|
|
|
2.6.1.1.2.) Set Chart to Fit Canvas
|
| |
|
|
|
2.6.1.1.3.) Set Chart Invisible
|
| |
|
|
|
2.6.1.1.4.) Applying Different Graphics Rendering
|
| |
|
|
|
2.6.1.1.5.) Chart Plot Position
|
| |
|
|
|
2.6.1.1.6.) Drawing Multiple Charts in same Plot
|
| |
|
|
2.6.1.2.) Hint Box
|
| |
|
|
|
2.6.1.2.1.) Modify Hint Box
|
| |
|
|
|
2.6.1.2.2.) Data and Hyperlink Hint Box Offset
|
| |
|
|
|
2.6.1.2.3.) Hint Box Border Color
|
| |
|
|
|
2.6.1.2.4.) Customize Image Map Hint Box
|
| |
|
|
2.6.1.3.) Legend/Annotation
|
| |
|
|
|
2.6.1.3.1.) Annotation with Symbol
|
| |
|
|
|
2.6.1.3.2.) Set Reference Position of Legend and Annotation Text
|
| |
|
|
2.6.1.4.) Misc.
|
| |
|
|
|
2.6.1.4.1.) Ticker Label Replacement
|
| |
|
|
|
2.6.1.4.2.) Customizable Data Top Label
|
| |
|
|
|
2.6.1.4.3.) Show Value Axis as Date/Time/Timestamp
|
| |
|
|
|
2.6.1.4.4.) Selective String Rendering
|
| |
|
|
|
2.6.1.4.5.) Drawing Data Points above Horizontal/Vertical/Trend Lines
|
| |
|
2.6.2.) Data
|
| |
|
|
2.6.2.1.) Getting the Coordinates
|
| |
|
|
2.6.2.2.) Set Data Limit at Axis Scale
|
| |
|
|
2.6.2.3.) Set Null Data as Zero
|
| |
|
|
2.6.2.4.) Additional Trend Line Options
|
| |
|
2.6.3.) Chart Specific
|
| |
|
|
2.6.3.1.) Column/Bar Charts
|
| |
|
|
|
2.6.3.1.1.) Color Separator
|
| |
|
|
|
2.6.3.1.2.) Disabling Shadow
|
| |
|
|
2.6.3.2.) Pie Charts
|
| |
|
|
|
2.6.3.2.1.) Drawing Pie Slices Clockwise/Counter Clockwise
|
| |
|
|
|
2.6.3.2.2.) Pie Border for 0% and 100% Slices
|
| |
|
|
|
2.6.3.2.3.) Customize Separator between Category and Percent Value Strings in Pie Legend
|
| |
|
|
|
2.6.3.2.4.) Pie Border Color Customizable
|
| |
|
|
2.6.3.3.) Line Charts
|
| |
|
|
|
2.6.3.3.1.) Line Area
|
| |
|
|
2.6.3.4.) Scatter Charts
|
| |
|
|
|
2.6.3.4.1.) Show Series in Top Label
|
| |
|
|
|
2.6.3.4.2.) Drawing Order
|
| |
|
|
|
2.6.3.4.3.) Scatter Chart Cube Width
|
| |
|
|
2.6.3.5.) Overlay Charts
|
| |
|
|
|
2.6.3.5.1.) Multiple Axes Titles
|
| |
|
|
2.6.3.6.) Dial Charts
|
| |
|
|
|
2.6.3.6.1.) Control Area Scale Labels
|
| |
|
|
2.6.3.7.) HLCO Charts
|
| |
|
|
|
2.6.3.7.1.) Changing Candle Stick Color
|
| |
|
|
|
2.6.3.7.2.) Changing CandleStick Wicker Width
|
| |
|
|
2.6.3.8.) Surface Charts
|
| |
|
|
|
2.6.3.8.1.) Heat Map
|
| |
|
2.6.4.) Performance
|
| |
|
|
2.6.4.1.) BufferedImage or Frame
|
| |
|
|
2.6.4.2.) Chart Generation Order
|
| |
|
2.6.5.) Viewer
|
| |
|
|
2.6.5.1.) Call Back Mechanism
|
| |
|
|
2.6.5.2.) Disable/Enable Tools Tips Text
|
| |
|
|
2.6.5.3.) Canvas Area
|
| |
2.7.) Changing Chart Viewer Options
|
| |
2.8.) Javadoc
|
| |
2.9.) Swing Version
|
| |
2.10.) Summary
|
3.) Managing Users and Groups
|
| |
3.1.) Introduction
|
| |
3.2.) Users and Groups
|
| |
|
3.2.1.) Creating Users and Groups
|
| |
|
3.2.2.) Deleting Users and Groups
|
| |
3.3.) Single Sign-On
|
| |
3.4.) Login Listener
|
| |
3.5.) Javadoc
|
| |
3.6.) Summary
|
4.) ERES Menu API Overview
|
| |
4.1.) Introduction and Setup
|
| |
4.2.) Using the API
|
| |
|
4.2.1.) Creating and Customizing an ERES Menu
|
| |
|
|
4.2.1.1.) Connecting to ERES Server
|
| |
|
|
4.2.1.2.) Getting User Menu Page
|
| |
|
|
4.2.1.3.) Getting all Visible Nodes
|
| |
|
|
4.2.1.4.) Getting the Node Details
|
| |
|
|
4.2.1.5.) Getting the File Details
|
| |
|
|
4.2.1.6.) Scheduling/Archiving
|
| |
|
4.2.2.) Exporting Reports/Charts using the LookupServlet Servlet
|
| |
4.3.) Javadoc
|
| |
4.4.) Summary
|
5.) Menu JSP Programming
|
| |
5.1.) Menu Page Architecture
|
| |
5.2.) Login Code
|
| |
5.3.) Building the Main Page
|
| |
5.4.) Running Reports and Charts
|
| |
5.5.) Retrieving Scheduled Reports and Charts
|
| |
5.6.) Running Archived Reports and Charts
|
| |
5.7.) Getter Methods
|
| |
|
5.7.1.) MenuMainPage
|
| |
|
5.7.2.) FolderNode
|
| |
|
5.7.3.) ItemNode
|
| |
|
5.7.4.) ItemScheduleJob
|
| |
|
5.7.5.) ItemArchiveJob
|
| |
|
5.7.6.) MenuRunReport
|
| |
|
5.7.7.) MenuRunChart
|
| |
|
5.7.8.) MenuRunSchedule
|
| |
|
5.7.9.) MenuReportSecurity
|
| |
|
5.7.10.) MenuRunArchive
|
| |
|
5.7.11.) MenuRunArchiveCHT
|
| |
|
5.7.12.) MenuArchiveSecurity
|
| |
|
5.7.13.) MenuScheduleParam
|
6.) Organizer
|
| |
6.1.) Introduction
|
| |
6.2.) Look and Feel
|
| |
6.3.) Inserting and Removing Items
|
| |
6.4.) Customizing Report and Chart Designer
|
| |
6.5.) Calling Scheduler
|
| |
6.6.) Javadoc
|
| |
6.7.) Summary
|
7.) Scheduler
|
| |
7.1.) Introduction
|
| |
7.2.) Scheduling an Export
|
| |
7.3.) Scheduling a Package
|
| |
7.4.) Scheduling an Archive
|
| |
7.5) Removing a Schedule
|
| |
7.6.) Getting Details of a Failed Schedule
|
| |
7.7.) ICallBackScheduler Interface
|
| |
7.8.) Scheduler Listener
|
| |
7.9.) Report Bursting
|
| |
7.10.) Javadoc
|
| |
7.11.) Summary
|
8.) SOAP Interface
|
| |
8.1) LookupService Running
|
| |
8.2.) Request Message
|
| |
|
8.2.1.) Header Elements
|
| |
|
8.2.2.) Body Elements
|
| |
|
8.2.3.) Request Message Attachments
|
| |
|
8.2.4.) Example of Request Message
|
| |
|
8.2.5.) Passing Query Parameters
|
| |
8.3.) Response Message
|
| |
|
8.3.1.) Messages from the LookupService
|
| |
|
8.3.2.) Response Message Attachments
|
| |
8.4.) SimpleSOAPMessenger
|
| |
|
8.4.1.) SOAP Client Example
|
9.) Deployment
|
| |
9.1.) Introduction
|
| |
9.2.) Deploying with ERES Server
|
| |
|
9.2.1.) Report Designer
|
| |
|
9.2.2.) Report Viewer
|
| |
|
9.2.3.) Page Viewer
|
| |
|
9.2.4.) Chart Viewer
|
| |
|
9.2.5.) Report API
|
| |
|
9.2.6.) Scheduler
|
| |
9.3.) Deploying without ERES Server
|
| |
|
9.3.1.) Report Viewer
|
| |
|
9.3.2.) Page Viewer
|
| |
|
9.3.3.) Chart Viewer
|
| |
|
9.3.4.) Report API
|
| |
9.4.) Deploying in a non-Windows environment
|
| |
|
9.4.1.) XvfB (X Virtual Frame Buffer)
|
| |
|
9.4.2.) JVM 1.4 in headless mode
|
| |
9.5.) Platform Specific Issues
|
| |
|
9.5.1.) AS/400
|
| |
|
|
9.5.1.1.) Running under NAWT
|
| |
|
|
9.5.1.2.) Running under headless mode
|
| |
|
9.5.2.) Linux/Unix
|
| |
|
|
9.5.2.1.) Running under X
|
| |
|
|
9.5.2.2.) Running under headless mode
|
| |
1.A.) Appendix A: Getting the Data
|
| |
|
1.A.1.) Data from a Database
|
| |
|
|
1.A.1.1.) JNDI
|
| |
|
1.A.2.) Data from a Data File (TXT/DAT/XML)
|
| |
|
1.A.3.) Data from an XML Data Source
|
| |
|
1.A.4.) Data passed in an Array in Memory
|
| |
|
1.A.5.) Data passed in a Custom Implementation
|
| |
|
1.A.6.) Data from Enterprise Java Beans (EJBs)
|
| |
|
1.A.7.) Data from a SOAP Data Source
|
| |
|
1.A.8.) Data from Multiple Data Sources
|
| |
1.B.) Appendix B: Creating the Report
|
| |
|
1.B.1.) Simple Columnar
|
| |
|
|
1.B.1.1.) Column Mapping
|
| |
|
|
1.B.1.2.) Creating the Report
|
| |
|
1.B.2.) Summary Break
|
| |
|
|
1.B.2.1.) Column Mapping
|
| |
|
|
1.B.2.2.) Creating the Report
|
| |
|
1.B.3.) CrossTab
|
| |
|
|
1.B.3.1.) Column Mapping
|
| |
|
|
1.B.3.2.) Creating the Report
|
| |
|
|
1.B.3.3.) Fixed-field Crosstab Report
|
| |
|
|
|
1.B.3.3.1.) Data Mapping
|
| |
|
1.B.4.) Master & Details
|
| |
|
|
1.B.4.1.) Column Mapping
|
| |
|
|
1.B.4.2.) Creating the Report
|
| |
|
1.B.5.) Mailing Labels
|
| |
|
|
1.B.5.1.) Column Mapping
|
| |
|
|
1.B.5.2.) Creating the Report
|
| |
|
1.B.6.) Formula
|
| |
|
1.B.7.) Parameterized Report
|
| |
|
|
1.B.7.1.) Creating the Report with Single Value Parameter
|
| |
|
|
1.B.7.2.) Creating the Report with Multi Value Parameter
|
| |
|
1.B.8.) Sub-Report
|
| |
|
|
1.B.8.1.) Creating the Report
|
| |
|
1.B.9.) Drill Down
|
| |
|
|
1.B.9.1.) Creating the Report
|
| |
2.A.) Appendix A: Getting the Data
|
| |
|
2.A.1.) Data from a Database
|
| |
|
|
2.A.1.1.) Data from JNDI
|
| |
|
2.A.2.) Data from a Data file (TXT/DAT/XML)
|
| |
|
2.A.3.) Data from a XML Data Source
|
| |
|
2.A.4.) Data passed in an array in memory
|
| |
|
2.A.5.) Data passed in your custom implementation
|
| |
|
2.A.6.) Data from a Spreadsheet Model
|
| |
|
2.A.7.) Data from Enterprise Java Beans (EJB's)
|
| |
|
2.A.8.) Data from multiple Data Sources
|
| |
|
2.A.9.) Data in Spreadsheet format
|
| |
|
2.A.10.) Transposing Data
|
| |
|
|
2.A.10.1.) Non-selective Transposing
|
| |
|
|
2.A.10.2.) Selective Transposing
|
| |
2.B.) Appendix B: Creating the Chart
|
| |
|
2.B.1.) Column, Bar, Line, Area, Pie and Overlay Charts
|
| |
|
|
2.B.1.1.) Column Mapping
|
| |
|
|
2.B.1.2.) Creating the Chart
|
| |
|
2.B.2.) Radar Charts
|
| |
|
|
2.B.2.1.) Column Mapping
|
| |
|
|
2.B.2.2.) Creating the Chart
|
| |
|
2.B.3.) XY(Z) Scatter Charts
|
| |
|
|
2.B.3.1.) Column Mapping
|
| |
|
|
2.B.3.2.) Creating the Chart
|
| |
|
2.B.4.) Stack Column, Percentage Column, Stack Bar and Stack Area Charts
|
| |
|
|
2.B.4.1.) Column Mapping
|
| |
|
|
2.B.4.2.) Creating the Chart
|
| |
|
2.B.5.) Dial Charts
|
| |
|
|
2.B.5.1.) Column Mapping
|
| |
|
|
2.B.5.2.) Creating the Chart
|
| |
|
2.B.6.) Box Charts
|
| |
|
|
2.B.6.1.) Column Mapping
|
| |
|
|
2.B.6.2.) Creating the Chart
|
| |
|
2.B.7.) Bubble Charts
|
| |
|
|
2.B.7.1.) Column Mapping
|
| |
|
|
2.B.7.2.) Creating the Chart
|
| |
|
2.B.8.) High-Low and HLCO Charts
|
| |
|
|
2.B.8.1.) Column Mapping
|
| |
|
|
2.B.8.2.) Creating the Chart
|
| |
|
2.B.9.) Surface Charts
|
| |
|
|
2.B.9.1.) Column Mapping
|
| |
|
|
2.B.9.2.) Creating the Chart
|
| |
|
2.B.10.) Gantt Charts
|
| |
|
|
2.B.10.1.) Column Mapping
|
| |
|
|
2.B.10.2.) Creating the Chart
|
| |
|
2.B.11.) Polar Charts
|
| |
|
|
2.B.11.1.) Column Mapping
|
| |
|
|
2.B.11.2.) Creating the Chart
|
| |
|
2.B.12.) Date/Time Based Zoom Charts
|
| |
|
2.B.13.) Parameterized Charts
|
| |
|
2.B.14.) Drill Down Charts
|
| |
|
|
2.B.14.1.) Parameter Drill Down Charts
|
| |
|
|
2.B.14.2.) Data Drill Down Charts
|
| |
|
|
2.B.14.3.) Dynamic Data Drill Down Charts
|
| |
|
2.B.15.) Adding a Chart to a Report
|
| |
|
|
2.B.15.1.) Adding a Chart Template
|
| |
|
|
2.B.15.2.) Adding a Chart that uses Report Data
|
| |
|
|
2.B.15.3.) Adding a Chart that uses an Independent Data Source
|