2010

Installing BIRT for Maximo

In this 2 part guide we present a step by step tutorial on how to install and configure BIRT for Maximo.

Paul Bappoo Paul@BirtReporting.com http://www.BirtReporting.com 2010

Installing BIRT for Maximo

CONTENTS
How To Contact The Author .......................................................................................................................... 4 Introduction ................................................................................................................................................. 5 Installing BIRT for MAximo............................................................................................................................ 6 Download ................................................................................................................................................. 6 Install V7 Design Files for BIRT 232 ............................................................................................................ 7 Accessing the BIRT Designer.................................................................................................................... 13 More Information ....................................................................................................................................... 17 BIRT For Maximo Training ........................................................................................................................... 17

Page | 2

Installing BIRT for Maximo

Paul Bappoo Installing BIRT for Maximo

COPYRIGHT 2009 by Paul Bappoo, all rights reserved.
This guide is furnished under license and may be used or copied only in accordance with the terms of such license. The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by the author. The author assumes no responsibility or liability for any errors or inaccuracies that may appear in this guide. Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, electronic, mechanical, recording or otherwise, without the prior written permission of the author. All product and company names are trademarks or registered trademarks of their respective holders.

Page | 3

Installing BIRT for Maximo

HOW TO CONTACT THE AUTHOR

Email: Paul@BirtReporting.com

Web Site: http://www.BirtReporting.com

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 BIRTExchange Advisory Council. He has an interest in BIRT reporting, enterprise application integration, automated software testing, computer based training and enterprise system implementation. He would be delighted to hear from you with your tips, tricks and stories about your usage of BIRT. If you have a great tip to share with the community drop him a line.

Page | 4

Installing BIRT for Maximo

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 Paul@BIRTReporting.com Join the mailing list at www.BIRTReporting.com to automatically receive the second part of this guide when it is published.

Page | 5

Installing BIRT for Maximo

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 http://www-01.ibm.com/software/brandcatalog/opal/details?catalog.label=1TW10OT07 Extract the BIRTDesigner232.zip file to a local directory which does not include any spaces (for example: C:\birt_232)

Page | 6

Installing BIRT for Maximo

INSTALL V7 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>\reports\birt\scriptlibrary\classes Navigate to the EclipseBIRT location below (this is where you just installed BIRT to) <birt_232>\eclipse\plugins\org.eclipse.birt.report.viewer_2.3.2.r232_20090212\birt\WEB-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>\eclipse\plugins\org.eclipse.birt.report.viewer_2.3.2.r232_20090212 \birt\WEB-INF\classes

Page | 7

Installing BIRT for Maximo

Maximo Server

Workstation

Page | 8

Installing BIRT for Maximo

Copy and paste the mxreportdatasources.properties using the same source and destination folders from the previous steps. Maximo Server Workstation

Page | 9

Installing BIRT for Maximo

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 Menu\Programs\IBM DB2\Set-up Tools\Configuration 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>\applications\maximo\lib to: eclipse\plugins\org.eclipse.birt.report.viewer_2.3.2.r232_20090212\birt\WEB-INF\lib These drivers are only used by the designer.

Page | 10

Installing BIRT for Maximo

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 Maximo Server Workstation

Open the specific JDBC driver Jar with WinZip for your specific database type and extract the contents of the jar file to <eclipse>\plugins\org.eclipse.birt.report.viewer_2.3.2.r232_20090212\birt\WEB-INF\classes

Page | 11

Installing BIRT for Maximo

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.

Page | 12

Installing BIRT for Maximo

ACCESSING THE BIRT DESIGNER

Create a shortcut to BIRT Designer 232 from eclipse.exe. Update the shortcuts target to include your JDK 1.5 install. This is done by modifying the path highlighted in red below. C:\eclipse_download\BIRT\eclipse\eclipse.exe -vm C:\Program Files\IBM\Java50\jre\bin\java.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.

Page | 13

Installing BIRT for Maximo

Scroll down to the Business Intelligence and Reporting Tools Location, and select Report Project. Click Next.

Page | 14

Installing BIRT for Maximo

Type in a project name and click Finish.

The BIRT Report designer within Eclipse SDK Displays.

Page | 15

Installing BIRT for Maximo

This has been part one of our guide to installing and configuring BIRT for Maximo. To receive your copy of part two automatically, get free membership to BIRTReporting.com, see below for details.

Page | 16

Installing BIRT for Maximo

MORE INFORMATION

This book, written by Paul Bappoo, the founder of the BIRT User Group UK presents an overview of the open source BIRT tools and the commercial enhancements available from Actuate, including... Eclipse BIRT Designer, Actuate BIRT Designer, iServer Express, Interactive BIRT viewer, Actuate BIRT Studio, BIRT Spreadsheet Designer With walkthrough tutorials of the main features, including screenshots, from installation through data selection to formatting reports and fully graphical Flash charting this book will have you creating your own reports from scratch in only a couple of hours. If you are too busy to spend days learning software and want tangible results fast then BIRT For Beginners is for you. When you buy the book you will automatically get access to the readers section of this web site which includes BIRT report request forms that you can distribute to your end users, extra chapters in PDF format and an ever growing library of reports, tutorials, reviews, tips & tricks.

Buy the book and get free membership of BIRT Reporting and the BIRT User Group UK at: http://www.BIRTReporting.com

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 cant guarantee to personally solve everyones 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. Paul Bappoo Paul@BirtReporting.com http://www.BIRTReporting.com

Page | 17