IBM Maximo Data Loader
IBM Maximo Data Loader
Release 6.2.1
Users Guide
Note
Before using this information and the product it supports, read the information in Notices on page 27.
This edition applies to version 6, release 2, modification 1 of IBM Maximo Data Loader and to all subsequent releases and
modifications until otherwise indicated in new editions. This edition replaces any previous edition of this document.
Portions 1996-2005, i-net software GmbH
Portions 2007 Intrinsyc Software Inc. and its licensors
Portions 2001-2003 PowerTeam, Inc.
Portions 1996-2003 Visual Mining, Inc. Visual Mining NetCharts Server provided by Visual Mining, Inc.
Sentry Spelling-Checker Engine Copyright 2000 Wintertree Software Inc.
Copyright International Business Machines Corporation 2007. All rights reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM
Corp.
Contents
About This Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Related Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 1: Introducing IBM Maximo Data Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2: Data Loader Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Data Loader Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Top Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Load Details Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Object Attributes Frame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Select Action Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Perform Data Load Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Simulation Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Actual Data Load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
View History Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Export Data Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 3: JDBC Configuration Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JDBC Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Top Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JDBC Details Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Action Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test JDBC Configuration Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
13
13
13
14
14
15
15
16
16
17
19
19
19
20
20
20
Chapter 6: Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Contents
iv
Intended Audience
This guide is designed for users who use IBM Maximo Data Loader.
Related Information
For more information about IBM Maximo Data Loader, refer to the following
documentation:
Document
Description
Related Information
IBM 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.
IBM Maximo Data Loader installation creates two additional applications in the
Configuration module: Data Loader and JDBC Configuration.
The IBM 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.
IBM Maximo Data Loader can run in parallel mode on BEA WebLogic which
significantly decreases the load times when appropriate hardware resources are
available. If you expect to run multiple loads simultaneously, consider clustered
servers and multiple Maximo instances.
To run IBM Maximo Data Loader in parallel mode a JMS (Java Message Service)
must be configured before using IBM Maximo Data Loader. The IBM Maximo
Data Loader for WebLogic installation guide provides installation steps for
installing in both parallel and normal modes.
WebSphere can run parallel without additional configuration.
The Data Loader application is used to define the MBO to load and the details of
the load.
There are two tabs in the Data Loader application. The first tab is the standard list
tab. The second tab is the Data Loader tab, where you create load configuration
records
Top Frame
The top frame of the Data Loader tab contains the following attributes.
Load Name - Required
The unique name of the load configuration record.
Copyright IBM Corp. 2007
Description - Optional
The description of the load configuration record.
Attachments - Optional
Use this link to view and download documents attached to this application.
You can download error or log files or you can upload delimited text files to
the Maximo server for processing.
Refer to the IBM Maximo Users Guide for details on using the attached
documents feature.
MBO Name - Required
The name of the MBO to be loaded. Click Select Value to display a list of
valid values.
Parent MBO Name - Optional/Required
The name of the parent of the MBO to be loaded. This field is required to load
an MBO that can only exist if its parent is identified. For example, a POLINE
cannot exist without a PO.
Primary Key - Read Only
The names of the attributes that make up the parent MBOs primary key. If
there is more than one attribute in the primary key, the attribute names are
separated by a comma. Any child loads must contain the primary key
attributes or an error occurs when you try to load the parent.
The Load Details frame of the Data Loader tab contains the following attributes.
Log Directory - Required
The folder to which the load configuration error and log files are written. The
folder must exist on the same server as the Maximo application.
Load Manner - Required
The way IBM Maximo Data Loader loads data into Maximo. Click Select
Value to display a list of valid values. The following are valid values.
6
INSERT
Creates new records. If the data being loaded already exists in Maximo, a
duplicate key error is generated.
INSERTUPDATE
Creates new records or, if the data being loaded already exists in Maximo,
the data is updated. Use this value when the load file contains more new
records than existing records.
UPDATE
Updates the records. If the data being loaded does not exist in Maximo, a
record not found error is generated.
UPDATEINSERT
Updates records or, if the data being loaded does not exist in Maximo,
new records are created. Use this value when the load file contains more
existing records than new records.
NOTE
The Object Attributes frame contains the attributes of the MBO entered in the
MBO Name attribute. The Object Attributes frame of the Data Loader tab contains
the following attributes.
Attribute Name - Read Only
The name of the MBO attribute.
10
Cancel
Stops the load after the current queue is processed. Records queued on the
application server are not cancelled; only records not yet queued to be
processed are cancelled. Use the View History option to see the number of
records that were processed.
Close
Closes the dialog box.
Simulation Load
To run a load process without updating the database, make sure the Simulation?
check box is selected in the Load Details frame of the Data Loader tab. You can
check for errors before the data is actually loaded into the database. Error and log
files are written to the file specified in the Log Directory attribute.
NOTE
Not all errors are identified during a simulation load. Some validations are not
performed until the data is committed to the database.
11
12
JDBC Configuration
Application
Top Frame
The top frame of the JDBC Configuration tab contains the following attributes.
JDBC ConfigName - Required
The unique name of the JDBC configuration record.
Description - Optional
The description of the JDBC configuration record.
JDBC Username - Required
The user name to establish the connection to the JDBC data source. The value
must be a valid user ID that can connect to the database.
JDBC Password - Required
The password for the JDBC Username value.
13
The JDBC Details frame of the JDBC Configuration tab contains the following
attributes.
JDBC Driver - Required
The class name of the JDBC driver used for the connection to the JDBC data
source.
Connection URL - Optional
The address used to connect to the JDBC data source. The format is
<hostname>:<port>:<sid>.
Example
For Oracle 9i, the URL might be jdbc:oracle:thin:@hostname:1521:maximo
If the connection is not established, a message displays describing the error. After
you fix the error, save the JDBC configuration record.
The test can be done for saved records. Be aware that if a JDBC configuration has
an error, there is nothing to stop a user from using it for a JDBC load.
14
Cron Task
You can run data loads through the cron task feature in Maximo. The IBM
Maximo Data Loader installation creates a cron task record in the Cron Task
Setup application. You can schedule as many data loads as you want.
The Cron Task Setup application is under the Configuration module. Search for
the cron task record called MDL.
15
The Cron Task Instances Details frame of the Cron Task tab contains the following
attributes.
Cron Task Instance Name - Required
The unique name of the cron task instance.
Description - Optional
The description of the cron task instance.
Schedule - Required
The frequency or time the instance runs. Click Set Schedule to display the
Select Schedule or Time Interval dialog box.
Refer to the IBM Maximo Users Guide for details on setting schedules.
Run as User - Required
The Maximo user to run this cron task instance. The default is MAXADMIN.
Click Select Value to display a list of valid values.
16
Active? - Optional
If selected, the instance is active.
Last Run Timestamp - Read Only
The date and time this instance was run.
The Cron Task Parameters frame of the Cron Task Setup tab contains the
following attributes.
Parameter - Read Only
The default is LOADNAME for the MDL record.
Value - Required
Type the name of the data load configuration record to be run by this cron
task instance.
Description - Read Only
The default is The name of the data load task that will be launched.
Cron Task
17
18
The delimited text file must contain a single header row with the MBO
attributes and at least one row of data in the same order as the header row
attributes. Each data row corresponds to a database table row.
The first line in the text file must contain the MBO attribute names in
uppercase and must match the MBO attribute names exactly.
All attributes in a row, including the header must be delimited by the same
character.
White spaces do not have to be removed from the input data as long as the
Trim Whitespace? check box is selected before running the load.
,Reflective
,V ,Coppergate House
19
Long Descriptions
To load long description fields, the input file field name must be in the following
format.
<FIELDNAME>_longdescription
Example
ADDRESS1_longdescription
20
Troubleshooting
Error and log files are created at the end of every data load. The files are written
to the folder specified in the Log Directory attribute on the Data Loader tab.
Each line of the error file has the input data plus the data loader error appended
as an extra attribute. This attribute is called MDL_ERROR. The MDL_ERROR
attribute contains the actual error reported by Maximo.
You can correct the errors in the error file and rerun the load configuration using
the error file instead of the original data source. IBM Maximo Data Loader ignores
the MDL_ERROR information so you do not need to remove that information.
However, any attributes in the error file that are not part of the MBO being loaded
will produce the 'Cannot Insert' error.
25
26
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
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.
Copyright IBM Corp. 2007
27
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
Adobe, Acrobat, Portable Document Format (PDF), and PostScript are either
registered trademarks or trademarks of Adobe Systems Incorporated in the
United States, other countries, or both.
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.
Cell Broadband Engine and Cell/B.E. are trademarks of Sony Computer
Entertainment, Inc., in the United States, other countries, or both and is used
under license therefrom.
28
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino
logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are
trademarks or registered trademarks of Intel Corporation or its subsidiaries in
the United States and other countries.
IT Infrastructure Library is a registered trademark of the Central Computer
and Telecommunications Agency which is now part of the Office of
Government Commerce.
ITIL is a registered trademark, and a registered community trademark of the
Office of Government Commerce, and is registered in the U.S. Patent and
Trademark Office.
Linux is a trademark of Linus Torvalds in the United States, other countries, or
both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
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.
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.
29
30