Maximo Data Loader

Maximo Release 6.2

Installation Guide WebSphere

Note Before using this information and the product it supports, read the information in Notices on page Notices-1.

First Edition (November 2006) This edition applies to Release 6.2 of Maximo Data Loader and to all subsequent releases and modifications until otherwise indicated in new editions. Third-Party Technology: Certain Maximo products contain technology provided under license from third parties, as noted in the following table: IBM Product All Products IBM Maximo Third-Party Information Portions 1996-2003 Visual Mining, Inc. Visual Mining NetCharts Server provided by Visual Mining, Inc. Portions 1995-2004 Actuate Corporation. Portions 2005 BEA Systems, Inc. BEA WebLogic Server provided by BEA Systems, Inc. Portions 1996-2005, i-net software GmbH. J-Integra for COM v2.4. 2004 Intrinsyc Software International, Inc. Maximo Discovery MSDE Copyright Microsoft Corporation. 1998-2005 Centennial Software Limited. IBM Maximo Asset Navigator Portions 1993-2002 Snowbound Software Corporation. RasterMaster Raster imaging technology provided by Snowbound Software Corporation. Portions 2005 DataMirror, Inc. Portions 2000-2005 Zaval Creative Engineering Group. IBM Maximo Mobile SE Portions 1996-2005 Syclo, LLC.

IBM Maximo Mobile

Open Source: Maximo contains computer software obtained from the public domain, known as "Open Source" ownership of which is attributed as follows: Portions 2002, Steve Souza (admin@jamonapi.com). Portions 2000-2004, Jason Hunter & Brett McLaughlin. Portions 2004-2005, The Apache Software Foundation (http://www.apache.org/). Copyright International Business Machines Corporation 2006. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Chapter 1: Introducing Maximo Data Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Chapter 2: Installing Maximo Data Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Required Skills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Supported Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Chapter 3: Testing the Maximo Data Loader Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Chapter 4: Uninstalling Maximo Data Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Chapter 5: Additional Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Adding Date Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notices-1

Copyright IBM Corp. 2006

iii

iv

Maximo Data Loader: Installation Guide

About This Guide

This section explains how this guide can help you to use Maximo Data Loader. It also provides information about other IBM Corporation resources available to you, such as additional documentation and support.

Audience
This guide is designed for Maximo System Administrators or others tasked with the installation and configuration of Maximo Data Loader.

Related Documentation
For more information about Maximo Data Loader, refer to the following documentation:. Document Maximo Data Loader Users Guide Maximo Users Guide Description Contains information on using Maximo Data Loader. Provides an overview of the Maximo end user applications, and describes how the Maximo applications interact with each other. Describes database configuration, security, and other administrative level applications and tasks. Contains information on configuring an application running on a WebSphere server.

Maximo System Administrators Guide Maximo Installation Guide (Microsoft Windows|IBM WebSphere)

Copyright IBM Corp. 2007

Related Documentation

vi

Maximo Data Loader: Installation Guide

Introducing Maximo Data Loader

Maximo Data Loader is a tool that loads any Maximo database table through the Maximo application. The database table must be represented by a Maximo business object (MBO). By loading data through the Maximo application instead of directly into the database, data is validated against the application business rules, including any client specific rules. Therefore, only valid data is loaded. Maximo Data Loader installation creates two additional applications in the Configuration module: Data Loader and JDBC Configuration. The Maximo Data Loader application is used to define the MBO to load and the details of the load. The JDBC Configuration application is where you configure a JDBC connection to an external data source.

Copyright IBM Corp. 2007

1-1

1-2

Maximo Data Loader: Installation Guide

Installing Maximo Data Loader

This chapter explains how to install Maximo Data Loader.

Required Skills
To perform the installation, you must be familiar with the following: Creating folders, editing text files, and running scripts Use utilities such as Enterprise Manager or SQL*Plus RDBMS system administration privileges Familiar with rebuilding and redeploying EAR files

Supported Versions
Maximo Data Loader is supported on the following Maximo version: Maximo 6.2 You can find out what Maximo version is installed by running the version.bat file in the <Maximo dir>\applications\maximo folder. You must open a DOS window to run the file. Maximo Data Loader is supported on the following application server: IBM WebSphere 6 Maximo Data Loader is supported on the following databases: Oracle 9i SQL Server 2000

Prerequisites
The following must be installed and working correctly before installing Maximo Data Loader. Maximo 6.2
Copyright IBM Corp. 2007

2-1

Installation Steps Maximo 6.2 Application Designer

Installation Steps
Complete the following steps to install Maximo Data Loader.

1 Stop the Maximo application server and exit all other Windows programs
(e.g. Word, Excel) before continuing. You can leave Windows Explorer open.

2 Backup the folder where Maximo is installed (usually C:\Maximo). 3 Install the Maximo Data Loader files by extracting the files from the
62_mx_mdl.zip file into the directory where Maximo is installed (usually C:\Maximo).

4 Edit the maximo.properties file located in the <Maximo dir>\

applications\maximo\properties folder and add the following code to the end of the file.
#--------------------# Properties for MDL #--------------------mxe.mdl.rootdir=c:\\MXES\\mdlfiles

The mxe.mdl.rootdir property is where Maximo Data Loader is installed, which should be where Maximo is installed. Enter the path that is appropriate for your environment. NOTE For Windows, use either "\\" or "/" in the path.

5 Save and close the file. 6 Sign into a SQL editor as the Maximo database owner, usually user
MAXIMO.

7 Run the script to install database objects and attributes. The script is

located in the <Maximo dir>/applications/maximo/businessobjects/classes/ psdi/pssolutions/sql folder. Oracle: Run the mdl.ora script. SQL Server: Run the mdl.sql script. DB2: Run the mdl.db2 script.

8 Close the SQL editor.

2-2
Maximo Data Loader: Installation Guide

Installation Steps

9 Open a DOS window. 10 Run the configdb.bat file to update the database with the objects and
attributes added above. The file is located in the <Maximo dir>\tools\ maximo folder.

11 Close the DOS window. 12 Configure the Attached Documents functionality by completing the
following steps. The standard Attached Documents functionality must be set up before adding the Maximo Data Loader information.

Create an additional subdirectory under docklinks named MDL. Using the example from the Maximo System Administrators Guide, you will have the directory d:\doclinks\mdl. You can add subdirectories to the MDL folder if you want to further segregate MDL documents.

b Edit the web.xml file in the doclinks/WEB-INF folder. Add the

following MIME types.
<mime-mapping> <extension>mdlerr</extension> <mime-type>application/x-java-class</mime-type> </mime-mapping> <mime-mapping> <extension>mdllog</extension> <mime-type>application/x-java-class</mime-type> </mime-mapping>

Save and close the web.xml file.

13 Rebuild and redeploy the Maximo EAR files. 14 Start the Maximo server. 15 Sign into Maximo. 16 Import the Maximo Data Loader application files by completing the
following steps.

Go to Configuration > Application Designer.

b Select the Export System XML option from the Select Action menu. c
Export the current Maximo lookups. Choose the Export Systems XML option and save the information to a file.

d Open the lookups.xml file located in the <Maximo dir>\resource

\presentations\system\mdl folder.

e f

Search for a <table> tag. Copy all text between the first <table> tag and the last </table> tag. Open the file created in Step c. Paste the copied table data inside the <systemlib> tag, among the existing <table> tags. 2-3

Installing Maximo Data Loader

Installation Steps

Save and close the file.

h Go to Configuration > Application Designer. i j k

Import the loadconfig.xml file located in the <Maximo dir>/ resources/presentations folder. Import the jdbcconfig.xml file located in the <Maximo dir>/ resources/presentations folder. Import the file created in Step f. Refer to the Application Designer online help for details on importing files.

17 Add documents to the Attached Documents directories by completing the

steps in the "Using Attached Documents" section in Chapter 2: Getting Started chapter in the Maximo Users Guide.

Maximo Data Loader is now installed. Refer to the Maximo Data Loader Users Guide for information on using the application.

2-4

Maximo Data Loader: Installation Guide

Testing the Maximo Data Loader Installation

The Maximo Data Loader installation comes with test scripts that create a load configuration for a delimited text file and a load configuration for a JDBC data source. This script will create a load configuration for a delimited text file, a JDBC configuration, and load configuration for a JDBC data source. If the LOCATIONS table or MBO has been customized, the test may not work correctly. Complete the following steps to test the Maximo Data Loader installation. Delimited Text File This test loads data from a delimited text file.

1 Edit the test configurations. Open the appropriate file located in the

<Maximo dir>\applications\maximo\businessobjects\classes\psdi\ pssolutions\examples\mdl folder. Oracle: Open the createTestConfiguration.ora file. SQL Server: Open the createTestConfiguration.sql file. DB2: Open the createTestConfiguration.db2 file.

2 Replace all occurrences of USERSITEID and USERORGID with the site

and organization IDs for your Maximo installation

3 Save and close the file. 4 Sign into a SQL editor as the Maximo database owner, usually user
MAXIMO.

5 Run the test configuration script you edited in Step 1. 6 Close the SQL editor. 7 Edit the location.txt file located in the <Maximo dir>\applications\
maximo\businessobjects\classes\psdi\pssolutions\examples\mdl folder.

Copyright IBM Corp. 2007

3-1

8 Replace all occurrences of USERSITEID and USERORGID with the site

and organization IDs for your Maximo installation

9 Save and close the file. 10 Sign into Maximo. 11 Go to Configuration > Data Loader. 12 Search for configuration names starting with MDLTEXT. Two records
should be listed.

13 Select the MDLTEXTEST1 configuration. 14 If necessary, change the Log Directory to something appropriate for the
current Maximo application.

15 If necessary, change the Text File Name value to <Maximo dir>\

applications\maximo\businessobjects\classes\psdi\pssolutions\ examples\mdl\location.txt.

16 Save the record. 17 Load the data by selecting the Perform Data Load option from the Select
Action menu. Click Refresh on the Status dialog box to monitor the progress of the data load. The records should fail to load.

18 Examine the log files either on the server or download them using the

Attachments function. The error file should show that the required field TYPE is blank.

19 Correct the load configuration by completing the following steps. a

Click on the Attribute Name column header in the Object Attributes table window to sort the attributes in alphabetical order.

b Click the Attribute Name column header again to sort in reverse order. c
Select the TYPE attribute.

d Set the Default value to a valid value for your Maximo application. For
example LABOR. Save the record.

20 Load the data again by selecting the Perform Data Load option from the

Select Action menu. Click Refresh on the Status dialog box to monitor the progress of the data load. The records should successfully load.

21 View the loaded location records. Go to Assets > Locations and search for
locations beginning with REF. Three location records should display. JDBC Connection This test tests the JDBC configuration. The JDBC configuration must match the Maximo JDBC connection parameters.

22 Go to Configuration > JDBC Configuration.

3-2
Maximo Data Loader: Installation Guide

23 Search for configuration records starting with MDLTEST. One record

should be listed.

24 Select the MDLTESTJDBC1 record. 25 Replace "insert driver", "insert user", "insert password", and "insert url"
with the appropriate values for the JDBC connection for the test. The current JDBC connection values for your Maximo installation can be found in the maximo.properties file located in the <Maximo dir>\ applications\maximo\properties folder.

26 Select the Test JDBC Connection option under the Select Action menu. 27 You should receive the "JDBC Configuration tests passed OK!" message.
If not, correct the parameters above for the appropriate source database.

28 Save the configuration.

JDBC Data Source This test loads data from a JDBC data source.

29 Go to Configuration > Data Loader. 30 Search for configuration records starting with MDLJDBC. One record
should be listed.

31 Select the record. 32 If necessary, change the Log Directory to something appropriate for the
current Maximo application.

33 Save the record. 34 Load the data by selecting the Perform Data Load option from the Select
Action menu. Click Refresh on the Status dialog box to monitor the progress of the data load. The records should successfully load.

35 View the loaded location records. Go to Assets > Locations and search for
locations beginning with RREF. Three location records should display. The test of the Maximo Data Loader installation is completed. Removing Test Data To remove the test data from the Maximo database, complete the following steps.

1 Sign into a SQL editor as the Maximo database owner, usually user
MAXIMO.

2 Clear the test configurations. Run the appropriate file located in the
<Maximo dir>/applications/maximo/businessobjects/classes/psdi/ pssolutions/examples/mdl folder. Oracle: Run clearTestConfiguration.ora.

Testing the Maximo Data Loader Installation

3-3

SQL Server: Run clearTestConfiguration.sql.

DB2: Run clearTestConfiguration.db2.

3 Make sure there are no errors. 4 Close the SQL editor.

The test data is now removed from the Maximo database.

3-4

Maximo Data Loader: Installation Guide

Uninstalling Maximo Data Loader

Complete the following steps to uninstall Maximo Data Loader.

1 Open the uninstall file located in the <Maximo dir>\applications\

maximo\businessobjects\classes\psdi\pssolutions\sql folder. Oracle: Open the uninstall_ora.xml file and set the following parameters to reflect your Maximo installation.
dir.mxes dir.oracle.home mdl.db.sid mdl.db.host mdl.db.username mdl.db.password

SQL Server: Open the uninstall_sql.xml file and set the following parameters to reflect your Maximo installation.
dir.mxes mdl.db.host mdl.db.port mdl.db.username mdl.db.password mdl.db.dbname

DB2: Open the uninstall_db2.xml file and set the following parameters to reflect your Maximo installation.
dir.mxes dir.db2.home mdl.db.host mdl.db.username mdl.db.password

2 Save and close the file. 3 Open the uninstall cmd file located in the <Maximo dir>\applications\
maximo\businessobjects\classes\psdi\pssolutions\sql folder.

Copyright IBM Corp. 2007

4-1

Oracle: Open the mdl.uninstall_ora.cmd file and replace the MXES_HOME text to reflect your Maximo installation. SQL Server: Open the mdl.uninstall_sql.cmd file and replace the MXES_HOME text to reflect your Maximo installation. DB2: Open the mdl.uninstall_db2.cmd file and replace the MXES_HOME text to reflect your Maximo installation.

4 Save and close the file. 5 Open a DOS window. 6 Run the uninstall cmd file you edited in Step 3 to delete all Maximo Data
Loader records from the database and Maximo Data Loader files from the Maximo installation.

7 Close the DOS window. 8 Rebuild and redeploy the Maximo EAR files. See the Maximo System
Administrators Guide for details.

4-2

Maximo Data Loader: Installation Guide

Additional Information
Adding Date Formats

Maximo Data Loader can use a wide variety of date formats. See the Maximo Data Loader Users Guide for the formats that are included with the installation. Any format supported by the SimpleDateFormat java class can be configured into Maximo Data Loader. For more information on the SimpleDateFormat class, see the API specification on the Sun website http://java.sun.com/j2se/ 1.4.2/docs/api/java/text/SimpleDateFormat.html. To add a date format for Maximo Data Loader, add a new entry to the MDLDATEFORMAT domain. See Maximo System Administrators Guide for details on adding new values to existing domains.

Copyright IBM Corp. 2007

5-1

Adding Date Formats

5-2

Maximo Data Loader: Installation Guide

Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those
Copyright IBM Corp. 2007

Notices-1

Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks
AIX, IBM, IBM Corporation, the IBM logo, Tivoli, and WebSphere are registered trademarks of the International Business Machines Corporation in the United States, other countries, or both. Intel, the Intel logo, and Pentium are registered trademarks of the Intel Corporation in the United States, other countries, or both. Microsoft, Windows, and Internet Explorer are registered trademarks of Microsoft Corporation in the United States, other countries, or both.

Notices-2

Maximo Data Loader: Installation Guide

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Sun, Sun Microsystems, the Sun logo, and Solaris are trademarks of Sun Microsystems, Inc. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, and service names may be trademarks or service marks of others.

Notices-3

Notices-4

Maximo Data Loader: Installation Guide