maximo integration for bo crystal reports xi 60v4 mx crystal

Release 6.0December 2005

Maximo Integration forBusinessObjects Crystal Reports XI

This document and its publication do not constitute or create a contract. MRO Software, Inc. makes no warranties, express or implied, as to the accuracy or completeness of this document or with respect to the related software.

© 2005 MRO Software, Inc. All rights reserved. This document contains confidential and trade secret information of MRO Software, Inc. Use, transfer, disclosure, or copying without MRO Software, Inc.'s express written permission is strictly forbidden.

Patents: United States Patent Nos. 6,324,522 B2, 6,519,588 B1, and Aust. Pat. No. 758001. Multiple foreign patents pending.

U.S. Restricted Rights: If Customer is a government agency, Customer acknowledges and agrees that the Licensed Software is provided with RESTRICTED RIGHTS. Subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at 252.227-7013 of the Department of Defense FAR Supplement and FAR clause 52.227-19 entitled Commercial Computer Software Restricted Rights, apply and use, duplication, or disclosure by the Government is subject to restrictions as set forth in this Agreement. The aforementioned restrictions shall prevail over any similar "Rights" provisions under the laws of any country. Contractor/Manufacturer: MRO Software, Inc., 100 Crosby Drive, Bedford, MA 01730, U.S.A.

Trademarks: Maximo® is a registered trademark of MRO Software, Inc. The following table contains a list of MRO Software's trademarks and service marks:

IBM® and WebSphere® are registered trademarks of IBM Corporation. WebLogic® is a registered trademark of BEA Systems, Inc. Broadvision® and related marks are registered trademarks or trademarks of Broadvision, Inc. webMethods® is a registered trademark of webMethods, Inc. Snowbound™ and RasterMaster™ are trademarks of Snowbound Software Corporation. Syclo® and Agentry® are registered trademarks of Syclo, LLC. Business Objects™ is a trademark and Crystal Reports® is a registered trademark of Business Objects, S.A.

Other products and brand names are trademarks or registered trademarks of their respective companies.

Third-Party Technology: Certain MRO Software, Inc. products contain technology provided under license from third parties, as noted in the following table:

Open Source: Maximo contains computer software obtained from the public domain, known as "Open Source." A complete listing of all Open Source contained in Maximo may be viewed at http://www.mro.com/support/opensource, ownership of which is attributed as follows: Portions © 2005, International Business Machines Corporation and others. Portions © 2002, Steve Souza ([email protected]). Portions © 2000 by Jef Poskanzer ([email protected]). Portions © 2000-2004 Jason Hunter & Brett McLaughlin. Portions © 2004-2005, The Apache Software Foundation (http://www.apache.org/). All Rights Reserved.

Maximo® Enterprise

Maximo® Enterprise/SP

Maximo® Enterprise IT

Maximo® Asset Center

Maximo® Service Center

Maximo® Discovery

Maximo® Enterprise IT/SP

Maximo® SLA Manager

Maximo® Navigator

Maximo® Project Manager

Maximo® Calibration

Maximo® Enterprise Adapter

Maximo® Fusion

Maximo® OCS

Maximo® Mobile Suite

Maximo® Mobile Auditor

Maximo® Mobile Inventory Manager

Maximo® Mobile Work Manager

Maximo® Mobile Calibration

MRO Software Products Third-Party Information

Maximo Portions © 1995-2004 Actuate Corporation. Portions © 2003 BEA Systems, Inc. BEA WebLogic® Server™ provided by BEA Systems, Inc. Portions © 1996-2004 IBM Corporation. IBM® WebSphere® provided by IBM Corporation. Portions © 1996-2005, i-net software GmbH.

All Products Portions © 1996-2003 Visual Mining, Inc. Visual Mining™ NetCharts Server™ provided by Visual Mining, Inc.

Maximo® Discovery ©1988-2004 Centennial Software Limited. MSDE © Microsoft Corporation.

Maximo Navigator Portions © 1993-2002 Snowbound Software Corporation. RasterMaster™ Raster imaging technology provided by Snowbound Software Corporation. Portions © 1989-1998 Cimmetry Systems, Inc.

Maximo Mobile Suite Portions © 2002-2003 Syclo LLC.

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vChapter and Appendix Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viRelated Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Chapter 1: Integration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Crystal Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1BusinessObjects XI Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Hardware and Software Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Configuring the Maximo Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Configuring the Maximo Network with a BO Enterprise Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Configuring the Maximo Network with a BO Enterprise Server and an Actuate Server . . . . . . . . . 1-4

Chapter 2: Integrating Maximo to work with Crystal Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Building and Deploying bocrystal.war . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

1. Copy BusinessObjects Enterprise Server files to your Maximo Server . . . . . . . . . . . . . . . . . . . . . 2-22. Build bocrystal.war . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33. Deploy bocrystal.war . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

Maintaining your BusinessObjects Enterprise Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Chapter 3: Running Crystal Reports in Maximo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Signing in to Crystal Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Opening Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Crystal Reports included with Maximo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Using the Run Report Subtab in the Business Analysis and Reporting Dialog Box . . . . . . . . . . . . . . . . 3-3Using the Request Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4Running Reports with Current/Selected/All Records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

Current Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Selected Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7

Using the Table Filter to Select Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Using the Select Records Check Box to Select Records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7

All Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

Chapter 4: Administering Reports in Maximo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Report Developer/Administrator Actions Flowchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Accessing the Report Administration Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Adding a New Crystal Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Using the Detail Check Box for Detail Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Adding Bound Parameters to Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Determining your Parameter’s Attribute Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Storing Parameter-Based Reports in Multiple Maximo Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Duplicating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Deleting a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

Deleting Existing Actuate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16Deleting Actuate Reports Individually through the Report Administration Application. . . . . 4-16Deleting All Actuate Reports by running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

Chapter 5: Adding Reports to Central Management Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Report Developer /Administrator Actions Flowchart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Release 6.0, 12/2005 iii

Contents

Creating your Report Folder Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Adding a New Crystal Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Setting Security Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10

Chapter 6: Creating Maximo Reports in Crystal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Using Command Tables to Create Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Enabling Crystal SubReports for Maximo Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11

Appendix A: Maximo.Properties File Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Appendix B: Additional Maximo.Properties File Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1MXES-Business Objects Integration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2

Appendix C: Reporting Features not supported in Maximo Integration for BusinessObjects Crystal Reports XI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

iv Release 6.0, 12/2005

About This Guide

With the release of Maximo® 5, MRO SoftwareTM announced the integration of Actuate® as its embedded Maximo reporting tool. Since then, MRO Software has released MXES and continues its testing and support of Actuate as the Maximo reporting tool.

However, as an existing customer of Maximo Release 4.1.1 or an earlier Maximo version, you may have invested resources in the creation and use of reports written using Crystal.

MRO Software recognizes the investment you may have made in Crystal and wants to help you upgrade to MXES so you can take advantage of all the features this release has to offer you. Because of this, MRO Software has developed an MXES Crystal integration program for your Crystal reports.

The MXES integration program lets you use Crystal Reports® as your reporting tool. MRO Software provides you with this Maximo Integration for BusinessObjects Crystal Reports XI to assist you in your integration of your Crystal reports with MXES. For information on using Actuate, refer to the Maximo Report Administration and Development Guide.

This guide assumes you already have a working knowledge of BusinessObjectsTM XI and its components.

This section contains the following information:

a list of chapter and appendix names, each with a brief description

a list and description of related Maximo documentation

instructions on obtaining online customer support

NOTE For information about Maximo features not available with Crystal reports, see Appendix C, “Reporting Features not supported in Maximo Integration for BusinessObjects Crystal Reports XI.”

Release 6.0, 12/2005 v

Chapter and Appendix Descriptions

The following table briefly describes the contents of each chapter and appendix.

Report Administration Guide Chapter and Appendix Descriptions Table

Chapter / Appendix Contents

Chapter 1, “Integration Overview” Hardware and software considerationSample configurations for BusinessObjects Enterprise Server with and without Actuate server

Chapter 2, “Integrating Maximo to work with Crystal Reports”

Building and deploying the bocrystal.war file to integrate Maximo to work with Crystal

Chapter 3, “Running Crystal Reports in Maximo”

Signing in to reportsOpening reportsUsing the request page to run reportsRunning current/selected/all reportsRunning parameter-based reports

Chapter 4, “Administering Reports in Maximo”

Adding a new Crystal report using the Report Administration applicationUsing the Detail check box, generating and previewing a request page, and deleting a report

Chapter 5, “Adding Reports to Central Management Console”

Creating a report structureAdding a new reportSetting security

Chapter 6, “Creating Maximo Reports in Crystal”

How to write Maximo reports in Crystal

Appendix A, “Maximo.Properties File Descriptions.”

A listing and description of database properties in the MAXIMO.PROPERTIES file

Appendix B, “Additional Maximo.Properties File Descriptions.”

A listing and description of MXES-Business Objects Integration properties in the ADDITIONALMAXIMO. PROPERTIES file

Appendix C, “Reporting Features not supported in Maximo Integration for BusinessObjects Crystal Reports XI.”

A listing and description of Maximo features available only to Actuate report users.

If you see a report feature in Maximo that is not documented in this guide, be sure to refer to this section as that feature might be available to only Actuate users.

Chapter and Appendix Descriptions

vi Release 6.0, 12/2005

About This Guide

Related Documentation

For more information about Maximo Enterprise Suite, refer to the Maximo online help and in the following documents:

Related Maximo Documentation Table

Support

MRO Software, Inc. users with a valid Annual Customer Support Plan (ACSP) can obtain product support online at http://support.mro.com.

The Support Web site includes information about product releases, software patches, and documentation updates. To find the most current version of a document, refer to the Support Web site’s Knowledge Base.

Document Description

Maximo Enterprise SuiteUser’s Guide

Explains Maximo features and describes relationships among modules

Maximo Enterprise SuiteSystem Administrator’s Guide

Explains how to customize the system, manage the database, and use Maximo utilities

Maximo Enterprise Suite Installation Guide

Explains how to install and configure Maximo and work with application servers

Release 6.0, 12/2005 vii

http://support.mro.com

Support

viii Release 6.0, 12/2005

This chapter provides an overview of the following integration topics that you should consider as you prepare to integrate Maximo with Crystal reports:

Crystal Licensing

BusinessObjects XI components

Hardware and Software Considerations

Configuring the Maximo Network

Crystal Licensing

MRO Software does not provide you with any Business Objects or Crystal licenses and does not support any specific Crystal issues. You must purchase and maintain your Crystal license separately with Business Objects.

MRO Software developed the Maximo integration with Crystal by using a Processor based license. Therefore, all Crystal reports that you run through Maximo integration execute against a single, named user account. If you encounter any integration licensing conflicts, you must resolve the issue separately with Business Objects.

BusinessObjects XI Components

You must have access to the following components to enable Crystal reports in Maximo:

BusinessObjects Enterprise server! Central Management Console (CMC)! Web Component Adapter

Crystal Reports XI

Integration Overview 1

Release 6.0, 12/2005 1-1



For best performance, MRO Software recommends that your configuration contains the following dedicated servers:

Maximo application server. You must be running MXES, Patch 3 to enable Maximo integration for BusinessObjects Crystal Reports XI.

BusinessObjects Enterprise server

database server

When you integrate Maximo to run with Crystal Reports, you are responsible for using products BusinessObjects supports. The specific product platforms that Crystal runs on can vary from those of MXES.

MRO Software used Business Objects Enterprise XI, Service Pack 1 to develop and test MXES-Crystal integration.

1-2 Release 6.0, 12/2005

Chapter 1: Integration Overview


This section shows examples of two types of network configurations: one with a BO (BusinessObjects) Enterprise server and one with both a BO Enterprise server and an Actuate server. Depending on whether you use Actuate, you can set up either type of configuration.

Configuring the Maximo Network with a BO Enterprise Server

The Network Configuration depicted in the following figure drawing is an example of a BO Enterprise Server setup. Your setup can vary depending on your individual implementation requirements.

Maximo Network Configuration with BO Enterprise Server

Client Side

Server Side

Client Machine withInternet Explorer 6.0

Maximo ApplicationServer Components

Maximo ApplicationsMaximo BusinessComponents

BO Enterprise Serverwith bocrystal.war

Report Developer'sMachine with CrystalReports, version XI

Oracle orSQL SeverDatabase

Release 6.0, 06/2005 1-3


Configuring the Maximo Network with a BO Enterprise Server and an Actuate Server

The network configuration depicted in the following figure is an example of a setup that includes a BO Enterprise server and an Actuate server. You might use this type of setup if you plan to maintain your existing customized reports in Crystal and use Actuate to run the reports MRO software shipped to you with MXES.

Your setup can vary depending on your individual implementation requirements.

Maximo Network Configuration with BO Enterprise Server and Actuate Server

Client Side

Server Side

Client Machine withInternet Explorer 6.0

Maximo ApplicationServer

maximo.earmaximohelp.earacweb.ear

BO EnterpriseServer withbocrystal.war

Report Developer'sMachine with CrystalReports, version XI

Oracle orSQL ServerDatabase

Report Developer'sMachine with e.Report

Designer and/or e.ReportDesigner Professional

Actuate Server

1-4 Release 6.0, 12/2005

This chapter describes how to integrate Maximo to work with Crystal through the BO Crystal Web Application (bocrystal.war) and how to maintain your BusinessObjects Enterprise Server.

NOTE You must edit the properties in the ADDITIONALMAXIMO.PROPERTIES file to successfully complete the integration. For additional information, see Appendix B: “Additional Maximo.Properties File Descriptions.”

The BO Crystal application directory contains the following folders:

Building and Deploying bocrystal.war

To integrate Maximo to work with Crystal Reports, complete the following sections in order:

1 Copy BusinessObjects Enterprise server files to your Maximo server

2 Build bocrystal.war

3 Deploy bocrystal.war

Integrating Maximo to work with Crystal Reports 2

Folder Name Contents

(main level directory)

jsp files including error.jsp, interactiveViewer.jsp, runBOCrystalReport.jsp, and utilities.jsp

bofiles Folder you use to copy files from your BusinessObjects Enterprise application.

META-INF information about Manifest and Apache software versions

Properties Maximo error messages you may see when using Crystal.

Reports sample Purchase Order List (po.rpt) and Purchase Order Details List (poprint.rpt) reports for Oracle and SQL Server

WEB-INF web.xml file and class files

Release 6.0, 12/2005 2-1

Building and Deploying bocrystal.war

1. Copy BusinessObjects Enterprise Server files to your Maximo Server

Complete the instructions in this section to copy your BusinessObjects Enterprise server files to your Maximo server.

1 On your BusinessObjects Enterprise server, go to the location where you installed BusinessObjects Enterprise. If you chose the default location, BusinessObjects Enterprise is located in the following directory:

Program Files\Common Files\Business Objects directory

2 Copy the following folder:

<BusinessObjects Enterprise Root>\3.0\java\lib

3 Paste the lib folder to the following location on your Maximo Application server:

<Maximo root>\maximo\applications\bocrystal\bofiles

Maximo Application Server with lib folder

4 Return to your BusinessObjects Enterprise server and copy the following folder:

< BusinessObjects Enterprise Root>\3.0\crystalreportviewers11

NOTE If your Maximo Application server has disk space or network limitations, you can omit the following two subfolders when you copy the crystalreportviewers11 folder:

javapluginoffline

5 Paste the crystalreportviewers11 folder to the following location on the Maximo Application server:

<Maximo root>\maximo\applications\bocrystal\bofiles

2-2 Release 6.0, 12/2005

Chapter 2: Integrating Maximo to work with Crystal Reports

Maximo Application Server with crystalreportviewers11 folder

2. Build bocrystal.war

Complete the instructions in the following section to build your bocrystal.war file.

1 On your Maximo Application server, open a command prompt.

2 Change the directory to the following location:

<Maximo root>\maximo\deployment

3 Type buildbocrystalwar.cmd and press Enter. After Maximo successfully completes the command, you can close the command prompt window.

3. Deploy bocrystal.war

You must deploy the bocrystal.war file on the BusinessObjects Enterprise Application server. To deploy the file, consult you application server documentation. The bocrystal.war file resides in the following location:

<Maximo Root>\maximo\deployment\default

Release 6.0, 12/2005 2-3

Maintaining your BusinessObjects Enterprise Server

Maintaining your BusinessObjects Enterprise Server

If you update your BusinessObjects Enterprise server, you must repeat the steps described in this chapter so that the server and the bocrystal.war file remain at the same revision level.

2-4 Release 6.0, 12/2005

This chapter covers the following topics that describe how to run Crystal reports in Maximo:

signing in to reports

opening reports

using the Run Report subtab in the Business Analysis and Reporting Page

using the Request Page

running reports with Current/Selected/All records

Signing in to Crystal Reports

To access Crystal reports, sign in to Maximo using your Maximo username and password. When you run a Crystal report in Maximo, you are silently authenticated to the BusinessObjects Enterprise server and the database.

Opening Reports

You can access the report functions in Maximo in both of the following ways:

From the Navigation Bar on the Start Center, select Reports to open the list of Maximo applications containing reports. You see all Crystal reports registered by your Report Administrator and any Actuate reports your System Administrator enables.

Selecting Reports on Navigation Bar

Running Crystal Reports in Maximo 3

Release 6.0, 12/2005 3-1

Crystal Reports included with Maximo

From the Select Action menu of any Maximo application containing reports, select Run Reports to open the Business Analysis and Reporting dialog box.

Selecting Run Reports on Select Action Menu from Purchase Order Application

Crystal Reports included with Maximo

MRO Software includes the following Crystal reports with Maximo:

Purchase Order List Report

Purchase Order Details Report

NOTE For these reports to be available to your end users in your Maximo database, you must register them in both of the following locations:

the Maximo Report Administration application – see “Adding a New Crystal Report” on page 4-4.

the CMC – see “Adding a New Crystal Report” on page 5-6.

3-2 Release 6.0, 12/2005

Chapter 3: Running Crystal Reports in Maximo

Using the Run Report Subtab in the Business Analysis and Reporting Dialog Box

You can access Crystal reports from the Run Report subtab. Click a Crystal report to bring up its request page (for information on request pages, see “Using the Request Page” on page 3-4).

The following figure shows how your Report Developer/Administrator may want to add Crystal to the description of your Crystal reports to distinguish them from Actuate reports with the same name.

Reports Tab (Purchase Order Application)

Release 6.0, 12/2005 3-3

Using the Request Page

Using the Request Page

The following section describes how to run a report using the Run Report tab on the Request Page.

1 To open a report’s request page, click the Report File Name on the List tab.

NOTE If necessary, type a parameter.

2 To run the report, click Submit.

The following figures show examples of a request page (without and with a parameter) for the Purchase Order List – Crystal report.

Request Page for Purchase Order List - Crystal Report (no parameters)

Request Page for Purchase Order List - Crystal Report (with parameter)

3-4 Release 6.0, 12/2005


The following figures show how this report generates differently from these two request pages.

Purchase Order List – Crystal Report (no parameters)

Purchase Order List – Crystal Report (for Vendor ATI Parameter)

Release 6.0, 12/2005 3-5

Running Reports with Current/Selected/All Records


You generate reports with Current/Selected/All records by selecting an application and running the report against the number of records you specify. You can run a report against the database in the following ways:

by the current recordby the selected recordsfor all records

When you run the report, Maximo passes the where clause to Crystal to execute the report.

The following topics depict these scenarios.

Current Record

To run a report against the database for the current record, open one record and run a report based on only that record. For example, you open Purchase Order 1005 and run a report based on that one purchase order.

Purchase Order Application with PO Record Selected

3-6 Release 6.0, 12/2005


Selected Records

From the List tab, you filter the entire list of records and run a report based upon those records selected. You can filter records using either of the following methods:

table filter

Select Records check box

The following sections describe these methods in more detail.

Using the Table Filter to Select Records

The table filter appears at the top of the table window as a row of fields appearing between the column headings and the first row of the table. To use the table filter to select records, complete the following steps:

1 Enter the following values in the header row as an example of filtering a set of records:

Status – Enter WAPPR.

Site – Enter Bedford.

TIP Use the equals sign (=) for an exact match. For example, filtering records with a status of “APPR” also returns records that have a status of “WAPPR” unless you type “=APPR” in the status field.

2 Click the Filter Table button (binoculars) or press Enter. Maximo filters the table window and a list of records based on your filter criteria appears.

Purchase Order Application (List Tab) with Filtered Values

Using the Select Records Check Box to Select Records

To use the Select Records check box to select records, complete the following steps:

1 To open a column of check boxes, one corresponding to each record in the list, select the Select Records check box.

2 Select the check box next to each records you want to appear on your Crystal report.

Release 6.0, 12/2005 3-7


In the following figure, you select purchase orders 1013 and 1015. When you run the report, it will run against only those two records.

Purchase Order Application (List Tab) with Records Selected

All RecordsTo run a report against the database for all records, open an application to display all records and run the report.

Maximo will not let you generate a report with more than 200 records if the Report Developer/Administrator enables the Detail flag for that report. See “Using the Detail Check Box for Detail Reports” on page 4-6 for further information.

Purchase Order Application (List Tab) showing all Purchase Order Records

3-8 Release 6.0, 12/2005

Report Developers/Administrators manage Crystal (and Actuate) reports in Maximo through the Report Administration application. This chapter describes how you can perform the following actions:

accessing the Report Administration module

adding a new Crystal report

using the Detail check box for Detail reports

adding bound parameters to Crystal reports

determining your parameter’s attribute name

storing parameter-based reports in multiple Maximo applications

duplicating a report

deleting a report

Administering Reports in Maximo 4

Release 6.0, 12/2005 4-1

Report Developer/Administrator Actions Flowchart

Report Developer/Administrator Actions FlowchartThe following flowchart shows the actions required by the report developer/administrator in both Crystal and Maximo that lets Maximo users to run Crystal reports. This chapter describes the Maximo Report Administration actions in this flowchart. For information on Crystal Reports, see Chapter 5, “Adding Reports to Central Management Console.”

NOTE Maximo users can run Crystal reports only if the Report Developer/Administrator adds the report to both the Crystal Management Console and the Maximo Database.


BusinessObjects XI

MXES ReportAdministration Application

Create Report.

Insert Report.

Add Crystal Report (.rpt file)to Maximo database.

Generate XML on theReport tab to create the

Request Page.

Use the Detail Field(Detail reports, only).

ReportDeveloper/

Administrator

Access the Request Page.

Add report to CMC.

Access ReportAdministration module.

ReportDeveloper/

Administrator

Run the report.

Maximo users

Delete the Report.

Maximo Database

MXES user application

Preview the Request Page.

4-2 Release 6.0, 12/2005

Chapter 4: Administering Reports in Maximo

Accessing the Report Administration Module

This section describes the two ways to access the Report Administration module in Maximo to manage your reports.

NOTE To access Report Administration, your System Administrator must provide you with security access to it.

Open Report Administration through either of the following methods:

Select Administration > Report Administration.

Accessing Report Administration from Administration in the Go To Menu

Select Reporting > Report Administration.

Accessing Report Administration from Reporting in the Go To Menu

Release 6.0, 12/2005 4-3

Adding a New Crystal Report


In this section, you register the Purchase Order List and the Purchase Order Details that your received with Maximo. MRO Software does not register either report so you must register them.

NOTE Maximo users can run Crystal reports only if the Report Developer/Administrator has added the report to both the Crystal Management Console and the Maximo Database.

1 In Maximo, open the Report Administration module.

2 To insert a report, click the New Report icon or press Ctrl + Alt + I. The Report tab opens.

Maximo Toolbar with New Report Icon indicated

3 Enter or accept the default values in the following fields:

Report File Name – The name of the report executable. Type it EXACTLY as it appears (or will appear) in the Report Title field in the CMC.

NOTE The Crystal file name you enter must have the suffix .rpt to run correctly and must match the value you enter in the Report Title field in the CMC (see page 5-7) so that Maximo can locate the requested report.

CAUTION Maximo does NOT verify this report file name, and this field has no Select Value icon.

Report Run Type – Type Crystal or click the Select Value icon. Once you select Crystal, the following fields are unavailable to you:

! No Request Page?! Attach Documents?! Toolbar Location! Toolbar Image! Toobar Sequence

The Application and Report Folder fields can be used in conjunction to access the Purchase Order List Report and Purchase Order Details Report from multiple applications, although you will store each report in only the PO report folder.

Application – The Maximo application through which your end users can access the report. For the Purchase Order List and Purchase Order Details, type PO as the application name or click the Select Value icon to open a dialog box with available application names.

4-4 Release 6.0, 12/2005


If you want users to have access to these two reports from another application (for example, Company) duplicate the record for each report and enter Company in this field. For information on how to duplicate a record, see “Duplicating a Report,” on page 4-14.

Report Folder – The location where the Report Administrator stores the Crystal report in the CMC. This field uses the value you entered in the Application field.

If the default value (PO) is the same as the folder location where you stored the report in the CMC, accept it.

If the default value (for example, Company) is different from the folder location where you stored the report in the CMC, type the correct folder name (PO).

Refer to the following table for another view of the relationship between the Application field and the Report Folder field.

Using the Application and Report Folder fields table

The following figures further illustrate this example.

In this figure, you keep the Report Folder field at the default value PO (your entry in the Application field) for the Purchase Order List. The PO folder is the location in the CMC where you store the report.

Report Tab allowing Users to access Purchase Order List from PO Application

In the next figure for this same report, enter Company in the Application field. In the Report Folder field, overwrite the default value with PO.

If you want your users to access the Purchase Order List or Purchase Order Details from . . .

in the Application field, enter . . .

and in the Report Folder field,enter. . .

the PO application, PO PO.

the Company application, Company PO.

Release 6.0, 12/2005 4-5

Using the Detail Check Box for Detail Reports

Report Tab allowing Users to access Purchase Order List from Company Application

4 Click the Save Report icon or press Ctrl + Alt + S to save the report.

Using the Detail Check Box for Detail Reports

Since detail reports can be very specific and complex for each record, Maximo has a Detail? check box. If you select the Detail? check box, you prevent your end users from running a detail report (for example, Purchase Order Details) against more than 200 records.

If you want to enable the check box for Purchase Order Details, complete the following steps:

1 Open the Purchase Order Details in the Report tab of the Report Administration application.

2 Select the Detail? check box to add the checkmark.

3 Click Generate XML on the Report Tab to create the report's requestpage.

4 Click Preview to open the request page and run the report.

Report Tab with Detail? Field Selected for Purchase Order Details

4-6 Release 6.0, 12/2005


Adding Bound Parameters to Reports

Bound parameters are parameters with equivalent fields or relationships in the Maximo database. In the following section, you create a bound parameter and run the report.

NOTE Unbound parameters are parameters with no equivalent fields or relationships in the Maximo database.

After you register a report (in this case, the Purchase Order List) in both the Central Management Console and the Maximo Report Administration Application, you can enter a bound parameter to limit the type of information that appears on the report.

NOTE There are special considerations when storing reports with bound parameters in multiple Maximo applications. For detailed information, see “Storing Parameter-Based Reports in Multiple Maximo Applications,” on page 4-13.

In the following section, you will add vendor as a bound parameter to the Purchase Order List Report and run that report for the vendor you indicate.

1 Open the Maximo Report Administration application and select the List tab. All available reports appear.

2 Select Purchase Order List.

Report Tab for Purchase Order List

.

Release 6.0, 12/2005 4-7


3 Click New Row to open the Report Parameter fields.

Purchase Order List with Lookup Fields

4 For this example, complete the following fields:

Parameter Name – Enter the parameter name for the report. You may already have defined this name in the Crystal Reports file. For this example, enter Vendor.

Attribute Name – the field from the main table of the application or the field from the application’s MAXRELATIONSHIPS. Click the Detail Menu icon to view a list of all attributes for the Maximo application you selected.

NOTE Since you are working with only bound parameters, you must enter an attribute name.

For this example, enter VENDOR or click the Detail Menu icon to select an attribute name from a list of all attributes for the PO application.

NOTE For a detailed discussion of how to determine the attribute name for your parameter, see “Determining your Parameter’s Attribute Name,” on page 4-12.

4-8 Release 6.0, 12/2005


Special Relationship/Attribute Dialog Box (for Attribute Name field)

Lookup Name – the name of the Maximo lookup for the value entered in the Attribute Name field. To find a list of available lookups, click on the Select Value icon next to the Lookup Name field.

NOTE The value you entered in the Attribute Name field does not necessarily have a corresponding value in the Lookup Name field.

Operator – Use this field to select a mathematical operator for the new parameter. For example, when adding a START DATE parameter:

! Select “>=” to run a report with start dates later (greater) than or equal to the date you enter when you run the report.

! Select “<=” to run a report with start dates earlier (less) than or equal to the date you enter when you run the report.

NOTE If you use Operators for your parameter, you cannot use Default Values.

Multi-lookup Enabled? – If you select this check box, the end user can enter or select multiple entries for a parameter field. For example, if this check box is selected, the end user can enter or select Bedford, McLean, and Nashua as valid sites instead of only one site.

Display Sequence – the order in which the new parameter appears on the request page. For example, if the parameter is to appear after four existing parameters, enter 5 in this field.

Override Label – the name of the parameter as it will appear on the page to the end user.

Release 6.0, 12/2005 4-9


Default Value – the default value, if any, that will appear to the end user. For example, if you are creating a STATUS parameter, you can enter APPR as the default value.

NOTE If you use Default Values for your parameter, you cannot use Operators.

Required? – select this check box if you want this parameter to be required for the end user to run the report.

5 Click the Save Report icon to add a parameter to the report.

6 Click Generate XML on the Report Tab to create the report’s request page. When Maximo finishes, the following messages box appears:

Maximo Message Dialog Box

7 Click Preview to open the newly revised request page. In the Vendor field, enter a vendor code (for example ATI).

4-10 Release 6.0, 12/2005


8 To run the report, click Submit.

Request Page Dialog Box

9 The Crystal Purchase Order List report appears containing only information for that vendor.

Purchase Order List with ATI Vendor Information, only

Release 6.0, 12/2005 4-11

Determining your Parameter’s Attribute Name

Determining your Parameter’s Attribute NameWhen you add a parameter to a report, that parameter is defined through the Attribute Name field. This section is meant to assist you in determining a parameter’s attribute name.

To determine an attribute name, complete the following steps:

1 Determine if the main table of your Maximo application is the same as the main table that your report uses. To make this determination, run an SQL statement on the report application using a database query tool.

For the purpose of determining a parameter’s Attribute Name, assume you are creating a Crystal report called Asset Failures. To add a Location parameter to Asset Failures, you could run the statement:

Select * from maxapps where app = ’ASSET’;

where

ASSET is the application where that report is located.

After you execute this statement, the result indicates that the main table is Asset. Since the location parameter exists in the main table of the Asset application, you should enter Location in the Attribute Name field.

If the main table of your application is not the same table that your report is using, or if the parameter does not exist in the main table of the application, continue to the next step.

2 Determine the relationship that exists between the parameter you are adding and the Maximo application.

You can do this by running an SQL statement on the relationship (the MAXRELATIONSHIP) using a database query tool. For example, if you add the Start Date parameter to the Asset Failures Report, you could run a statement such as:

Select * from maxrelationship where parent = ’ASSET’ and child = ’WORKORDER’;

where

ASSET (the parent) is the main table application where the report exists.

WORKORDER (the child) is the table name of the field where the Start Date parameter resides.

After you execute this statement, you can evaluate the where clauses of the available relationships and determine the relationship that best meets the needs of the report. In this case, the relationship is ALLWO and you should enter ALLWO.FAILDATE in the Attribute Name field for this parameter.

If you cannot determine the relationship between the parameter you are entering and the Maximo application, continue to the next step.

3 Determine that no direct relationship exists between the parameter you are adding and the Maximo application where the report resides. Since there is no way to specify the MAXRELATIONSHIP exists between the parameter and the application, you cannot add the parameter.

For more database information, refer to the database configuration chapter in the Maximo Enterprise Suite System Administrator’s Guide.

4-12 Release 6.0, 12/2005


Storing Parameter-Based Reports in Multiple Maximo Applications

All standard Maximo reports belong to an application. For example, the Purchase Order List Report is located in the Purchase Order application.

CAUTION If you want to access this report from another application, you must check that all its attributes, for both required and non-required parameters, appear in that application.

For example, if you receive a request to store the Purchase Order List report in the Company application, you must verify that the bound parameter (in this case, the Customer Number) you added to the report is an attribute in the Company application.

You can verify the attributes in any application by using either of the following methods:

Run the following SQL statement:

select attributename from maxattribute where objectname = ’application name’

where

application name is COMPANY

See if the value exists in the Attribute Name Lookup

You can store the Purchase Order List Report in the Company application as the Customer Number parameter is common to both the Purchase Order application and the Company application.

Purchase Order List Report with Bound Parameter

Release 6.0, 12/2005 4-13

Duplicating a Report

NOTE If this report contains a parameter with an attribute name that is in Purchase Orders but not available in Company, such as ORIGINALPO, you receive an invalid binding error message.

Maximo opens this error message dialog box as there is no link from ORIGINALPO in Purchase Orders to ORIGINALPO in Company (as this attribute does not exist in Company).

Purchase Order List Report with Bound and Unbound Parameter

To resolve this issue, you must remove the Original Purchase Orders parameter or select an application other than Company to store the report.

Duplicating a Report

You can use the Duplicating a Report action in the Report Administration application to perform the following actions:

add an additional report to an existing application

create a report exactly like an existing one and then modify it to create a new report

To duplicate a report, complete the following steps:

1 In the Report Administration application, open the report you want to duplicate.

2 From the Select Action menu, select Duplicate Report. Maximo displays a message that the record has been duplicated.

3 Modify the report.

4 Save the new report.

4-14 Release 6.0, 12/2005


Deleting a ReportYou can use the Report Administration application to delete a report. When you delete a report, you permanently remove it from the Maximo database. You might want to delete a report that offers you a view of report data that you no longer use or the report is outdated.

Using the same type of report from previous sections, the following procedure explains how to delete Purchase Order Details.

1 Open the Maximo Report Administration application.

NOTE You will see approximately 150 Actuate reports that MRO Software has registered to the Report, Report Label, and Report Lookup tables.

If Crystal is the only reporting tool you use, you may want to delete these Actuate reports. For information on deleting these reports, see the section “Deleting Existing Actuate Reports” on page 4-16.

2 Locate Purchase Order List. It opens on the Report Tab.

Purchase Order Report on Report Tab

3 From the Select Action Menu, select Delete Report. Maximo prompts you to confirm the deletion.

Maximo Confirm Deletion Dialog Box

4 To delete the report record, click Yes. To cancel the deletion, click No.

Release 6.0, 12/2005 4-15

Deleting a Report

Deleting Existing Actuate Reports

If you are using Crystal as your only reporting tool, you may want to delete registered Actuate reports individually through the Report Administration application or delete all reports by through scripts that MRO Software provides to you in this section.

Deleting Actuate Reports Individually through the Report Administration Application

1 In the Report Administration application, open a list of the Actuate reports included with Maximo.

List Tab in Report Administration with Actuate Reports

2 Select the first report you want to delete. If you select the first report in the list, by default the Details of an Asset’s Failures report appears in the Report tab.

3 From the Select Action menu, go to the Select Action drop-down list and select Delete.

4-16 Release 6.0, 12/2005


Report Tab in Report Administration with Report for Deletion

4 Select Yes to delete the report record or select No to cancel the deletion.

If you select Yes, you delete the report from the Maximo database and the Report Administration application.

Maximo Confirm Deletion Dialog Box

Deleting All Actuate Reports by running Scripts

To delete all Actuate reports at once, you can run the following scripts against your database to delete the Actuate reports from the three tables (Report, Report Label, and Report Lookup) where the reports reside.

NOTE If you are using a case-sensitive SQL Server database, you must run these scripts in lowercase letters exactly as written.

delete from report where runtype not in (select value from synonymdomain where maxvalue = ’CRYSTAL’;

delete from reportlabel where reportname like ’%ROX%’;

delete from reportlabel where reportname like ’%DOX%’;

delete from reportlookup where reportname like ’%ROX%’;

delete from reportlookup where reportname like ’%DOX%’;

Release 6.0, 12/2005 4-17

Deleting a Report

4-18 Release 6.0, 12/2005

Overview This chapter describes how the report administrator or system administrator can use Crystal Reports’ Central Management Console (CMC) to perform the following tasks:

creating your report folder structure

adding a new report

setting security privileges

Adding Reports to Central Management Console 5

Release 6.0, 12/2005 5-1

Report Developer /Administrator Actions Flowchart

Report Developer /Administrator Actions FlowchartThe following flowchart shows the actions required by the report developer/administrator, in both Crystal Reports and Maximo, which let Maximo end users run Crystal reports. This chapter describes the Central Management Console actions in this flowchart. For information about Maximo’s Report Administration application, see Chapter 4, “Administering Reports in Maximo.”

NOTE Maximo users can run Crystal Reports only if the Report Developer/Administrator adds the report to both the Crystal Management Console and the Maximo Database.


BusinessObjects XI

MXES ReportAdministration Application

Create Report.

Insert Report.

Add Crystal Report (.rpt file)to Maximo database.

Generate XML on theReport tab to create the

Request Page.

Use the Detail Field(Detail reports, only).

ReportDeveloper/

Administrator

Access the Request Page.

Add report to CMC.

Access ReportAdministration module.

ReportDeveloper/

Administrator

Run the report.

Maximo users

Delete the Report.

Maximo Database

MXES user application

Preview the Request Page.

5-2 Release 6.0, 12/2005

Chapter 5: Adding Reports to Central Management Console

Creating your Report Folder Structure

This section describes how to create a folder structure for Maximo reports in the CMC. You must create your Report Folder structure before you register any reports. The report structure enables Maximo to locate the (.rpt) files in BusinessObjects Enterprise.

To do so, complete the following steps.

1 Log on to the CMC as the Report Administrator.

Central Management Console Log On Page

Release 6.0, 12/2005 5-3

Creating your Report Folder Structure

2 On the CMC home page, click Folders to open your report folder structure.

Central Management Console Home Page

3 You must create a report structure in the following format:

A top level-rpt folder.

A subfolder for each Maximo application (for example, PO). The name of this subfolder must match the name of the Report Folder field (see page 4-5) in the Report Administration application.

A reports subfolder beneath each application folder. You must place your Crystal report (.rpt) files in this subfolder.

Example

rptPO

reportsPO Crystal Report 1.rptPO Crystal Report 2.rptPO Crystal Report 3.rpt

PRreports

WOTRACKreports

5-4 Release 6.0, 12/2005


The following figure illustrates this report structure:

CMC Report Structure for Purchase Orders

Release 6.0, 12/2005 5-5



For your end users to run reports, you must register each report in the CMC (and in the Maximo Report Administration application). This section describes how to add Crystal reports to your CMC.

In the following section, you register the two sample reports (the Purchase Order List Report and Purchase Order Details Report) that MRO Software provided to you with Maximo.

1 Open the CMC and navigate to the following folder where you want to register the Purchase Order List – Crystal report and the Purchase Order Details – Crystal report in the following folder:

rpt>po>reports

2 Click the Objects tab.

Reports Folder

3 To open the New Object window, select New Objects . . .

4 To locate the folder that contains the report file, click Browse . . .

MRO Software places the sample reports files (po.rpt for the Purchase Order List Report and poprint.rpt for the Purchase Order Details Report) in the following folder, depending upon your database:

<Maximo root>\Applications\bocrystal\reports\<oracle or sqlserver>

5-6 Release 6.0, 12/2005


New Object Dialog Box for Purchase Order List – Crystal Report

New Object Dialog Box for Purchase Order Detail – Crystal Report

5 Click OK to open the Properties tab.

6 In the Report Title field, enter the filename for the report.

Release 6.0, 12/2005 5-7


NOTE The filename you enter must have an .rpt suffix for the report to run correctly. The filename must also match the value you entered in the Report File Name field in Maximo Report Administration (see page 4-4) so that Maximo can locate the requested report.

For example, in that chapter you entered po.rpt for the Purchase Order List report and poprint.rpt for the Purchase Order Details report.

Central Management Console Properties Tab for Purchase Order List – Crystal Report

5-8 Release 6.0, 12/2005


Central Management Console Properties Tab for Purchase Order Details – Crystal Report

7 Click Update to save your updated report title to the Central Management Console.

Release 6.0, 12/2005 5-9

Setting Security Privileges


For your Maximo users to run Crystal reports, you must establish security for one Crystal user through the CMC. When a Maximo user runs a Crystal report, they silently log in to Crystal through this single, named user account.

Security filtering of Crystal reports, which allows you to provide access privileges on a report-by-report or user-by-user basis, is not available. Therefore, all reports available in a Maximo application are visible to anyone who has access to that application.

The following section describes how you can grant Edit Objects privileges, at the rpt folder level, for your users via a single named user account. By providing these instructions as an example of setting security privileges in the CMC, MRO Software points out to you the following items:

By setting the Edit Objects option to explicitly granted, you are providing the minimum level of rights MRO Software requires for Maximo integration with Crystal reports. You should determine what, if any, additional rights you want to grant to your users.

By setting these privileges for user account MXES (or any new or existing user that you select), MRO Software illustrates how to use a single named user account.

The following instructions explain how to set security privileges in the CMC for user MXES.

1 Log on to the CMC as the Administrator. The CMC Home Page appears.

Central Management Console Home Page

5-10 Release 6.0, 12/2005


2 To open the Top Level Folders dialog box, click Folders.

3 To display the subfolders for the rpt folder, click rpt.

Central Management Console Top Level Folders

The subfolders for the rpt folder appear.

Central Management Console RPT Folder

4 Click the Rights subtab. For existing user MXES, go to the Access Level dialog box and select View on Demand. To add rights for a new user, create that user and return to this subtab.

CMC Rights Tab with View on Demand Access Level

Release 6.0, 12/2005 5-11


5 To submit the change to the server, click Update

6 For existing user MXES, go to the Access Level drop-down list and select Advanced . . . to open the Advanced Rights dialog box.

CMC Rights Tab with Advanced Access Level

7 Change the Edit Objects option from Not Specified to Explicitly Granted. To accept this change and refresh the page, click Apply.

8 To return to the Rights subtab, click OK.

Advanced Rights Dialog Box

5-12 Release 6.0, 12/2005

This chapter describes how to use the command tables to create Maximo reports in Crystal. For Maximo to pass the where clause from Maximo applications to Crystal Reports properly, this is the only way in which you can create reports.

NOTE Do not select individual tables to include in your Crystal report.

Using Command Tables to Create Reports

The following steps describe how you can use command tables in Crystal to create reports for Maximo.

1 Open the Crystal Reports start page.

Crystal Reports Start Page

Creating Maximo Reports in Crystal 6

Release 6.0, 12/2005 6-1


2 Click Blank Report to open your Oracle or Microsoft SQL Server database in the Database Expert dialog box.

Oracle reports use an Oracle connection as their connection method.SQL Server reports use ODBC as their connection method.

The following figures show both types of database dialog boxes.

Database Expert Dialog Box (Oracle database)

Database Expert Dialog Box (SQL Server database)

6-2 Release 6.0, 12/2005

Chapter 6: Creating Maximo Reports in Crystal

NOTE The remaining figures you see in this chapter are from only an Oracle database.

3 Double-click Add Command (below the server name) to open the Add Command to Report dialog box.

Database Expert Dialog Box (Oracle database) with Add Command indicated

NOTE You must use the Command Table editor. You cannot create reports by selecting individual tables to include in your Crystal report.

Add Command to Report Dialog Box (with blank Command Table Editor)

Release 6.0, 12/2005 6-3


4 For this example, type the following SQL query in the Enter SQL query in the box below field.

select po.ponum, po.description, po.vendor,companies.name,po.requireddate, po.vendeliverydate,po.purchaseagent,po.status, po.mnetsentfrom po, companies,where po.orgid = companies.orgidand po.vendor = companies.company

Add Command to Report Dialog Box (with SQL Query in Command Table Editor)

t

NOTE To enable Maximo integration, you must include a parameter in the where section of the SQL statement, as described in Steps 5 – 7.

5 To open the Command Parameter dialog box, click Create

6 In the Parameter Name field, type where.

7 To return to the Add Command to Report dialog box, click OK.

6-4 Release 6.0, 12/2005


Command Parameter dialog box

8 Place your cursor at the end of the SQL query. Type and (as shown), then double-click where in the Parameter List dialog box to place the parameter at the end of the SQL query.

After completing this step, your SQL query statement should look like the SQL query statement in the following figure.

NOTE If your original SQL statement does not include a “where” clause, you must insert the where parameter at the end of the statement as in the following example:

select po.ponum, po.description, po.vendor, po.requireddate, po.vendeliverydate, po.purchaseagent, po.status, po.mnetsentfrom po

where {?where}

Release 6.0, 12/2005 6-5


Add Command to Report Dialog Box

NOTE If you use an Oracle database, as in this example, you must also add a schema parameter before each table name.

9 To open the Command Parameter dialog box, click Create.

10 In the Parameter Name field, type schema.

11 To return to the Add Command to Report dialog box, click OK.

12 Place your cursor before each table name (po and companies) on the From line and double-click the schema parameter in the Parameter List to add it to the SQL query.

6-6 Release 6.0, 12/2005


13 Add a period ( . ) between the schema parameter and each table name.

After completing this step, your SQL query statement should look like the SQL query statement in the following figure.

Add Command to Report dialog box

14 Click OK to open the Enter Values dialog box. Enter values for each of the parameters in the Parameter List.

In the schema field, enter the owner of the database schema For more information, see Appendix A, “Maximo.Properties File Descriptions.”

In the where field, type 1=1.

Enter Values dialog box

Release 6.0, 12/2005 6-7


15 To accept these values, click OK. Crystal Reports reopens the Database Expert dialog box.

16 To return to the report, click OK.

Database Expert Dialog Box

6-8 Release 6.0, 12/2005


17 To open a list of database fields selected for your report (as determined by your SQL statement), select View > Field Explorer.

Purchase Order Details - Crystal Report in Design View

18 Drag database fields from Field Explorer to the Details section of your report. As you do so, each field also appears in the Page Header section.

Purchase Order Details - Crystal Report with Database Fields in Design View

Release 6.0, 12/2005 6-9


19 To see how your completed report appears, click Preview.

Purchase Order Details - Crystal Report in Preview

20 Edit the report as needed.

21 To save your report, select File > Save.

6-10 Release 6.0, 12/2005


Enabling Crystal SubReports for Maximo Integration

This section describes how to enable Crystal subreports to work with Maximo integration. When you include a subreport in a report against an Oracle database, you must pass the schema name from the main report to the subreport.

NOTE These steps are not necessary if you are working in a Microsoft SQL Server database.

In the following instructions, you work with a Purchase Order Details report that contains a subreport for Purchase Order Line information. The main report must pass the database schema name to the subreport.

To enable Maximo integration, complete the following steps:

1 Open the Purchase Order Details report.

2 Open the SQL Query for the subreport and create a new parameter called subSchema. The new parameter accepts the schema from the main report when you generate the subreport.

Modify Command Dialog Box with Purchase Order Details – Crystal Report

Release 6.0, 12/2005 6-11

Enabling Crystal SubReports for Maximo Integration

3 Open the Subreport Links dialog box in the Crystal Purchase Order Details Report to connect the new subSchema parameter to the schema in the main report.

NOTE In the Subreport parameter field to use drop-down list, you must select the ?subSchema parameter.

Subreport Links Dialog Box

6-12 Release 6.0, 12/2005

The MAXIMO.PROPERTIES file is the Maximo configuration file. This appendix contains the database properties descriptions from the MAXIMO.PROPERTIES file:

NOTE If you change a database property in the MAXIMO.PROPERTIES file, you MUST re-build and re-deploy your maximo.ear file.

Use the following table to identify the location of related information, both in this guide and in other locations:

Database Properties

Maximo.Properties File Descriptions A

For information about . . . refer to . . .

all properties in the MAXIMO.PROPERTIES file,

the Maximo Enterprise Suite System Administrator’s Guide.

MXES-Business Objects Integration properties,

Appendix B, “Additional Maximo.Properties File Descriptions.”

rebuilding and redeploying your maximo.ear file,

the Maximo Enterprise Suite Installation Guide.

Property Name Description

mxe.db.schemaowner (Oracle) Owner of the database schema.

Oracle default: maximo.

mxe.db.schemaowner (SQL Server)

Owner of the database schema.

For SQL Server, the owner name must be dbo.

mxe.db.driver (Oracle) The thin driver defined in mxe.db.driver.

For example:

mxe.db.driver=oracle.jdbc.driver.OracleDriver

mxe.db.driver (SQL Server) The thin driver defined in mxe.db.driver. For SQL Server, the driver name must be:

mxe.db.driver=com.inet.tds.TdsDriver

Release 6.0, 12/2005 A-1

Database Properties

mxe.db.url (Oracle) The default URL is:

mxe.db.url=jdbc:oracle:thin:@dbserver:1521:sid

where dbserver is the servername of your database server, 1521 is your default Oracle port number, and sid is your Oracle system identifier.

mxe.db.url (SQL Server) The default is: server name, port number, database name defined as:

mxe.db.url=jdbc:inetdae7a:servername:1433? database=databasename&language=us_english& nowarnings=true

where you would substitute your database server name and database name for the italicized values. The default SQL Server port number is 1433.

NOTE: The string mxe.db.url=jdbc:inetdae can be followed by either 7 (supports Unicode) or 7a (supports ascii). Currently, Maximo only supports ascii for SQL server.

mxe.db.user (Oracle) Database user the server uses to attach to the database server. This user must be the schema owner.

Default: maximo.

mxe.db.user (SQL Server) Database user the server uses to attach to the database server. This user must have a system administrator role as defined via sp_addsrvrolemember.

Example: mxe.db.user = MAXIMO

mxe.db.password Password for the database user.


A-2 Release 6.0, 12/2005

To integrate Maximo with Crystal reports, Maximo now has an addendum to the MAXIMO.PROPERTIES file: ADDITIONALMAXIMO.PROPERTIES. This addendum contains all the MXES-Business Objects Integration files you need to integrate your Crystal reports with Maximo.

This appendix describes each MXES-Business Object Integration file in the ADDITIONALMAXIMO.PROPERTIES file.

NOTE After you edit the properties in the ADDITIONALMAXIMO.PROPERTIES file, you MUST perform the following actions to enable Crystal reports integration:

Copy and paste the MXES-BusinessObjects Integration Properties section of the ADDITIONALMAXIMO.PROPERTIES file into the MAXIMO.PROPERTIES file.

Rebuild and redeploy your maximo.ear file.

Use the following table to identify the location of related information, both in this guide and in other locations:

Additional Maximo.Properties File Descriptions B

For information about . . . refer to . . .

all properties in the MAXIMO.PROPERTIES file,

the Maximo Enterprise Suite System Administrator’s Guide.

database properties (only) in the MAXIMO.PROPERTIES file,

Appendix A, “Maximo.Properties File Descriptions.”

rebuilding and redeploying your maximo.ear file,

the Maximo Enterprise Suite Installation Guide

Release 6.0, 12/2005 B-1

MXES-Business Objects Integration Properties

MXES-Business Objects Integration Properties


mxe.report.bo.db.connnectstring The Maximo database connection string (Oracle) or ODBC DSN (SQL Server) on the BusinessObjects Enterprise server.

Default: mxe.report.bo.db.connectstring=MAXIMO.

mxe.report.bo.db.databaseName(SQL Server, only)

The database name for the Maximo database.

Default: MAXIMO

mxe.report.bo.serverURL The URL of the BusinessObjects Enterprise server, including port number and folder. Maximo uses this URL to access the bocrystal.war Web application.

Default URL: http://BOserver:8080/bocrystal

mxe.report.bo.rootFolder The BusinessObjects Enterprise root folder name.

Default: rpt.

mxe.report.bo.rptServerLogonName The BusinessObjects Enterprise logon name. This user must have specific rights to any report you will access from Maximo. See “Setting Security Privileges” on page 5-10.

Default: maximo.

mxe.report.bo.rptServerLogonPass The BusinessObjects Enterprise password.

Default: maximo.

mxe.report.bo.cmsName Unless you changed the name of the Central Management Server (CMS) when you installed BusinessObjects Enterprise, this property is the name of the server where you installed BusinessObjects Enterprise and the server port number. To verify the correct values, open the CMC Logon page and check the System field.

Default: CMS port number:6400.

B-2 Release 6.0, 12/2005

This appendix describes reporting features that are either unique to your Crystal Report setup in Maximo or unavailable through Maximo integration with Crystal Reports. These features are grouped into four categories:

Crystal Features – licensing, security, and configurations

Business Analysis and Reporting Dialog Box – viewing, scheduling, sending via e-mail, and querying

Report Administration Application Features – running parameter-based reports, accessing the Quick Toolbar, attaching documents, using the Labels tab

Crystal Browser – customizing, downloading searching, using templates

Crystal Features

Business Analysis and Reporting Dialog Box

Reporting Features not supported in Maximo Integration for BusinessObjects Crystal Reports XI

C

Feature Description

Crystal Report Licensing

As noted in “Crystal Licensing” on page 1-1, MRO Software does not license Crystal for Maximo users. You must license Crystal directly from Business Objects.

Crystal Report Level Security

As noted in “Setting Security Privileges” on page 5-10, MRO Software does not enable Crystal report level security. All Crystal reports you register in Maximo’s Report Administration application are available to all Maximo users from that application. Security filtering within Crystal is not available.

Report Server configurations

MRO Software tested and supports the configuration of one Maximo server to one BO Enterprise server. MRO Software does not test or support configurations with multiple Maximo servers to one BO Enterprise Server.

Feature Description

View Reports MRO Software does not enable the View Report subtab (under the Report tab) in the Business Analysis and Reporting dialog box. Maximo integration does not retrieve or display previously executed reports from the BO Enterprise Server.

Schedule When running Crystal reports in Maximo, you cannot schedule reports to run. You can only run reports in real time.

Release 6.0, 12/2005 C-1

Reporting Features not supported in Maximo Integration for BusinessObjects Crystal Reports XI

Report Administration Application Features

Crystal Browser

E-mail When running Crystal reports in Maximo, you cannot send reports via e-mail. Therefore, the E-mail Report tab for Crystal reports is not visible on the Maximo request page.

Queries In the Business Analysis and Reporting dialog box, there is a Queries tab. This tab is for a specific type of Actuate report.

Feature Description

Parameter-based Reports

You can run only parameter-based reports with bound parameters. You cannot run parameter-based reports with unbound parameters.

Quick Toolbar Access

Your report administrator cannot create a button on a Maximo toolbar to provide your users with one-click access to selected reports.

Attached Documents

When running Crystal reports in Maximo, you cannot attach any files.

Labels Feature Your report administrator cannot use the Labels tab in the Report Administration application to customize or localize report titles and labels.

Feature Description

Browser Customizing

MRO Software does not customize the Crystal Reports browser. The user interface and features appear “as is” from Crystal Reports.

Downloading and Searching

MRO Software does not test or support Crystal Reports-specific features such as downloading a report or searching within a report.

Templates When developing Crystal reports in the Crystal Reports designer, Maximo specific report templates are not available.

The two Crystal reports you received are based upon a blank report template.

Feature Description

C-2 Release 6.0, 12/2005

Index

A

accessingquick toolbar C-2Report Administration module 4-3

Actuate reportsdeleting 4-16deleting all 4-17deleting individually 4-16

Actuate server 1-4adding

bound parameters 4-7new Crystal reports in CMC 5-6new Crystal reports in Maximo 4-4

administeringCrystal reports in Maximo 4-1

all recordsrunning report against 3-8

applicationsstoring reports in multiple 4-4

attaching documents C-2attribute name

determining for a parameter 4-12

B

bocrystal.warbuilding 2-1deploying 2-1

bound parametersadding 4-7

browsercustomizing C-2

building bocrystal.war 2-1Business Analysis and Reporting dialog box

using Run Report subtab in 3-3BusinessObjects

copying server files to Maximo server 2-2Enterprise server 1-1, 1-2Enterprise server with Actuate server in Maximo network

configuration 1-4Enterprise server with Maximo network configuration 1-3maintaining the Enterprise server 2-4XI Components 1-1

C

check boxusing to select records 3-7

CMC (Central Management Console)

report folder structure 5-3command tables 6-1configuring

Maximo network 1-3Report server C-1

copyingBusinessObjects Enterprise server files to Maximo server 2-2

creatingMaximo reports in Crystal 6-1report folder structure 5-3reports using command tables 6-1XML code 4-6

Crystal Reportslicensing 1-1, C-1security C-1

Crystal reportsadding in CMC 5-6adding in Maximo 4-4administering in Maximo 4-1included in Maximo 3-2requirements for running in Maximo 4-2signing in 3-1with parameters 3-5without parameters 3-5

Crystal Reports XIreporting features not supported C-1

Crystal subreports 6-11current record

running report against 3-6current/selected/all reports 3-6customizing your browser C-2

D

databaseproperties in Maximo.Properties A-1server 1-2

deletingall Actuate reports 4-17individual Actuate reports 4-16reports in Maximo 4-15

deploying bocrystal.war 2-1Detail check box 4-6detail reports 4-6determining

parameter attribute names 4-12documents

attaching C-2downloading a report C-2duplicating a report 4-14

Release 6.0, 12/2005 Index-1

Index

E

email reports C-1enabling

Crystal subreports 6-11

F

file descriptionsadditional Maximo.Properties B-1Maximo.Properties A-1

G

generatingXML code 4-6

H

hardware 1-2

L

Labels tab C-2licensing

Crystal Reports 1-1, C-1

M

maintainingthe BusinessObjects Enterprise server 2-4

Maximoadministering Crystal reports in 4-1application server 1-2creating Crystal reports 6-1Crystal reports included in 3-2enabling Crystal subreports for integration 6-11opening reports 3-1requirements for running Crystal reports 4-2storing reports in multiple applications 4-4, 4-13

Maximo networkconfiguring 1-3configuring with Business Objects Enterprise server 1-3configuring with BusinessObjects Enterprise server and

Actuate server 1-4Maximo.Properties

additional B-1database properties A-1file descriptions A-1

mxe.db.driver (Oracle) A-1mxe.db.driver (SQL Server) A-1mxe.db.password A-2mxe.db.schemaowner (Oracle) A-1mxe.db.schemaowner (SQL Server) A-1mxe.db.url (Oracle) A-2mxe.db.url (SQL Server) A-2mxe.db.user (Oracle) A-2mxe.db.user (SQL Server) A-2mxe.report.bo.cmsName B-2mxe.report.bo.db.connnectstring B-2mxe.report.bo.db.databaseName (SQL Server, only) B-2mxe.report.bo.rootFolder B-2mxe.report.bo.rptServerLogonName B-2mxe.report.bo.rptServerLogonPass B-2mxe.report.bo.serverURL B-2MXES

patch information 1-2MXES-business objects integration properties B-2

O

opening reportsin Maximo 3-1

P

parameter-based reportsstoring in multiple applications 4-13

parametersadding bound 4-7bound 4-7determining attribute name 4-12running reports with C-2unbound 4-7

previewingreport 4-6

Q

queries C-1quick toolbar C-2

R

reportfeatures not supported in Maximo-Crystal integration C-1folder structure in CMC 5-3previewing 4-6

Report Administration module 4-3report developer/administrator

actions flowchart 4-2, 5-2Report server

configuring C-1

Index-2 Release 6.0, 12/2005

Index

request pageusing to run reports 3-4with a parameter 3-4without a parameter 3-4

Run Report subtabin Business Analysis and Reporting dialog box 3-3

runningreport against all records 3-8report against current record 3-6report against selected records 3-7report with current/selected/all records 3-6

S

scheduling reports C-1searching within a report C-2security privileges

in Crystal Reports C-1setting 5-10

selected recordsrunning report against 3-7using the check box to select 3-7using the table filter 3-7

sending reports via e-mail C-1setting

security privileges 5-10signing in

to Crystal Reports 3-1software 1-2storing reports

in multiple applications 4-4parameter-based in multiple applications 4-13

T

table filterusing to select records 3-7

templates C-2

U

unbound parameters 4-7using

check box to select records 3-7Detail check box for detail reports 4-6request page to run reports 3-4table filter to select records 3-7

V

viewing reports C-1

W

Web Component Adapter 1-1

X

XML codecreating 4-6

Release 6.0, 12/2005 Index-3

Index

Index-4 Release 6.0, 12/2005

Release 6.0, 12/2005

mpd1073_60v4_mx_crystal_01_eng_12/2005

Release 6.0, 12/2005