Actuate BIRT Application Developer Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 828 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

Contents
About Actuate BIRT Application Developer Guide
Getting started using BIRT Designer Professional
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
- Tutorial 1: Building a data object
- Tutorial 2: Building a simple dashboard
- Designing a landing page
- Tutorial 3: Deploy the BIRT application
  - Task 2: Deploy the BIRT application
  - Task 3: Test the URL entry points
Designing applications
Designing a dashboard
- About dashboard applications
- Planning dashboard layout
- Creating a dashboard
- Adding gadgets to a dashboard
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
Visualizing data on a dashboard
- About displaying data on a dashboard
- Displaying data in a chart
- Displaying data in a table or cross tab
- Displaying data in measurement gadgets
- Enabling data selection
- Organizing multiple user 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
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
- Adding scripts to a map
  - Writing event handlers that respond to user interactions
    - Adding tooltips to a map
  - Using event handlers before map generation
- Formatting a gadget
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
    - Creating a general chart theme
    - Creating a JavaScript chart theme
- Adding scripts to a chart
  - Writing event handlers that respond to user interactions
  - Writing event handlers that respond to chart events
Building a template
- About report templates
- Design considerations
- 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
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
- 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
- Controlling user access to data
Linking and scripting gadgets
- About linking gadgets together
- Building gadget links
  - Understanding automatic linking
  - Selecting a field to receive link data
- Scripting linked gadgets
Building Google gadgets
- About Google gadgets
- Creating Google gadgets
  - About gadget views
  - About gadget features
- Linking Google gadgets
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 4: Adding scripted chart controls to a BIRT design
- Tutorial 5: Using HTML buttons to apply filters to a chart
- Using the Actuate JavaScript API in chart interactive features
- Tutorial 6: Adding an interactive chart filter to a BIRT report
  - Task 2: Add a filter script to chart interactivity
- Using the Actuate JavaScript API in chart themes
- Tutorial 7: Adding scripted HTML5 Chart controls to a BIRT design
Working with Interactive Crosstabs
- About cross tabs
- Tutorial 8: Viewing and pivoting a cross tab
- About cubes
- Handling Interactive Crosstabs viewer events
- Working with dimensions, measures, and levels
- 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
  - authenticate
  - getDefaultIportalUrl
  - getDefaultRequestOptions
  - getVersion
  - getViewer
  - initialize
  - isConnected
  - isInitialized
  - load
  - logout
- Class actuate.AuthenticationException
  - getIportalUrl
  - getRequestOptions
  - getUserId
- Class actuate.ConnectionException
  - getUrl
- Class actuate.Dashboard
  - downloadDashboard
  - embedTemplate
  - getActiveTab
  - getDashboardName
  - getTemplate
  - isAutoSaveEnabled
  - isSavingNeeded
  - isUsingPersonalDashboard
  - onUnload
  - registerEventHandler
  - removeEventHandler
  - renderContent
  - save
  - saveAs
  - setActiveTab
  - setAutoSaveDelay
  - setContainer
  - setDashboardName
  - setHeight
  - setService
  - setSize
  - setTemplate
  - setWidth
  - showTabNavigation
  - submit
  - usePersonalDashboard
- Class actuate.dashboard.DashboardDefinition
  - getDefaultActiveTab
  - getTabs
- Class actuate.dashboard.EventConstants
- Class actuate.dashboard.GadgetScript
  - getCurrentReportParameters
  - getGadgetName
  - getGadgetTitle
  - getGadgetType
  - getTabName
  - getTabTitle
- Class actuate.dashboard.Tab
  - getName
  - getTabType
  - getTitle
- Class actuate.data.Filter
  - getColumnName
  - getOperator
  - getValues
  - setColumnName
  - setOperator
  - setValues
- Class actuate.data.ReportContent
  - getTextContent
- Class actuate.data.Request
  - getBookmark
  - getColumns
  - getFilters
  - getMaxRows
  - getSorters
  - getStartRow
  - setBookmark
  - setColumns
  - setFilters
  - setMaxRows
  - setSorters
  - setStartRow
- Class actuate.data.ResultSet
  - getColumnNames
  - getValue
  - next
- Class actuate.data.Sorter
  - getColumnName
  - isAscending
  - setAscending
  - setColumnName
- Class actuate.DataService
  - downloadResultSet
- Class actuate.Exception
  - getDescription
  - getErrCode
  - getMessage
  - getType
  - isExceptionType
- Class actuate.Parameter
  - downloadParameters
  - downloadParameterValues
  - getLayout
  - getParameterGroupNames
  - getReportName
  - getTransientDocumentName
  - hideNavBar
  - hideParameterGroup
  - hideParameterName
  - navigate
  - onUnload
  - registerEventHandler
  - removeEventHandler
  - renderContent
  - setAutoSuggestDelay
  - setAutoSuggestFetchSize
  - setAutoSuggestListSize
  - setExpandedGroups
  - setFont
  - setGroupContainer
  - setLayout
  - setReadOnly
  - setReportName
  - setService
  - setShowDisplayType
  - submit
- Class actuate.parameter.Constants
- Class actuate.parameter.ConvertUtility
  - convert
  - convertDate
  - getParameterMap
  - getParameterValues
- Class actuate.parameter.EventConstants
- Class actuate.parameter.NameValuePair
  - getName
  - getValue
  - setName
  - setValue
- Class actuate.parameter.ParameterData
  - getCascadingParentValues
  - getChildData
  - getControlType
  - getCurrentValue
  - getDefaultValue
  - getHelpText
  - getNameValueList
  - getParameterName
  - getParentData
  - getPickList
  - getPromptText
  - getSuggestionList
  - isAdhoc
  - isCascadingParameter
  - isDynamicFilter
  - isMultiList
  - isRequired
  - setChildData
  - setCurrentValue
  - setParentData
  - setWebService
- Class actuate.parameter.ParameterDefinition
  - getAutoSuggestThreshold
  - getCascadingParentName
  - getColumnName
  - getColumnType
  - getControlType
  - getCurrentDisplayName
  - getDataType
  - getDefaultValue
  - getDefaultValueIsNull
  - getDisplayName
  - getGroup
  - getHelpText
  - getName
  - getOperatorList
  - getPosition
  - getSelectNameValueList
  - getSelectValueList
  - isAdHoc
  - isHidden
  - isPassword
  - isRequired
  - isViewParameter
  - setAutoSuggestThreshold
  - setCascadingParentName
  - setColumnName
  - setColumnType
  - setControlType
  - setCurrentDisplayName
  - setDataType
  - setDefaultValue
  - setDefaultValueIsNull
  - setDisplayName
  - setGroup
  - setHelpText
  - setIsAdHoc
  - setIsHidden
  - setIsMultiSelectControl
  - setIsPassword
  - setIsRequired
  - setIsViewParameter
  - setName
  - setPosition
  - setSelectNameValueList
  - setSelectValueList
- Class actuate.parameter.ParameterValue
  - getColumnName
  - getColumnType
  - getDataType
  - getDisplayName
  - getGroup
  - getName
  - getPosition
  - getPromptParameter
  - getValue
  - getValueIsNull
  - isViewParameter
  - setColumnName
  - setColumnType
  - setDataType
  - setDisplayName
  - setGroup
  - setIsViewParameter
  - setName
  - setPosition
  - setPromptParameter
  - setValue
  - setValueIsNull
- Class actuate.report.Chart
  - clearFilters
  - drillDownCategory
  - drillDownSeries
  - drillUpCategory
  - drillUpSeries
  - getBookmark
  - getClientChart
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getType
  - hide
  - setChartTitle
  - setDimension
  - setFilters
  - setSize
  - setSubType
  - show
  - submit
- Class actuate.report.DataItem
  - getBookmark
  - getData
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getType
  - hide
  - show
  - submit
- Class actuate.report.FlashObject
  - clearFilters
  - getBookmark
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getType
  - hide
  - setFilters
  - show
  - submit
- Class actuate.report.Gadget
  - clearFilters
  - getBookmark
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getType
  - hide
  - setFilters
  - setGadgetType
  - setSize
  - show
  - submit
- Class actuate.report.HTML5Chart.ClientChart
  - addSeries
  - getCategoryCount
  - getChartHeight
  - getChartWidth
  - getClientOptions
  - getCore
  - getSeriesCount
  - getXAxisMax
  - getXAxisMin
  - getYAxisMax
  - getYAxisMin
  - isChartWithAxes
  - redraw
  - removeSeries
  - setSeriesVisible
  - setTitle
  - setValues
  - setXAxisRange
  - setYAxisRange
- Class actuate.report.HTML5Chart.ClientOption
  - addSeries
  - explodePieSlice
  - isChartWithAxes
  - pivotChart
  - setChartType
  - setSeriesVisible
  - setTitle
  - setXAxisTitle
  - setYAxisTitle
- Class actuate.report.HTML5Chart.ClientPoint
  - applyOptions
  - destroy
  - remove
  - select
  - update
- Class actuate.report.HTML5Chart.ClientSeries
  - addPoint
  - cleanData
  - destroy
  - hide
  - redraw
  - remove
  - render
  - select
  - setData
  - setVisible
  - show
- Class actuate.report.HTML5Chart.Highcharts
- Class actuate.report.HTML5Chart.Renderer
  - arc
  - circle
  - clipRect
  - destroy
  - g
  - image
  - path
  - rect
  - setSize
  - text
- Class actuate.report.Label
  - getBookmark
  - getHtmlDom
  - getInstanceId
  - getLabel
  - getPageContent
  - getType
  - hide
  - show
  - submit
- Class actuate.report.Table
  - clearFilters
  - getBookmark
  - getColumn
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getRow
  - getType
  - groupBy
  - hide
  - hideColumn
  - hideDetail
  - removeGroup
  - setFilters
  - setSorters
  - show
  - showColumn
  - showDetail
  - submit
  - swapColumns
- Class actuate.report.TextItem
  - getBookmark
  - getHtmlDom
  - getInstanceId
  - getPageContent
  - getText
  - getType
  - hide
  - show
  - submit
- Class actuate.ReportExplorer
  - getFolderName
  - getLatestVersionOnly
  - getResultDef
  - getSearch
  - onUnload
  - registerEventHandler
  - removeEventHandler
  - setContainer
  - setFolderName
  - setLatestVersionOnly
  - setResultDef
  - setSearch
  - setService
  - setStartingFolder
  - setUseDescriptionAsLabel
  - showFoldersOnly
  - submit
- Class actuate.reportexplorer.Constants
- Class actuate.reportexplorer.EventConstants
- Class actuate.reportexplorer.File
  - getAccessType
  - getDescription
  - getFileType
  - getId
  - getName
  - getOwner
  - getPageCount
  - getSize
  - getTimeStamp
  - getUserPermissions
  - getVersion
  - getVersionName
  - setAccessType
  - setDescription
  - setFileType
  - setId
  - setName
  - setOwner
  - setPageCount
  - setSize
  - setTimeStamp
  - setUserPermissions
  - setVersion
  - setVersionName
- Class actuate.reportexplorer.FileCondition
  - getField
  - getMatch
  - setField
  - setMatch
- Class actuate.reportexplorer.FileSearch
  - getAccessType
  - getCondition
  - getConditionArray
  - getCountLimit
  - getDependentFileId
  - getDependentFileName
  - getFetchDirection
  - getFetchHandle
  - getFetchSize
  - getIncludeHiddenObject
  - getOwner
  - getPrivilegeFilter
  - getRequiredFileId
  - getRequiredFileName
  - setAccessType
  - setCondition
  - setConditionArray
  - setCountLimit
  - setDependentFileId
  - setDependentFileName
  - setFetchDirection
  - setFetchHandle
  - setFetchSize
  - setIncludeHiddenObject
  - setOwner
  - setPrivilegeFilter
  - setRequiredFileId
  - setRequiredFileName
- Class actuate.reportexplorer.FolderItems
  - getFetchHandle
  - getItemList
  - getTotalCount
  - setFetchHandle
  - setItemList
  - setTotalCount
- Class actuate.reportexplorer.PrivilegeFilter
  - getAccessRights
  - getGrantedRoleId
  - getGrantedRoleName
  - getGrantedUserId
  - getGrantedUserName
  - setAccessRights
  - setGrantedRoleId
  - setGrantedRoleName
  - setGrantedUserId
  - setGrantedUserName
- Class actuate.RequestOptions
  - getIServerUrl
  - getLocale
  - getRepositoryType
  - getVolume
  - getVolumeProfile
  - setCustomParameters
  - setIServerUrl
  - setLocale
  - setRepositoryType
  - setVolume
  - setVolumeProfile
- Class actuate.Viewer
  - disableIV
  - downloadReport
  - downloadResultSet
  - enableIV
  - getChart
  - getClientHeight
  - getClientWidth
  - getContentByBookmark
  - getContentByPageRange
  - getContentMargin
  - getCurrentPageContent
  - getCurrentPageNum
  - getDataItem
  - getFlashObject
  - getGadget
  - getHeight
  - getLabel
  - getReportletBookmark
  - getReportName
  - getTable
  - getText
  - getTotalPageCount
  - getUIConfig
  - getUIOptions
  - getViewer
  - getWidth
  - gotoBookmark
  - gotoPage
  - isInteractive
  - saveReportDesign
  - saveReportDocument
  - setContentMargin
  - setFocus
  - setHeight
  - setParameters
  - setParameterValues
  - setReportDocument
  - setReportletBookmark
  - setReportName
  - setService
  - setSize
  - setSupportSVG
  - setUIOptions
  - setViewingMode
  - setWidth
  - showDownloadReportDialog
  - showDownloadResultSetDialog
  - showFacebookCommentPanel
  - showParameterPanel
  - showPrintDialog
  - showTocPanel
  - submit
- Class actuate.viewer.BrowserPanel
- Class actuate.viewer.EventConstants
- Class actuate.viewer.PageContent
  - getChartByBookmark
  - getDataItemByBookmark
  - getFlashObjectByBookmark
  - getGadgetByBookmark
  - getLabelByBookmark
  - getTableByBookmark
  - getTextByBookmark
  - getViewerId
- Class actuate.viewer.ParameterValue
  - getName
  - getValue
  - getValueIsNull
  - setColumnName
  - setValue
  - setValueIsNull
- Class actuate.viewer.RenderOptions
  - getOptions
  - setOption
- Class actuate.viewer.ScrollPanel
  - getMouseScrollingEnabled
  - getPanInOutEnabled
  - setMouseScrollingEnabled
  - setPanInOutEnabled
- Class actuate.viewer.SelectedContent
  - getColumnIndex
  - getSelectedElement
- Class actuate.viewer.UIConfig
  - getContentPanel
  - getShowToc
  - setContentPanel
  - setShowToc
- Class actuate.viewer.UIOptions
  - enableAdvancedSort
  - enableAggregation
  - enableCalculatedColumn
  - enableChartProperty
  - enableChartSubType
  - enableCollapseExpand
  - enableColumnEdit
  - enableColumnResize
  - enableContentMargin
  - enableDataAnalyzer
  - enableDataExtraction
  - enableEditReport
  - enableExportReport
  - enableFacebookComments
  - enableFilter
  - enableFlashGadgetType
  - enableFormat
  - enableGroupEdit
  - enableHideShowItems
  - enableHighlight
  - enableHoverHighlight
  - enableLaunchViewer
  - enableLinkToThisPage
  - enableMainMenu
  - enableMoveColumn
  - enablePageBreak
  - enablePageNavigation
  - enableParameterPage
  - enablePrint
  - enableReorderColumns
  - enableRowResize
  - enableSaveDesign
  - enableSaveDocument
  - enableShowToolTip
  - enableSort
  - enableSuppressDuplicate
  - enableSwitchView
  - enableTextEdit
  - enableTOC
  - enableToolBar
  - enableToolbarContextMenu
  - enableToolbarHelp
  - enableTopBottomNFilter
  - enableUndoRedo
  - getFeatureMap
- Class actuate.viewer.ViewerException
  - getElement
  - getErrorMessage
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
  - commit
  - forceSoftRestart
  - getCurrentPageContent
  - }getCurrentPageNum
  - getGadgetId
  - getHeight
  - getLeft
  - getParameterValues
  - getPosition
  - getTop
  - getTotalPageCount
  - getUIOptions
  - getViewer
  - getWidth
  - getXTabBookmark
  - getXTabIid
  - isActive
  - isDashboard
  - isInteractive
  - registerEventHandler
  - removeEventHandler
  - reset
  - resizeTo
  - rollback
  - setGadgetId
  - setHeight
  - setIVMode
  - setLeft
  - setOnClosed
  - setPageNum
  - setParameterValues
  - setPosition
  - setReportletDocumentMode
  - setReportName
  - setService
  - setSupportSVG
  - setTop
  - setUIOptions
  - setWidth
  - setXTabBookmark
  - setXTabIid
  - submit
- Class actuate.xtabanalyzer.Crosstab
  - addDimension
  - addMeasure
  - applyOptions
  - changeMeasureDirection
  - clearFilters
  - drill
  - drillDown
  - drillUp
  - editMeasure
  - getBookmark
  - getColumn
  - getData
  - getHtmlDom
  - getPageContent
  - getRow
  - getType
  - hideDetail
  - pivot
  - removeDimension
  - removeMeasure
  - reorderDimension
  - reorderMeasure
  - setFilters
  - setSorters
  - setTotals
  - showDetail
  - submit
- Class actuate.xtabanalyzer.Dimension
  - addLevel
  - getAxisType
  - getDimensionName
  - getIndex
  - getLevels
  - getNewAxisType
  - getNewIndex
  - setAxisType
  - setDimensionName
  - setIndex
  - setLevels
  - setNewAxisType
  - setNewIndex
- Class actuate.xtabanalyzer.Driller
  - addMember
  - getDimension
  - getMembers
  - setDimension
  - setMembers
- Class actuate.xtabanalyzer.EventConstants
- Class actuate.xtabanalyzer.Exception
  - getDescription
  - getElement
  - getErrCode
  - getMessage
  - getType
  - isExceptionType
- Class actuate.xtabanalyzer.Filter
  - getFilterType
  - getLevelAttributeName
  - getLevelName
  - getOperator
  - getValues
  - setFilterType
  - setLevelAttributeName
  - setLevelName
  - setOperator
  - setValues
- Class actuate.xtabanalyzer.GrandTotal
  - addTotal
  - getAxisType
  - getTotals
  - getType
  - setAxisType
  - setTotals
- Class actuate.xtabanalyzer.Level
  - addAttribute
  - getAttributes
  - getIndex
  - getLevelName
  - setIndex
  - setLevelName
- Class actuate.xtabanalyzer.LevelAttribute
  - getName
  - setName
- Class actuate.xtabanalyzer.Measure
  - getAggregationFunction
  - getDataType
  - getExpression
  - getIndex
  - getMeasureName
  - getNewIndex
  - setAggregationFunction
  - setDataType
  - setExpression
  - setIndex
  - setMeasureName
  - setNewIndex
- Class actuate.xtabanalyzer.MemberValue
  - addMember
  - getLevelName
  - getMembers
  - getValue
  - setLevelName
  - setValue
- Class actuate.xtabanalyzer.Options
  - getColumnMirrorStartingLevel
  - getColumnPageBreakInterval
  - getEmptyCellValue
  - getEnablePageBreak
  - getMeasureDirection
  - getRowMirrorStartingLevel
  - getRowPageBreakInterval
  - setColumnMirrorStartingLevel
  - setColumnPageBreakInterval
  - setEmptyCellValue
  - setEnablePageBreak
  - setMeasureDirection
  - setRowMirrorStartingLevel
  - setRowPageBreakInterval
- Class actuate.xtabanalyzer.PageContent
  - getCrosstabByBookmark
  - getViewerId
- Class actuate.xtabanalyzer.ParameterValue
  - getName
  - getValue
  - getValueIsNull
  - setName
  - setValue
  - setValueIsNull
- Class actuate.xtabanalyzer.Sorter
  - getKey
  - getLevelName
  - getMember
  - isAscending
  - setAscending
  - setKey
  - setLevelName
  - setMember
- Class actuate.xtabanalyzer.SubTotal
  - addTotal
  - getLevelName
  - getLocation
  - getTotals
  - getType
  - setLevelName
  - setLocation
  - setTotals
- Class actuate.xtabanalyzer.Total
  - getAggregationFunction
  - getMeasureIndex
  - isEnabled
  - setAggregationFunction
  - setEnabled
  - setMeasureIndex
- Class actuate.xtabanalyzer.UIOptions
  - enableCrosstabView
  - enableCubeView
  - enableFilterSummaryView
  - enableToolBar
  - enableToolbarHelp
  - enableToolbarSave
  - enableToolbarSaveDesign
  - enableToolbarSaveDocument
  - getFeatureMap
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
- 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
- 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
Index

Navigation menu