Maximo Query Based Reports

[Paul Bappoo]

With Maximo it is possible to create a Query Based report within the
Maximo application itself. This is a good way to cerate a basic
listing or summary report, which can then be exported, modified and re-
imported


The full version of this report, including screen shots and source
code, in full colour pdf is available for free download at
http://www.BIRTReporting.com


INTRODUCTION
============

Creating and Modifying a Query Based Report

This guide is taken from our BIRT for Maximo Self Study Workbook,
which is by far the fastest and easiest low cost way to learn how to
create and modify reports for Maximo using BIRT. The full guide,
printed in full A4 size, with generous screen shots, step by step
instructions and plenty of exercises is available now from
http://www.birtreporting.com/BIRTTraining.html



CREATING A QUERY BASED REPORT
=============================

• Go to the application where you wish to create a report

In our example we are going to create a Query Based Report of purchase
orders, so we go to the Purchase Order application.

• Click the Create Report button on the toolbar

In the dialogue that appears it is possible to select either a summary
report or a detail report. For our example we are going to use a
detail report.

• Select detail report
• Enter a title for the report

When selecting a title for your report, make it something you will
recognize, perhaps by adding your name to the report title. You can
then select to make the report public (i.e. available to other users)
and you can elect to save the report.

• Check the Save Report box


Next we move on to selecting the fields that will appear in our
report.

• Click the Select tab

Notice that in the left hand pane, the list of tables associated with
the PO application are visible. Clicking on each one shows a list of
the available fields in the right hand pane.



If you scroll down, you will also notice that a number of fields have
been selected for you.



It is possible to remove fields from the selected list by clicking on
the upward pointing arrow and to add fields by clicking on the
downward pointing arrow.

• Remove the SITEID field
• Add the RECEIPTS field

TIP: to get to the site field you will need to page through the list
of available fields or filter it in the same way you do in any other
part of Maximo.


Now we move on to filtering, grouping and sorting.

• Click the Format tab

We wish to filter our report to only approved PO’s where receipts are
not yet complete.

• Click on the lookup selector to the right of the first two filtering
fields and select:

• Receipts
• Status


Now we are going to provide the filter values and execute our report

• Click on the Submit tab
• Enter “NONE” in the Receipts value field
• Enter “APPR” in the status value field
• Click Submit



Your report will be generated showing all Approved PO’s that have no
receipts.


Notice the rptdesign file name that Maximo has given your report, its
in the browser address bar. In this case it is:

po_maxadmin1292777291.rptdesign

Remember this, because now we are going to export the report file and
open it up in BIRT.


EXPORTING REPORTS FROM MAXIMO
=============================

To export reports from Maximo we need to use an external utility
exportreports.cmd, this is located in the following location:

<Product_root>\reports\birt\tools

There are four different commands to use this tool, as follows:


exportreports exports all libraries, reports, and various report
subfolders

exportreports report exports all reports and various report subfolders

exportreports library exports all libraries

exportreports app <application name> exports all reports for the
specified application

We are going to use the last option, to export all the reports for the
PO application (since that’s where we created our Query Based Report).

Before we run the command though, we need to ensure that it knows how
to log on to the application. The parameters for this are contained in
the reporttools.properties file, which is in the same location as the
exportreports utility.

• Open up the reporttools.properties file in a text editor
• Ensure the details are correct for your implementation, pay specific
attention to
• IP Address
• Port
• Username
• Password

• Open a command prompt and navigate to the <Product_root>\reports\birt
\tools folder

• Enter the command:- exportreports app po

You should see the utility export all the PO reports.



• Next navigate to the PO reports folder, this will be in a location
similar to:
• <Product_Root>\reports\birt\reports\PO
• Locate your rptdesign file
• Copy it to your BIRT workspace



Naturally, you can now make modifications to the report and import it
back into Maximo in the usual manner.