Tivoli IBM Maximo Adapter for Primavera


Version 7.1

Installation Guide
 Note
Before using this information and the product it supports, read the information in “Notices” on page 13.

This edition applies to version 7, release 1, modification 0 of IBM Maximo Adapter for Primavera and to all
subsequent releases and modifications until otherwise indicated in new editions.
© Copyright International Business Machines Corporation 2008.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. Preparing for installation . . 1 Chapter 4. Configuring the adapter . . . 9
Configuring Primavera API on WebSphere Configuring connection details . . . . . . . . 9
Application Server . . . . . . . . . . . . 1 Configuring the adapter parameters . . . . . . 9
Configuring Primavera API on WebLogic Server . . 2 Configuring logging . . . . . . . . . . . 11
Enabling work location resource scheduling . . . 11
Chapter 2. Installing Maximo Adapter for
Primavera . . . . . . . . . . . . . . 5 Notices . . . . . . . . . . . . . . 13
Enabling the product license . . . . . . . . . 5 Trademarks . . . . . . . . . . . . . . 14

Chapter 3. Deploying the EAR files . . . 7 Index . . . . . . . . . . . . . . . 17

© Copyright IBM Corp. 2008 iii

iv IBM Maximo Adapter for Primavera: Installation Guide
Chapter 1. Preparing for installation
Ensure that you meet the requirements and have the information needed to install
IBM® Maximo® Adapter for Primavera.

Installation requirements

Before you install Maximo Adapter for Primavera, you must have Maximo Asset
Management 7.1 installed on the same server.

Supported versions

The following versions of Primavera products are supported:

v Primavera Project Manager 6.2
v Primavera Project Manager 6.1
v Primavera Integration API 6.2
v Primavera Integration API 6.1 Service Pack 2

Information needed for the installation

You need a Maximo administrator login.

The installation program requires access to middleware servers that are installed
with Maximo Asset Management to automate the deployment of the process
solution package. Before installing, ensure you have all the administrative user IDs
and passwords for the middleware servers.

Server data backups

When you install Maximo Adapter for Primavera, the configuration and content of
your application, database, and directory servers are modified.

Before you run the installation program, create backups of the application,
database, and directory servers.

Configuring Primavera API on WebSphere Application Server

If you use WebSphere® Application Server, make the following changes to the
Primavera Integration API before you install Maximo Adapter for Primavera. These
changes are needed to deploy the Maximo EAR file.

Before you begin

For local mode, the Primavera Integration API must be installed on the same
server as the Maximo application server.

For remote mode, the Primavera Integration API client must be installed on the
same server as the Maximo application server.

© Copyright IBM Corp. 2008 1

 Procedure
1. From the WebSphere console, add to the Classpath field the paths to the
Primavera API files. For remote mode, enter the path to the intgclient.jar file.
For local mode, enter the paths to all jar files from the Primavera API lib folder.

For: Add these paths:

Remote mode Primavera API root\clientlib\intgclient.jar.

Local mode using Primavera API root\lib\activation.jar;Primavera API

Primavera Integration root\lib\commons-lang.jar;Primavera API
API 6.2 root\lib\commons-logging.jar;Primavera API
root\lib\intgserver.jar;Primavera API
root\lib\jdom.jar;Primavera API root\lib\
log4j.jar;Primavera API root\lib\mail.jar;Primavera API
root\lib\ojdbc5.jar;Primavera API root\lib\
serializer.jar;Primavera API root\lib\
spring.jar;Primavera API root\lib\sqljdbc.jar;Primavera
API root\lib\stax-api-1.0.1.jar;Primavera API
root\lib\wstx-asl-3.1.2.jar;Primavera API
root\lib\xalan.jar;Primavera API root\lib\
xercesImpl.jar;Primavera API root\lib\xml-apis.jar;

Local mode using Primavera API root\lib\activation.jar;Primavera API

Primavera Integration
API 6.1 SP2
root\lib\bcprovjdk14- 119.jar;Primavera API
root\lib\commons-lang.jar;Primavera API
root\lib\commons-logging.jar;Primavera API
root\lib\intgserver.jar;Primavera API
root\lib\jdom.jar;Primavera API root\lib\
k3.jar;Primavera API root\lib\log4j.jar;Primavera API
root\lib\mail.jar;Primavera API root\lib\
ojdbc14.jar;Primavera API root\lib\
serializer.jar;Primavera API root\lib\
spring.jar;Primavera API root\lib\sqljdbc.jar;Primavera
API root\lib\xalan.jar;Primavera API root\lib\
xercesImpl.jar;Primavera API root\lib\xml-apis.jar

2. For local mode, enter the following in the Generic JVM arguments field:
-Dprimavera.bootstrap.home=Primavera API root
3. Set the API URL field on the Labor record to point to the Primavera Integration
API URL.
v For remote mode, enter the computer name and port for the API URL, in the
form pcname:port. The default port is 9099.
v For local mode, enter localhost.

Configuring Primavera API on WebLogic Server

If you use BEA WebLogic Server, make the following changes to the Primavera
Integration API before you install Maximo Adapter for Primavera. These changes
are needed to deploy the Maximo EAR file.

Before you begin

For local mode, the Primavera Integration API must be installed on the same
server as the Maximo application server.

2 IBM Maximo Adapter for Primavera: Installation Guide

For remote mode, the Primavera Integration API client must be installed on the
same server as the Maximo application server.

About this task

For this procedure, use the correct file extension and slash for your operating
system.

Procedure
1. Using a text editor, open the startWebLogic file in the BEA
dir\user_projects\domains\Maximo Server directory.
2. Search for set CLASSPATH=.
3. Add the paths to the Primavera API files between the equal sign and
%SAVE_CLASSPATH%. For remote mode, add the path to the intgclient.jar file.
For local mode, add the paths to all jar files from the Primavera API lib folder.

For: Add these paths:

Remote mode Primavera API root\clientlib\intgclient.jar;

Local mode using Primavera API root\lib\activation.jar;Primavera API

Primavera Integration root\lib\commons-lang.jar;Primavera API
API 6.2 root\lib\commons-logging.jar;Primavera API
root\lib\intgserver.jar;Primavera API
root\lib\jdom.jar;Primavera API root\lib\
log4j.jar;Primavera API root\lib\mail.jar;Primavera API
root\lib\ojdbc5.jar;Primavera API root\lib\
serializer.jar;Primavera API root\lib\
spring.jar;Primavera API root\lib\sqljdbc.jar;Primavera
API root\lib\stax-api-1.0.1.jar;Primavera API
root\lib\wstx-asl-3.1.2.jar;Primavera API
root\lib\xalan.jar;Primavera API root\lib\
xercesImpl.jar;Primavera API root\lib\xml-apis.jar;

Local mode using Primavera API root\lib\activation.jar;Primavera API

Primavera Integration root\lib\bcprovjdk14- 119.jar;Primavera API
API 6.1 SP2 root\lib\commons-lang.jar;Primavera API
root\lib\commons-logging.jar;Primavera API
root\lib\intgserver.jar;Primavera API
root\lib\jdom.jar;Primavera API root\lib\
k3.jar;Primavera API root\lib\log4j.jar;Primavera API
root\lib\mail.jar;Primavera API root\lib\
ojdbc14.jar;Primavera API root\lib\
serializer.jar;Primavera API root\lib\
spring.jar;Primavera API root\lib\sqljdbc.jar;Primavera
API root\lib\xalan.jar;Primavera API root\lib\
xercesImpl.jar;Primavera API root\lib\xml-apis.jar:

For example: set CLASSPATH=Primavera API root\clientlib\intgclient.jar;

%SAVE_CLASSPATH%
4. For local mode:
a. Search for Dweblogic.Name=%SERVER_NAME%.
b. Add the following JVM argument at the end of the line, as follows:
Dweblogic.Name=%SERVER_NAME% -Dprimavera.bootstrap.home=Primavera API
root
5. Save and close the file.

Chapter 1. Preparing for installation 3

 6. Set the API URL field on the Labor record to point to the Primavera Integration
API URL.
v For remote mode, enter the computer name and port for the API URL, in the
form pcname:port. The default port is 9099.
v For local mode, enter localhost.

4 IBM Maximo Adapter for Primavera: Installation Guide

Chapter 2. Installing Maximo Adapter for Primavera
Install and deploy Maximo Adapter for Primavera through the process solution
installation program.

Before you begin

v If you use IBM WebSphere Application Server, ensure that the middleware
servers are started. Start all middleware servers before you run the installation
program. The installation program attempts to connect to the middleware
servers by using the middleware login information that you specify.
v If you use BEA WebLogic Server, ensure that the application server
(MAXIMOSERVER) is stopped. If the application server is running, stop the
server and wait a few minutes before you start the installation program. If the
application server is not stopped, the installation process stops.

Procedure
1. Insert the Maximo Adapter for Primavera DVD in the DVD drive. The
launchpad starts automatically. If the Windows® autorun feature is disabled,
you can start the launchpad by running the launchpad.exe program from the
root directory of the product DVD.
2. In the Welcome window, select the language for the installation, then click
Install the product on the left side of the screen.
3. Click the link under 1. Install IBM Maximo Adapter for Primavera.
4. In the next installation windows, click OK or Next.
5. In the Software License Agreement window, select I accept the terms in the
license agreement, then click Next.
6. In the Middleware Login Information window, enter the login credentials for
the middleware servers, then click Next.
7. In the Package Options windows, clear the Supported Package Options check
boxes to have the EAR files redeployed and the Maximo database updated by
the installation program.
8. In the Pre-install Summary window, click Next. The Deployment Progress
window shows the progress of the installation.
9. When the installation is complete, in the Package Successfully Deployed
window, click Done.

Enabling the product license

You must enable the license before you can use the product.

Procedure
1. From the launchpad, click the link under Enable IBM Maximo Adapter for
Primavera License for usage.
2. Follow the steps in the wizard. When the installation is complete, in the
Package Successfully Deployed window, click Done.

© Copyright IBM Corp. 2008 5

 What to do next

If you use BEA WebLogic Server, manually redeploy the EAR files. Otherwise,
configure the adapter.

6 IBM Maximo Adapter for Primavera: Installation Guide

Chapter 3. Deploying the EAR files
If you use BEA WebLogic Server, you must deploy the EAR files from the
WebLogic Server Console after you install Maximo Adapter for Primavera.
Deploying the EAR files starts the application server.

Before you begin

To view the WebLogic Server Console, you must have a Java™ Virtual Machine
installed.

Procedure
1. Start the BEA WebLogic Server.
a. Change to the mydomain directory: drive_letter:\BEA_installation_location\
user_projects\domain\mydomain (Windows) or /home/mxadmin/bea/
user_projects/domains/mydomain (UNIX®).
b. Enter startWebLogic.cmd (Windows) or ./startWebLogic.sh (UNIX).
Message ″Server started in RUNNING mode″ displays when the WebLogic
Server starts running.
2. Start the Administration Console by typing the following URL in the address
bar of your browser : http://<host name>:7001/console
3. Follow the instructions in the WebLogic Console help to deploy maximo.ear
and then maximohelp.ear.

© Copyright IBM Corp. 2008 7

8 IBM Maximo Adapter for Primavera: Installation Guide
Chapter 4. Configuring the adapter
Configure the parameters for connection with Primavera. Optionally, configure
Maximo Adapter for Primavera parameters and logging for your environment, and
enable work location resource scheduling to work with multiple locations.

Configuring connection details

Configure Primavera connection details in the Labor (PV) application in Maximo.
Any Maximo labor record with the Primavera Connection Details fields completed
can transfer data between Maximo and Primavera P6.

Procedure
1. In Maximo, select Go To → Administration → Resources → Labor (PV), then
select the Primavera tab.
2. In the User Name and Password fields, specify the credentials that the adapter
uses to sign into Primavera P6. This user name must exist in the Primavera P6
application and must have Primavera API privileges.
3. In the API URL field, type the URL of the RMI Primavera API server. The
format is: <hostname>:<port>, where <hostname> can be localhost, the remote
host name, or the host IP address in dotted decimal format.
4. In the Primavera DB Name field, type the name of the database to use with
Primavera P6.
5. To test the connection, click the Test Connection button.

Configuring the adapter parameters

Configure the Maximo Adapter for Primavera parameters in Maximo as required
for your environment.

Procedure
1. In Maximo, select Go To → System Configuration → Platform Configuration →
System Properties.
2. Select the parameter that you want to configure, then type its value in the text
box. You can configure the following parameters:

Parameter Description Valid values

mxe.primavera.status.notstarted
mxe.primavera.status.inprogress
Determines the One or more strings of
Maximo work order <Maximo_status>.
statuses that are Default: <CAN><WAPPR>
translated into a <WMATL><WPCOND>
Primavera activity <WSCH><APPR>
status of notstarted.
Determines the One or more strings of
Maximo work order <Maximo_status>.
statuses that are Default: <INPRG><HISTEDIT>
translated into a
Primavera activity
status of inprogress.

© Copyright IBM Corp. 2008 9

 Parameter Description Valid values
mxe.primavera.status.completed Determines the One or more strings of
Maximo work order <Maximo_status>.
statuses that are Default: <COMP><CLOSE>
translated into a
Primavera activity
status of completed.
mxe.primavera.nodesc Determines the Text enclosed in double
description of a quotation marks.
work order when Default: “NO DESCRIPTION”
no description is
provided. You can
also use this
parameter to name
a project when no
project description
is provided.
mxe.primavera.cache.validatefreq Indicates the Numeric value. Default: 7
frequency, in days,
to run a full
validation of the
PLUSVCACHE
table. The validation
occurs the first time
an export or import
operation is
performed after the
number of days
specified. This
parameter is used to
ensure the
synchronization of
resource records
between Maximo
and Primavera.
mxe.primavera.leadingzero Indicates whether Y (default) - The leading zeros
leading zeros on are removed.
work order N - The leading zeros
numbers are are not removed.
removed when the
work orders are
exported to
Primavera.
mxe.primavera.exportcalendars Indicates whether Y (default) - Maximo calendars
Maximo calendars are exported.
are exported to N - Maximo calendars
Primavera. are not exported.
mxe.system.globallog Indicates whether Y (default) - The user name
the user name of is not logged.
each user is logged N (default) - The user name
before messages is logged.
related to that user
in the adapter log
file.

10 IBM Maximo Adapter for Primavera: Installation Guide

Configuring logging
Configure logging for Maximo Adapter for Primavera using the standard Maximo
logging mechanism.

For information about logging configuration, refer to the Maximo documentation.

Enabling work location resource scheduling

If work location resource scheduling is enabled, you can define, schedule, and
manage resources for multiple sites.

About this task

Enabling work location resource scheduling affects all organizations, sites, and
projects.

To enable work location resource scheduling:

Procedure
1. In Maximo, select Go To → Administration → Organizations (PV).
2. On the Select Action menu, select Primavera Options, then System Options.
3. Select the Schedule by Work Location check box and click OK.
4. If you want to specify the work location prefix that is added to all craft records
exported to Primavera P6, complete the following steps for each location The
work location prefix must be unique within an organization. If you do not
specify a prefix, the site ID of the work order is added to the craft records.
a. Select Assets → Locations.
b. Retrieve the location record.
c. On the Location tab, type a value in the Work Location Prefix field.
d. Save the record.

Chapter 4. Configuring the adapter 11

12 IBM Maximo Adapter for Primavera: Installation Guide
Notices
This information was developed for products and services offered in the U.S.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information about 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.

IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

© Copyright IBM Corp. 2008 13

 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:

U.S.A.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 information 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
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol (® or ™), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common
law trademarks in other countries. A current list of IBM trademarks is available on
the Web at “Copyright and trademark information” at http://www.ibm.com/
legal/copytrade.shtml.

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 of Sun Microsystems,
Inc. in the United States, other countries, or both.

14 IBM Maximo Adapter for Primavera: Installation Guide

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 15
16 IBM Maximo Adapter for Primavera: Installation Guide
Index
C
configuration 9
connection details 9

E
EAR deploying 7

I
installation
information needed 1
preparation 1
requirements 1
using PSI 5

L
license enablement 5
logging 11

P
parameters 9
preparation for installation 1
Primavera API configuration
on WebLogic 2
on WebSphere 1
PSI (process solution installer)
installation 5

R
requirements
installation 1
resource scheduling 11

W
work location resource scheduling 11

© Copyright IBM Corp. 2008 17

18 IBM Maximo Adapter for Primavera: Installation Guide


Printed in USA