Primavera Integration API Programmer's Reference

Api 8.2 Sampling
Primavera Integration Api 8.2 Download
Primavera Integration Api 8.2 Download Free
Primavera Integration Api 8.2 Download Free

Contents
Introduction
Modes of Operation
Security
Packages
Where to Begin
Session
GlobalObjectManager
EnterpriseLoadManager
Business Objects
JobManager
Batch Exception Handling
Timestamps
Resource Security
XMLExporter
XMLImporter
XML Schema
Performance Tips
Demo Applications

Introduction
The Integration API provides a flexible, object-oriented interface to Primavera's project management functionality. The API is a cross-platform, Java-based interface.

This document provides information on how to use the API. See the Administrator's Guide for information on installing and configuring the API and system requirements. For information on how to use specific classes, see the Javadoc.

Modes of Operation
The API is designed to run in one of two modes: Local or Remote.

Primavera® P6™ Integration API Administrator’s Guide Version 6.2.1 Copyright © 2003, 2009, Oracle. Administrator’s Guide 8 Primavera P6 Integration API. Application layer security for the Integration API is similar to what is used by the Primavera client/server products. To use the API, you must log in as a named user. Global and project security profiles apply when using the API, so if a user attempts to perform an action that is restricted by a security profile, an exception will be thrown.

In Local Mode, the client code runs in the same Java Virtual Machine (JVM) as the Integration server. Java Remote Method Invocation (RMI) is not used, and the Integration API communicates directly with the business rule code in the server (the Business Rule Engine). Local Mode is useful for when the API client code with be deployed on the same physical machine as the internal Business Rule Engine. It can also be useful for applications that require the improved performance achieved by avoiding the RMI layer. Of course, Local Mode could be called directly from JSP pages that are deployed as part of a Web Application.

In Remote Mode, the client code runs on a different machine than the Integration server and Java Remote Method Invocation (RMI) is used for communication. Multiple clients can communicate with the Integration server simultaneously.

Note: The maximum number of clients that can access a remote server at one time is approximately 50. This number may be less, depending on multiple factors including system hardware, network configuration, and even the number of available licenses.

There are three possible service modes for the RMI server: Standard, Compression, and SSL. By default, all three modes are enabled. The RMI server also requires the RMI Registry, which listens to port 9099 by default. You can change the default settings for the RMI server via the Administrator tool, which can be launched using admin.cmd (admin.sh for Solaris). The following settings can be found under ConfigurationsCustom<Configuration Name>IntegrationServerRMI:

Enable - Enables (true) or disables (false) the RMI server (default setting is true).

RegistryPort - Port for the RMI Registry (default setting is 9099).

StandardServiceEnable - Enables (true) or disables (false) the Standard service mode (default setting is true).

StandardServicePort - Port to use for Standard service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.

CompressionServiceEnable - Enables (true) or disables (false) the Compression service mode (default setting is true).

CompressionServicePort - Port to use for Compression service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.

SSLServiceEnable - Enables (true) or disables (false) the SSL service mode (default setting is true).

SSLServicePort - Port to use for SSL service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.

If the API is configured to use Remote Mode, the service mode can be chosen at runtime using the RMIURL helper class: standard, compression, and SSL modes are available. HTTP tunneling may also be used if the HTTP or HTTPS service modes are selected. These additional modes encapsulate RMI communication in HTTP, allowing RMI to communicate through a firewall with only one port required to be open.

Note: P6 Web Services were released with version 6.2 and should be considered as an alternative to using the Remote Mode of the Integration API.

Security
Application layer security for the Integration API is similar to what is used by the Primavera client/server products. To use the API, you must log in as a named user. Global and project security profiles apply when using the API, so if a user attempts to perform an action that is restricted by a security profile, an exception will be thrown.

Network layer security is achievable by using either SSL or HTTPS in Remote Mode. The HTTPS calling mode uses HTTP tunneling, requiring only one port to be open in the firewall.

Note: See the section entitled 'Java Security Manager' in the Administrator's Guide for information on how to enable additional security through the use of a custom security policy.

Packages
Within the jar file, classes in the following packages can be accessed directly by client code:

com.primavera (base classes for Primavera exceptions)
com.primavera.common.exceptions (common exception classes)
com.primavera.common.value (value object classes)
com.primavera.common.value.spread (spread value classes)
com.primavera.integration.client (main classes, including Session, JobManager EnterpriseLoadManager, and GlobalObjectManager)
com.primavera.integration.client.bo (business object base class and iterator classes)
com.primavera.integration.client.bo.enm (typesafe enumerations)
com.primavera.integration.client.bo.helper (business object helper classes)
com.primavera.integration.client.bo.object (client business object classes)
com.primavera.integration.client.xml.exporter (Hierarchical XML exporter and related classes)
com.primavera.integration.client.xml.importer (Hierarchical XML importer and related classes)
com.primavera.integration.client.xml.xmlexporter (Flat XML exporter and related classes - new in version 6.2)
com.primavera.integration.client.xml.xmlimporter (Flat XML importer and related classes - new in version 6.2)
com.primavera.integration.common (general common classes)
com.primavera.integration.network (exception classes for Remote Mode)
com.primavera.integration.util (utility and helper classes)

Other packages in the jar file contain code for internal use only.

Where to Begin
If you will be writing code against the API, the Java Software Development Kit (SDK, also known as the JDK), version 1.5.x, must be installed. The Integrated Development Environment (IDE) used to write code must work with this version. If you will not be writing code, only the Java Runtime Environment (JRE), version 1.5.x, is required to be able to run applications written for the API.

The API client code for Remote Mode is contained in intgclient.jar. For Local Mode, the API code is contained in intgserver.jar. The jar files are installed in the lib directory under the Integration API installation directory. To successfully compile and execute the code written against the API, you will need to include the appropriate jar file in your classpath.

Note: For applications running in Local Mode, your classpath must include the other jar files that are installed in the lib directory under the Integration API installation directory. Local Mode applications must also have the System property 'primavera.boot

Primavera Integration Api 8.2 Download