BIRT Report Module Upgrade Guide

Owned by Former user (Deleted)
Last updated: Jan 03, 2017 by Hillary Bagiire
2 min read

Compatibility

  • BIRT Report Module 2.0.0-dev requires BIRT Runtime 2.3.1
  • BIRT Report Module 1.5 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.4 requires BIRT Runtime 2.2.1.1 (can be compiled from source)
  • BIRT Report Module 1.3 requires BIRT Runtime 2.2.1 (can be compiled from source)
  • BIRT Report Module 1.2 requires BIRT Runtime 2.2.0
  • BIRT Report Module 1.1 requires BIRT Runtime 2.2.0 (can be compiled from source)
  • BIRT Report Module 0.6 requires BIRT Runtime 2.2.0
  • BIRT Report Module 0.3 requires BIRT Runtime 2.2.0 (can be compiled from source)
  • BIRT Report Module 0.2 requires BIRT Runtime 2.2.0

Upgrade Instructions

Upgrade BIRT RCP Desginer

  1. Download the latest BIRT RCP Designer (click RCP Designer button).
  2. Extract the BIRT RCP Designer Engine to your local file system (i.e. c:/birt-rcp-report-designer-2_2_2)

Upgrade BIRT Runtime Engine

  1. Download the latest compatible BIRT Runtime Engine (click Runtime button).
  2. Extract the BIRT Runtime Engine to your local file system (i.e. c:/birt-runtime-2_2_2)
  3. Make a note of the path to the BIRT Runtime Engine (it will be used later)

Upgrade BIRT Report Module to OpenMRS

Update Settings (formerly Global Properties from 1.8 downwards)

Assuming you are logged in as an Administrator:

  1. Navigate to Administration > Manage Global Properties
  2. Change the 'birt.birtHome' to point to the latest BIRT Runtime Engine
    • For example, to upgrade to BIRT Runtime 2.2.2, set 'birt.birtHome' equal to 'C:/birt-runtime-2_2_2/ReportEngine', assuming you extracted the latest BIRT Runtime to the root of your filesystem.
  3. Click Save at the bottom of the page.
  • birt.birtHome
    Specifies the absolute path to the BIRT Report Engine. Must include ReportEngine subdirectory.
    Example: C:/Java/birt-runtime-2_2_2/ReportEngine

IMPORTANT: The Setting (formerly Global Property from 1.8 downwards) MUST be modified BEFORE the module can be installed, otherwise errors WILL occur!!

Upgrade BIRT Report Module

Assuming you are logged in as an Administrator:

  1. Download the latest BIRT Report Module (click the Download button).
  2. Navigate to Administration > Manage Modules
  3. Browse for .omod file that you downloaded
  4. Click the Add Module button

Start BIRT Report Module

Assuming you are logged in as an Administrator:

  1. Naviagate to the Administration > Manage Modules
  2. Click the green arrow next to the BIRT Report Module