About Actuate BIRT Application Developer Guide
Getting started using BIRT Designer Professional
Learning the basics
Learning the basics overview
About BIRT reports
Overview of the report design process
About the report design environment
Starting BIRT Report Designer
Report design views
Tutorial 1: Building a simple listing report
Next steps
About report files and supported formats
Report design files
Report output formats
Viewing a report
Setting up Accessible PDF
The PDF Accessibility Properties screen
Using the document tree
Using the Properties pane
Generating an accessible PDF
Planning a BIRT application
Introducing BIRT applications
About BIRT application file structure
Accessing BIRT application content
Designing and deploying an application
Overview of the BIRT application design process
Planning the BIRT application
Add content to the BIRT project
Publishing to a server
Tutorial 1: Building a data object
Tutorial 2: Building a simple dashboard
Designing a landing page
Tutorial 3: Deploy the BIRT application
Designing applications
Designing a dashboard
About dashboard applications
Planning dashboard layout
Creating a dashboard
Adding a dashboard tab
Choosing a dashboard layout
Formatting a dashboard tab
Adding data objects to a dashboard
Importing an existing dashboard
Saving a dashboard
Opening a dashboard file
Adding gadgets to a dashboard
Placing a gadget
Formatting a gadget
Testing dashboard content
Displaying a file on a dashboard
About files on a dashboard
Displaying BIRT documents
Displaying BIRT report items from a library
Displaying BIRT parameters
Displaying parameters in a data selector gadget
Displaying parameters in a parameter gadget
Displaying web content
Displaying HTML content
Displaying images
Displaying Google gadgets
Displaying text
Displaying video
Visualizing data on a dashboard
About displaying data on a dashboard
Displaying data in a chart
Selecting a chart type
Selecting data for charts
Formatting charts
Displaying data in a table or cross tab
Choosing a table type
Using a table
Using a cross tab
Displaying data in measurement gadgets
Choosing a measurement type
Selecting data for measurement gadgets
Aggregating measurement data
Formatting measurement gadgets
Enabling data selection
Displaying data for user selection
Formatting data selection gadgets
Using a data version gadget
Organizing multiple user selections
Building cascade selections
Building group selections
Using an apply button gadget
Using parameter selections
Designing a report
Formatting features in BIRT Designer Professional
Creating an accessible PDF
Selecting features for interactive viewing
Interactive scripting sample 1
Interactive scripting sample 2
Embedding HTML5 content
Removing the default themes
Hiding columns in a table
Using a Quick Response code to link to content
Designing for optimal viewer performance
Laying out a report
About report layouts
Understanding the layout model
About the report layout elements
Overview of the layout process
Creating the sections of a report
Organizing elements in a grid
Organizing elements in a table
Organizing elements in a list
Placing report elements
Placing report elements side by side
Inserting a data set field
Inserting a computed field
Inserting an image
Displaying text
Overview of textual information
Types of textual elements
Deciding which textual element to use
Using a dynamic text element
Using a label element
Using a text element
Applying multiple style formats to text
Combining a JavaScript expression and static text
Combining a value from a data set field and static text
Formatting dynamic values in a text element
Displaying data set field values that are stored as HTML text
Displaying text from right to left
Setting text flow direction for a report
Setting text flow direction for an element
Formatting report content
Overview of formatting options
Formatting data
Formatting numeric data
Formatting date-and-time data
Formatting string data
Copying formats
Formatting with styles
Creating styles
Reusing CSS styles
Applying a style
Modifying a style
Deleting a style
Formatting data based on conditions
Creating a formatting rule
Modifying a formatting rule
Creating multiple formatting rules
Deleting a formatting rule
Alternating row colors in a table
Specifying alignment of content in a table or grid
Aligning text horizontally
Aligning content vertically
Adjusting the spacing of content in a report
Wrapping text onto multiple lines
Resizing rows and columns
Resizing margins, borders, and padding of elements
Specifying auto-expand layout for HTML output
Displaying data values in one row
Displaying content across multiple columns
Specifying alternate values for display
Hiding elements based on conditions
Sorting and grouping data
About organizing data
Sorting data
Ways to sort data
Setting the sort strength
Sorting string data ignoring capitalization
Grouping data
Grouping data by intervals
Sorting data at the group level
Disabling group sorting
Creating multiple groups
Changing the order of groups
Adding group headings
Tutorial 4: Grouping report data
Aggregating data
About aggregating data
Types of aggregate calculations
Placing aggregate data
Creating an aggregation
Filtering aggregate data
Excluding null values from an aggregate calculation
Counting unique field values in a set of rows
Calculating percentages
Creating a summary report
Hiding details
Creating a top n report
Writing expressions
About writing expressions
Basic concepts
Data types
Case sensitivity
Multiline expressions
Using the expression builder
Creating an expression
Validating an expression
Manipulating numeric data
Computing values from multiple numeric fields
Converting a number to a string
Manipulating string data
Substituting string values
Combining values from multiple fields
Removing null values from combined fields
Removing spaces from the ends of strings
Getting parts of a string
Matching string patterns
Converting a string to a number
Converting a string to a date
Manipulating date-and-time data
Displaying the current date
Getting parts of a date or time as a number
Calculating the time between two dates
Calculating a date
Using specific dates in an expression
Using Boolean expressions
Filtering data
About filtering data
Filtering opportunities
Specifying conditions on row retrieval
Filtering database data
Types of SQL filter conditions
Filtering XML data
Filtering data after row retrieval
Deciding where to filter in BIRT
Types of BIRT filter conditions
Creating a filter condition
Creating multiple filter conditions
Recalculating totals after applying a filter
Enabling the user to filter data
Overview of user filtering
About report parameters
Planning to use report parameters
User filtering options
Enabling user filtering at query run time
Creating a report parameter
Inserting a parameter marker in the SQL query
Defining a data set parameter and binding it to the report parameter
Creating a SQL query at run time
Enabling user filtering after data retrieval
Creating a report parameter
Providing a filter condition value when the report runs
Enabling dynamic filter conditions
Creating a dynamic filter report parameter
Creating a dynamic filter
Designing the presentation of report parameters
Providing a default value
Providing the user with a list of values
Formatting report parameter values
Enabling the user to specify null or blank values
Organizing report parameters in groups
Creating cascading report parameters
Changing the order in which report parameters appear
Testing the report parameters
Tutorial 5: Creating and using report parameters
Building a report that contains subreports
About subreports
Creating the report structure
Building a report with independent subreports
Building a report with linked subreports
Tutorial 6: Building a report containing side‑by‑side subreports
Building application components
Building interactive maps and gadgets
About maps and gadgets
Adding a gadget or map
Providing data to a map
Validating map data
Formatting a map
General properties
Highlights properties
Rendering platform
Adding scripts to a map
Writing event handlers that respond to user interactions
Using event handlers before map generation
Formatting a gadget
General properties
Scale properties
Needle properties
Needle base or pivot properties
Number formatting properties
Region properties
Tick properties
Threshold properties
Anchor properties
Plot properties
Value indicator properties
Tooltip properties
Font properties
Padding and margin properties
AddOn properties
Using a chart
Charts overview
Surveying the types of charts
About area charts
About bar charts
About tube, cone, and pyramid charts
About chart subtypes
About line charts
About meter charts
About pie charts
About scatter charts
About bubble charts
About stock charts
About difference charts
About Gantt charts
Tutorial 7: Creating a stand-alone chart
Exploring the chart builder
Creating a chart with depth or three dimensions
Using chart subtypes
Understanding chart output formats
Using a chart in a table
Displaying data in charts
About displaying data in charts
Linking data to a chart
Linking to data from a container
Linking to data from a data set, data cube, or report item
Understanding the axes of a chart
About the axes
Defining the axes
Plotting different chart types
Plotting the x- and y-axes
Grouping and sorting category data
Grouping date-and-time data
Grouping textual data
Grouping numeric data
Sorting category data
Grouping optional Y value data
Grouping Y values in a bar chart
Grouping multiple y-axis values in a stock chart
Using multiple y-axes
Transposing chart axes
Filtering data
Changing default report parameters
Creating data bindings
Previewing data and charts
Creating a combination chart
Defining a meter chart
Using multiple meters in a chart
Using multiple dials in a chart
Laying out and formatting a chart
About formatting charts
Overview of formatting
Formatting specific types of charts
Formatting an area chart
Formatting a line or a scatter chart
Formatting a bar chart
Formatting a bubble chart
Formatting a difference chart
Formatting a Gantt chart
Formatting a meter chart
Formatting a pie chart
Formatting a stock chart
Formatting a three-dimensional chart
Setting chart area format attributes
Setting the background color for a chart
Outlining a chart
Adding padding around the chart
Formatting the chart legend, plot, and title
Working with the plot area
Formatting the chart title text
Formatting the title area
Working with the legend
Formatting axis titles, markers, lines, and labels
Working with an axis title
Working with axis markers
Working with an axis line
Working with axis labels
Defining the axis data type and number format
Defining where one axis intersects the other
Defining the scale of an axis
Formatting a series
Stacking series
Hiding a series
Making a series translucent
Setting the color palette for a series
Formatting numbers, dates, and times
Working with data points and data point labels
Adding and formatting a curve-fitting line
Building an interactive chart
About interactive charts
Comparing HTML5 and BIRT charts
Rendering platform
Creating an interactive chart
Formatting an interactive chart
Applying a chart theme
Creating a chart theme
Adding scripts to a chart
Writing event handlers that respond to user interactions
Writing event handlers that respond to chart events
Presenting data in a cross tab
About cross tabs
Tutorial 8: Creating a cross tab
Setting up data for a cross tab
About cubes
Planning the data
Designing the cube
Designing data sets for a cube
Building a multi-dataset cube
Building a cross tab
Areas of a cross tab
Displaying multiple dimensions in row and column areas
Displaying or hiding dimension levels
Displaying multiple measures
Adding a derived measure
Adding subtotals and grand totals
Displaying empty rows and columns
Displaying user-defined values in row and column headings
Displaying data by relative time periods
Sorting cross tab data
Limiting the amount of data the cross tab displays
Presenting different views of the same data
About sharing data
Ways to share data
Sharing a data set
Sharing a cube
Sharing data defined in another report element
Guidelines for selecting a data-sharing method
Building a dashboard report
Using data from a table
Using data from a cross tab
Using data from a chart
Building a template
About report templates
Design considerations
Separating or combining visual and data elements
Designing themes
Improving usability
Creating a report template
Providing data with a report template
Using a CSV file as a data source
Excluding a data set
Creating themes for a report template
Publishing a template
Setting the default template category
Enhancing application components
Designing a multipage report
About designing multipage reports
Planning the page layout
Controlling pagination
Inserting page breaks
Specifying the number of rows per page
Customizing the master page
Viewing the master page
Designing the page header and footer
Adding interactive viewing features
Interactive features overview
Creating hyperlinks
Linking two sections in a report
Linking to a section in a different report
Linking to external content
Creating a table of contents
Using the default table of contents
Defining a custom table of contents
Building a shared development framework
About building a shared development framework
Sharing report elements using a library
Understanding dynamic library behavior
Creating a library
Sharing a library with other report developers
Designing libraries for a shared environment
Designing a general library
Designing a structures library
Defining a project library
Using a library
Understanding libraries in Resource Explorer
Using library report elements
Using styles from a library
Troubleshooting library problems
Sharing a report layout as a template
Developing a custom template
Using a custom template
Localizing text
About localizing text
Overview of the localization process
Assigning a resource file to a report
Assigning resource keys
Assigning a resource key to a label or text element
Changing localized text in a label or text element to static text
Assigning a resource key to chart text
Changing localized chart text to static text
Assigning a resource key to a data value
Assigning a resource key to a report parameter
Editing a resource file
Previewing a report in different locales
Writing expressions using EasyScript
About EasyScript
Choosing between EasyScript and JavaScript
Syntax rules
Using the EasyScript expression builder
Changing the default expression syntax
Adding web interactivity to a report
About HTML buttons
Creating an HTML button
Writing code for an HTML button
Accessing report data
Using the Actuate JavaScript API
Testing an HTML button
Changing the appearance of an HTML button
Implementing data security
About the security model
About access control lists and security IDs
ACL expression syntax
Controlling user access to report pages
Adding page-level security to a report
Enabling and disabling page-level security
Configuring page numbers
Testing page-level security
Controlling user access to data
Adding security to a data object
Enabling and disabling data security
Testing data security
Linking and scripting gadgets
About linking gadgets together
Building gadget links
Understanding automatic linking
Selecting a field to receive link data
Scripting linked gadgets
Using JavaScript objects to retrieve values
Using linked values
Reading and writing parameter values
Building Google gadgets
About Google gadgets
Creating Google gadgets
About gadget views
About gadget features
Linking Google gadgets
Linking an import gadget
Linking multiple Google gadgets
Linking Google gadgets together
Linking public Google gadgets
BIRT JavaScript function reference
Scripting reference
BIRT JavaScript classes quick reference
Class BirtComp
Class BirtDateTime
Class BirtDuration
Class BirtMath
Class BirtStr
Class Finance
Class Formatter
Scripting event handlers in a report design
Using scripting in a report design
About BIRT scripting
Overview of BIRT scripting
Choosing between JavaScript and Java
Using both JavaScript and Java
Events overview
Engine task processes
BIRT Web Viewer
BIRT processing phases
BIRT event types
Event order sequence
Preparation phase operation
Generation phase operation
Presentation phase operation
Event order summary
Using JavaScript to write an event handler
About JavaScript event handlers
Writing a JavaScript event handler
Global and local variables
Page variables and scripts
Execution phases and processes
The reportContext object
Using getOutputFormat
Accessing the report design handle
Passing a value between processes
Using getAppContext
Getting information from an HTTP request object
Using the this object
Using this object methods
Using the this object to set a report item property
Using the row object
Getting column information
Getting and altering the query string
Changing data source connection properties
Getting a parameter value
Determining script execution sequence
ReportDesign.initialize code
Providing code for the scripts you want to track
ReportDesign.afterFactory code
Tutorial 1: Writing an event handler in JavaScript
JavaScript event handler examples
JavaScript onPrepare example
JavaScript onCreate examples
JavaScript onRender examples
Cross tab script examples
JavaScript dynamic script example
Calling client and external JavaScript functions
Using client-side JavaScript
Referencing JavaScript from the resource folder
Calling Java from JavaScript
The Packages object
The importPackage method
Using a Java class
Placing Java classes
Issues with using Java in JavaScript code
Calling the method of a class in a plug-in
Using Java to write an event handler
About Java event handlers
Writing a Java event handler class
Locating the JAR files for a BIRT event handler
Extending an adapter class
Making the Java class visible to BIRT
Associating a Java event handler class with a report element
BIRT Java interface and class naming conventions
Writing a Java event handler
Event handler adapter classes
Event handler interfaces
Java event handlers for report items
Java event handlers for a data source element
Java event handlers for a data set element
Java event handlers for a scripted data source element
Java event handlers for a scripted data set element
Java event handlers for a report design
Understanding the BIRT interfaces
Element design interfaces
Element instance interfaces
IReportContext interface
IColumnMetaData interface
IDataSetInstance interface
IDataSetRow interface
IRowData interface
Java event handler examples
Report‑level events
Report item events
Debugging a Java event handler
Working with chart event handlers
About the chart event handler model
Chart events overview
Understanding the chart script context
Using the Chart instance
Understanding the external context
Understanding when chart events fire
Prepare phase
Data binding phase
Building phase
Rendering phase
Writing a Java chart event handler
Setting up the chart event handler project
Java chart event handler examples
Writing a JavaScript chart event handler
Using the simplified charting API
Getting an instance of a chart item
Understanding the sub-interfaces of IChart
Using scripting to access data
Scripted data source overview
Using a scripted data source
Tutorial 2: Creating a scripted data source
Writing the scripted data set in Java
Using a Java object to access a data source
Performing initialization in the data set open( ) method
Getting a new row of data in the data set fetch( ) method
Cleaning up in the data set close( ) method
Deciding where to place your Java class
Deploying your Java class
Using input and output parameters with a scripted data set
Creating a web services data source using a custom connection class
Debugging event handlers
About the BIRT report debugger
Checking JavaScript expression syntax
Debugging JavaScript event handler code
Debugging Java event handler code
Debugging report execution exceptions
Creating a debug configuration
Tutorial 3: Debugging a report that contains Java and JavaScript code
Using Actuate JavaScript API in an application
Creating dynamic report content using the Actuate JavaScript API
About Actuate JavaScript API scripting in a BIRT report design
Using the Actuate JavaScript API in an HTML button
Tutorial 1: Adding scripted chart controls to a BIRT design
Tutorial 2: Using HTML buttons to apply filters to a chart
Using the Actuate JavaScript API in chart interactive features
Tutorial 3: Adding an interactive chart filter to a BIRT report
Using the Actuate JavaScript API in chart themes
Tutorial 4: Adding scripted HTML5 Chart controls to a BIRT design
Working with Interactive Crosstabs
About cross tabs
Tutorial 5: Viewing and pivoting a cross tab
About cubes
Handling Interactive Crosstabs viewer events
Working with dimensions, measures, and levels
Adding a dimension with levels
Removing a dimension
Adding and removing measures
Changing measures and dimensions
Working with totals
Sorting and filtering cross tab data
Drilling down within a cross tab
Controlling the Interactive Crosstabs viewer user interface
Actuate JavaScript API classes
Actuate JavaScript API overview
About the actuate namespace
Using the Actuate library
Actuate JavaScript API classes quick reference
Actuate JavaScript API reference
Class actuate
Class actuate.AuthenticationException
Class actuate.ConnectionException
Class actuate.Dashboard
Class actuate.dashboard.DashboardDefinition
Class actuate.dashboard.EventConstants
Class actuate.dashboard.GadgetScript
Class actuate.dashboard.Tab
Class actuate.data.Filter
Class actuate.data.ReportContent
Class actuate.data.Request
Class actuate.data.ResultSet
Class actuate.data.Sorter
Class actuate.DataService
Class actuate.Exception
Class actuate.Parameter
Class actuate.parameter.Constants
Class actuate.parameter.ConvertUtility
Class actuate.parameter.EventConstants
Class actuate.parameter.NameValuePair
Class actuate.parameter.ParameterData
Class actuate.parameter.ParameterDefinition
Class actuate.parameter.ParameterValue
Class actuate.report.Chart
Class actuate.report.DataItem
Class actuate.report.FlashObject
Class actuate.report.Gadget
Class actuate.report.HTML5Chart.ClientChart
Class actuate.report.HTML5Chart.ClientOption
Class actuate.report.HTML5Chart.ClientPoint
Class actuate.report.HTML5Chart.ClientSeries
Class actuate.report.HTML5Chart.Highcharts
Class actuate.report.HTML5Chart.Renderer
Class actuate.report.Label
Class actuate.report.Table
Class actuate.report.TextItem
Class actuate.ReportExplorer
Class actuate.reportexplorer.Constants
Class actuate.reportexplorer.EventConstants
Class actuate.reportexplorer.File
Class actuate.reportexplorer.FileCondition
Class actuate.reportexplorer.FileSearch
Class actuate.reportexplorer.FolderItems
Class actuate.reportexplorer.PrivilegeFilter
Class actuate.RequestOptions
Class actuate.Viewer
Class actuate.viewer.BrowserPanel
Class actuate.viewer.EventConstants
Class actuate.viewer.PageContent
Class actuate.viewer.ParameterValue
Class actuate.viewer.RenderOptions
Class actuate.viewer.ScrollPanel
Class actuate.viewer.SelectedContent
Class actuate.viewer.UIConfig
Class actuate.viewer.UIOptions
Class actuate.viewer.ViewerException
BIRT Interactive Crosstabs API classes
About the BIRT Interactive Crosstabs JavaScript API
Interactive Crosstabs API reference
Interactive Crosstabs JavaScript classes quick reference
Class actuate.XTabAnalyzer
Class actuate.xtabanalyzer.Crosstab
Class actuate.xtabanalyzer.Dimension
Class actuate.xtabanalyzer.Driller
Class actuate.xtabanalyzer.EventConstants
Class actuate.xtabanalyzer.Exception
Class actuate.xtabanalyzer.Filter
Class actuate.xtabanalyzer.GrandTotal
Class actuate.xtabanalyzer.Level
Class actuate.xtabanalyzer.LevelAttribute
Class actuate.xtabanalyzer.Measure
Class actuate.xtabanalyzer.MemberValue
Class actuate.xtabanalyzer.Options
Class actuate.xtabanalyzer.PageContent
Class actuate.xtabanalyzer.ParameterValue
Class actuate.xtabanalyzer.Sorter
Class actuate.xtabanalyzer.SubTotal
Class actuate.xtabanalyzer.Total
Class actuate.xtabanalyzer.UIOptions
Deploying applications
Deploying and sharing applications
About deploying and sharing applications and files
Editing the landing page
Sharing applications
Sharing project files
Publishing a resource file to iHub
Downloading files
Managing permissions
Deploying Java classes used in BIRT reports
Installing a custom JDBC driver
Installing custom ODA drivers and custom plug-ins
Working with BIRT encryption in iHub
About BIRT encryption
About the BIRT default encryption plug-in
About supported encryption algorithms
About the components of the BIRT default encryption plug‑in
About acdefaultsecurity.jar
About encryption.properties
About META-INF/MANIFEST.MF
About plugin.xml
Creating a BIRT report that uses the default encryption
Deploying multiple encryption plug-ins
Deploying encryption plug-ins to iHub
Generating encryption keys
Creating a custom encryption plug-in
Using encryption API methods
Configuring data source connections in iHub
About data source connection properties
Using a connection profile
Creating a connection profile
Managing a connection profile
Deploying a connection profile
Encrypting connection profile properties
Binding connection profile properties
Accessing BIRT report design and BIRT resource path in custom ODA plug‑ins
Accessing resource identifiers in the run-time ODA driver
Accessing resource identifiers in the design ODA driver
Using custom emitters in iHub
About custom emitters
Deploying custom emitters to iHub and BIRT Visualization Platform
Rendering in custom formats
Configuring the default export options for a BIRT report
About Actuate BIRT Application Developer Guide
Configuring the default export options for a BIRT report
file_dirty
boolean_formatting
report_design_browsing
EditTableGadget
dashboard_summarytable_builder
EditDataSelectorGadget
dashboard_selector_builder