Installing BIRT for Maximo

BIRT is the default report writer for IBM's Maximo asset maintenance software from version 7 onwards. The BIRT implementation in Maximo is somewhat different to stand alone BIRT and this two part article guides you through installation and configuration of the BIRT software specifically for use with Maximo. 
 
To download the full PDF version of this article with screen shots please visit <a class='bbc_url' href='http://www.BIRTReporting.com'>BIRT Reporting Articles, News and Support</a> and sign up for your free membership. 
 
ARTICLE: 
 
 
INTRODUCTION 
 
This is part one of our two part guide to installing and configuring BIRT for Maximo. In this guide I look at how to install BIRT in the Maximo environment with easy to follow, step by step instructions, including screen shots. 
 
This guide has been taken from our 2 day, dedicated, BIRT for Maximo training course which can be delivered on your premises anywhere in the world, to have your team up and running with BIRT in a Maximo environment quickly, easily and at low cost. 
 
If you would like further information about our training courses please contact <a href='mailto:' title='E-mail Link' class='bbc_email'>Paul@BIRTReporting.com</a> 
 
Join the mailing list at <a class='bbc_url' href='http://www.BIRTReporting.com'>BIRT Reporting Articles, News and Support</a> to automatically receive the second part of this guide when it is published. 
 
INSTALLING BIRT FOR MAXIMO 
 
DOWNLOAD 
 
To create or customize BIRT reports, you must have both Eclipse and the BIRT Report Designer downloaded on your client machine. They are both installed from the all in one package available from 
<a class='bbc_url' href='http://www-01.ibm.com/software/brandcatalog/opal/details?catalog.label=1TW10OT07'>IBM - BIRT Report Designer V2.3.2</a> 
 
Extract the BIRTDesigner232.zip file to a local directory which does not include any spaces (for example: C:birt_232) 
 
INSTALL DESIGN FILES FOR BIRT 232 
 
Prerequisites: 
 
To perform the next steps, you will need a local copy of V7.1.1.5 or higher, with 
the report source. 
 
Either JDK 1.5 or 1.6 can be used with BIRT Designer 232. However, JDK 1.5 is recommended as it corresponds to the current version supported by Maximo. 
 
Locate the compiled classes used for the V7 Report Scripting from your local copy of V7.1.1.5 or higher as shown below. 
 
<V7115>reportsbirtscriptlibraryclasses 
 
Navigate to the EclipseBIRT location below (this is where you just installed BIRT to) 
 
<birt_232>eclipsepluginsorg.eclipse.birt.report.viewer_2.3.2.r232_20090212birtWEB-INF 
 
Create a classes folder 
 
Copy the entire V7 com folder from step Maximo classes folder to the new classes folder you just created 
 
<birt_232>eclipsepluginsorg.eclipse.birt.report.viewer_2.3.2.r232_20090212 birtWEB-INFclasses 
 
 
Copy and paste the mxreportdatasources.properties using the same source and destination folders from the previous steps. 
 
Open the copied mxdatasources.properties file, and edit if for your local configuration by: 
 
a) Setting the URL, driver, username, password, and schemaowner properties for your local environment. 
 
b) Change #<DataSourceName> to maximoDataSource. 
 
This file is shown below, including a sample update for a DB2 Database: 
 
#<DataSourceName>.<propertyName>=value 
# driver for ORACLE 
# oracle.jdbc.driver.OracleDriver 
# sample url for ORACLE 
# jdbc:oracle:thin:@<HOST>:<PORT>:<SID> 
# driver for SQLServer 
# com.inet.tds.TdsDriver 
# sample url for SQLServer 
# jdbc:inetdae7a:hostname:port?database=dbname&language=us_english&nowarnings=true 
# driver for DB2 
# com.ibm.db2.jcc.DB2Driver 
# sample url for DB2 
# jdbc:db2://localhost:50000/dbalias 
maximoDataSource.url=jdbc:db2://MX7DB2:50000/MX7DB2 
maximoDataSource.driver=com.ibm.db2.jcc.DB2Driver 
maximoDataSource.username=maximo 
maximoDataSource.password=maximo 
 
The values in red point to a sample local database. You can check yours and other available for you to choose from Start MenuProgramsIBM DB2Set-up ToolsConfiguration Assistant. 
The key name in green is the default set for all reports, you have to use exactly this text. 
 
Note: 
The mxdatasources.properties file is only used by a report developer when he is creating 
reports within the BIRT Report Designer. When V7 Reports are executed from within the V7 
Applications, their connection information will be passed dynamically from V7. 
Separate database username and passwords can be set up for each individual report developer 
to restrict their database access if required 
 
Copy the specific JDBC driver for your Database Type from 
 
<V7115>applicationsmaximolib 
 
to: 
 
eclipsepluginsorg.eclipse.birt.report.viewer_2.3.2.r232_20090212birtWEB-INFlib 
 
These drivers are only used by the designer. 
 
Note: 
For Oracle, copy/paste oraclethin.jar 
For SQL Server, copy/paste opta.jar 
For DB2, copy/paste db2jcc.jar and db2jcc_license_cu.jar 
 
Open the specific JDBC driver Jar with WinZip for your specific database type and extract the contents of the jar file to 
 
<eclipse>pluginsorg.eclipse.birt.report.viewer_2.3.2.r232_20090212birtWEB-INFclasses 
 
Note: If you see an exception error like ‘ClassNotFound’ in BIRT Designer 
after following these steps, double check that you have extracted the jar files 
properly. Not extracting the jar files will cause a ‘ClassNotFound’ Error. 
 
ACCESSING THE BIRT DESIGNER 
 
Create a shortcut to BIRT Designer 232 from eclipse.exe. 
 
Update the shortcut’s target to include your JDK 1.5 install. This is done by modifying the path highlighted in red below. 
 
C:eclipse_downloadBIRTeclipseeclipse.exe -vm “C:Program FilesIBMJava50jrebinjava.exe” –vmargs –Xmx512m 
 
Launch the BIRT Designer 232 from your new shortcut. 
 
Select an applicable workspace location for your environment. Check ‘Use this as default’ field and OK. Create a folder during or before this process. 
 
Eclipse SDK Opens. 
 
From the menu, select File – New – Project. 
 
Scroll down to the Business Intelligence and Reporting Tools Location, and select Report Project. Click Next. 
 
Type in a project name and click Finish. 
 
The BIRT Report designer within Eclipse SDK Displays. 
 
MORE INFORMATION 
 
BIRT FOR MAXIMO TRAINING 
 
If you are interested in further details of our 2 day dedicated BIRT for Maximo training course please drop me an email. Our course can be delivered anywhere in the world, on your premises or in dedicated training centres and is designed to have your team up and running with BIRT in a Maximo environment, quickly, easily and at low cost. 
 
I look forward to your feedback so please feel free to send me an email and let me know how you get on with BIRT, provide feedback on this guide, share your tips and tricks, or request help for specific problems. I can’t guarantee to personally solve everyone’s problems but there are some great BIRT related forums out there and you can find a growing list of links and resources on my site. 
 
HOW TO CONTACT THE AUTHOR 
 
Email: <a href='mailto:' title='E-mail Link' class='bbc_email'>Paul@BirtReporting.com</a> 
Web Site: <a class='bbc_url' href='http://www.BirtReporting.com'>BIRT Reporting Articles, News and Support</a> 
 
 
Paul Bappoo is the author of BIRT for Beginners (which is available now in paperback from BIRTReporting.com) and has been an international technical software consultant and involved with computers for over 30 years. Paul runs the BIRT UK User Group and is a member of the Actuate BIRT-Exchange Advisory Council. He has an interest in BIRT reporting, enterprise application integration, automated software testing, computer based training and enterprise system implementation.

Find more posts tagged with

Comments

mwilliams

Hi Paul,

Have you put this in the devShare? It would be something good to have in there as well!