BIRT Developer Center Download

BIRT iHub 3.1 Documentation


The documentation for our software is available online, in HTML and PDF formats. Click the links below to browse the documentation organized by functionality, tools, and APIs.

Features View
Designing BIRT applications
  • These resources provide information about using the Actuate BIRT Designer Professional report design tool. They explain how to design, configure, customize, and deploy applications, gadgets, and reports.
HTML
Visualization Platform
  • iHub Visualization Platform provides a central repository for your organization's reports. Reports can be viewed and modified, shared with other users, scheduled for generation once or on a recurring basis, exported to other formats including Excel, and integrated with web applications using a JavaScript API.
HTML
Interactive Viewer
  • Interactive Viewer enables report customization without requiring technical understanding of underlying data structures. Report users can access, personalize and customize their BIRT content within moments of being introduced to the intuitive interface. One report design serves many users because it does not need to conform to just one structure, reducing developer workload. Running a single, multi-purpose report reduces system load, empowers users, and increases their satisfaction. Interactive Viewer supports adding hyperlinks, computed values, modifying charts, graphs, and gadgets, sorting, filtering, and grouping data.
HTML
System Console
  • System Console monitors a range of activities, conditions, and resources in an iHub System. iHub System Administration Guide provides information about iHub architecture, and system administration using iHub utilities.
HTML
Managing volumes and users
  • Managing Volumes and Users discusses how to administer an iHub System volume and how to create and use user groups, which apply a set of privileges to a group of users, and provides information about administrative best practices, capabilities, and tasks.
HTML
Dashboards
  • Create easily personalized and shared dashboards and metrics management scorecards to give executives visibility into top-level goals and objectives. Using content such as data feeds, supplied gadgets from Actuate, or Google Gadgets™, managers analyze and optimize business processes. iHub hosts dashboard types that support visual data exploration and on-the-fly analytic capabilities using filters and slicers. Metrics management gadgets support interacting with or drilling down into data and individual KPIs, to answer complex strategic, operational, and tactical business questions.
HTML
Interactive Crosstabs
  • Use Interactive Crosstabs to analyze any BIRT cross tab in a report or in a gadget on a dashboard. Add, remove, reorganize, and customize the crosstab data to examine relationships and trends. Drill down to view detail data or drill up to view summary data. Filter, group, slice, sort, and pivot the crosstab to answer business questions. For enhanced data visualization, view the crosstab as a chart to view trends such as a product's sales over time or geography.
HTML
Report Studio
  • Report Studio provides a browser user interface for creating, modifying, and viewing BIRT content without requiring technical understanding of underlying data structures. Using data sources designed and provided by data architects, business users can create dynamic data visualizations and business reports without relying on IT. Use Report Studio to create insightful ad hoc reports when you need to find instant answers to specific business questions. Report Studio includes a set of templates to start many types of report designs. Administrators add to this set by developing more templates using BIRT Designer Professional and uploading them to iHub.
HTML
REST API
  • The representational state transfer API (REST API) uses HTTP methods and URLs to access and manage BIRT content on an iHub server. Use this API to manage and generate documents, and to request data in the JSON format.
HTML
Integration
  • Provides information about integrating applications using Actuate APIs and URIs into iHub. The APIs include client-side programming using Actuate JavaScript API and server-side programming using the XML-based Actuate Information Delivery API. The REST API deliver BIRT content and data from iHub to any mobile or web application.
HTML
BIRT Deployment Kit Java Component
  • BIRT Deployment Kit Java Component provides a light-weight file and folder browser for deploying and viewing your organization's reports. Reports can be viewed, exported to other formats including Excel, and integrated with other web applications using a JavaScript API. BIRT Deployment Kit optimizes report viewing and interactivity.
HTML
BIRT Viewer Java Components
  • Use BIRT Viewer to view BIRT reports containing rich, dynamic content. Use BIRT Interactive Viewer to customize and personalize BIRT reports to answer ad hoc business questions.
HTML
Report Studio Java Component
  • Use Report Studio Java Component to design BIRT reports. This rich, browser based tool gives business users access to predefined data structures and report templates to build new reports.
HTML
Interactive Crosstabs in Java Components
  • You can view, modify, or create a crosstab report using Interactive Crosstabs. A crosstab report displays summary information in rows and columns. Drill down to view detail information or drill up to see summary totals.
HTML

Click the links below to browse the latest version of the manuals.

Documents View
Installing iHub on Linux
  • Installing iHub modules on Linux.
HTML PDF
Installing iHub on Windows
  • Installing iHub modules on Windows.
HTML PDF
Installing Multiple Modules on Windows Platforms
  • Installing Multiple Modules on Windows Platforms.
HTML PDF
Installing Multiple Modules on Linux Platforms
  • Installing Multiple Modules on Linux Platforms.
HTML PDF
Installing Metrics Management
  • Installing Metrics Management.
HTML PDF
Installing Information Console
  • Installing a stand-alone Information Console. Configuring Information Console, BIRT Viewers, and Report Studio.
HTML PDF
Installing Actuate BIRT Designer Professional
  • Installing BIRT Designer Professional on Windows and MacOS.
HTML PDF
Installing and Deploying Eclipse BIRT
  • Installing Eclipse BIRT Report Designer and individual Eclipse BIRT modules on Windows. Deploying BIRT reports to application servers.
HTML PDF
iHub System Administration Guide
  • Configuring an iHub cluster. Setting up a new RDBMS. Using System console. Backing up the metadata RDBMS.
HTML PDF
Managing Volumes and Users
  • Managing volume-level operations. Setting up users and groups. Advanced job schedules.
HTML PDF
Integrating Applications into iHub
  • Using Actuate APIs, including Information Delivery API (IDAPI), JavaScript API, Report Server Security Extension (RSSE). Accessing BIRT Viewer and Report Studio using URIs. Using logging, performance monitoring, and archiving features. Customizing the Actuate software installation process.
HTML PDF
Using Information Console
  • Using iHub Information Console to access, create, and run files stored in an iHub volume. Also using dashboards to view and organize reports and other gadgets.
HTML PDF
Using Report Studio
  • Using Report Studio to design a report, including accessing data, using a template, creating tables, cross tabs, and charts. Refining the report design by formatting the components of the report and performing calculations on data values.
HTML PDF
Actuate BIRT Application Developer Guide
  • Using BIRT Designer Professional to create customer-facing applications, mashups, and dashboards. Designing, configuring, and customizingapplications, gadgets, and reports, and deploying them to an iHub server. Using JavaScript or Java to write event handlers.
HTML PDF
Provisioning Data
  • Accessing data from JDBC, NoSQL, file-based, and web services data sources for use with BIRT applications.
HTML PDF
Designing BIRT Information Objects
  • Provides information about creating information objects and publishing them to an iHub volume.
HTML PDF
Building Web Applications Using BIRT APIs
  • Provides information about using the Actuate REST API in web browser-based applications.
HTML PDF
Building Mobile Applications Using BIRT APIs
  • Provides information about using the Actuate REST API in software applications for mobile devices.
HTML PDF
Actuate API Reference
  • Provides a complete reference to all Actuate APIs.
HTML PDF
Actuate BIRT Java Components Developer Guide
  • Designing, deploying, and accessing custom reporting web applications using Actuate BIRT Java Components. Configuring Java Components applications.
HTML PDF
Installing an Actuate BIRT Java Component
  • Installing Actuate BIRT Java Components by deploying to an application server. Configuring Java Components using web application parameters.
HTML PDF
Using BIRT Studio – Java Component Edition
  • Using Report Studio Java Component to design a report, including accessing data, using a template, creating tables, cross tabs, and charts. Refining the report design by formatting the components of the report and performing calculations on data values.
HTML PDF
Using an Actuate BIRT Java Component
  • Using Actuate BIRT Java Components to access, create, and run files stored in a file system repository. Using Actuate BIRT Viewers to view, navigate, and export data from report files. Using Interactive Viewer to change the appearance and structure of a report document and filter the contents of the document.
HTML PDF
Actuate Glossary
  • Actuate Glossary provides definitions of terms used in Actuate software and documentation.
HTML PDF

Additional Resources Action
Technical Summary of New Features View PDF
BIRT: A Field Guide (3rd Edition) book Purchase
Integrating and Extending BIRT (3rd Edition) book Purchase