IInnttrroodduucciinngg PPrriimmaavveerraa GGaatteewwaayy

RReelleeaassee 11..00

MMaarrcchh 22001133

3

Contents

Introducing Primavera Gateway ........................................................................................................ 5

Overview ............................................................................................................................................. 5

Installing Primavera Gateway ........................................................................................................... 7

Gateway Configuration Utility ........................................................................................................... 8

Creating Users ................................................................................................................................. 11

Configuring the Third-Party Provider .............................................................................................. 13

Adding Configuration Deployments ................................................................................................ 14

Creating Business Flows ................................................................................................................. 15

Synchronizing the Data ................................................................................................................... 17

Legal Notices ................................................................................................................................... 19

5

Overview

Primavera Gateway is an application that facilitates sharing project and resource information

between P6 EPPM and third-party applications, enabling you to combine P6's project portfolio

management and scheduling functionality with other enterprise software.

Primavera Gateway is comprised of three main components:

Gateway application: Web application that synchronizes data between P6 EPPM and

third-party application using business data flows and XML files.

P6 provider: Java package that contain the data definitions and mappings of the P6 EPPM

fields to be exchanged between the third-party system and P6 EPPM.

Third-party provider: Java package that contain the data definitions and mappings of the

third-party fields to be exchanged between P6 EPPM and the third-party system.

Primavera Gateway consists of three user roles to execute tasks in the application:

Developer role: Create data mappings and flow types.

User role: Synchronize data between two systems and monitor the results.

Admin role: Super-user role that enables the user to perform all actions in the application.

Introducing Primavera Gateway

6

Primavera Gateway includes three business flow types that define data that can be moved

between deployments, and the direction the data will move. The developer or admin creates the

business flow type templates to use in synchronizations.

Import Master Data: Moves third-party global-level data into P6 EPPM.

Import Project Data: Moves third-party project-level data into P6 EPPM.

Export Project Data: Moves P6 EPPM project-level data into third-party system.

7

Installing Primavera Gateway

Primavera Gateway is a Web application installed using the Oracle Universal Installer with media

files. The installer includes creating and deploying Gateway in a WebLogic environment, creating

the database schema, and providing a sample third-party provider if selected.

For details on how to install the Primavera Gateway, refer to the Primavera Gateway Installation

and Configuration Guide.

There are several prerequisites required and recommended before beginning the installation of

Primavera Gateway:

Oracle database: With an Oracle database server installed, create a database instance for

the Gateway environment. The Gateway installer will create the schema needed in the

database instance you specify.

WebLogic: This release of Gateway only supports WebLogic 11g (10.3.6) with the WebLogic

7BWI patch applied. With WebLogic installed, the Gateway installer will create WebLogic

domain needed for the environment.

P6 EPPM database: This release of Gateway supports both P6 EPPM 8.2 and P6 EPPM 8.3.

Although the P6 EPPM database is required for use of the Gateway, it does not prevent the

Gateway from being installed.

P6 Adapter: This adapter is available in the Primavera P6 EPPM media pack. Although the P6

adapter is required for use of Gateway, it does not prevent Gateway from being installed.

For details on how to install the P6 Adapter, refer to the Installing and Configuring the P6

Adapter document.

For details on the specific versions tested with this release, refer to the Tested Configurations

document.

To access this feature:

Navigate to the downloaded and extracted media pack content,

GatewayInstaller\installer\<your platform>\Disk1\install directory, then double-click the setup.exe

file. <your platform> represents the operating system for which you are installing Primavera

Gateway.

8

Gateway Configuration Utility

There are three configuration utilities that can be used to update and maintain the Primavera

Gateway environment:

New Database: Use DBSetup-Install to create a new Gateway schema database. This utility is

used when installing the Primavera Gateway application. If the database schema already exists, it

will be deleted and recreated.

9

P6 Setup Utility: Use DBSetup-SetupUtility to add third-party application user-defined fields (UDFs)

and codes to P6 EPPM. This prepares both environments for synchronization of assignments and

values into those fields.

10

Update Database: Use DBSetup-Update to make changes to the metadata (PDI and third-party) or

swap out the third-party provider files. There are four functions:

Replace Gateway Metadata: Replace existing data. This option will remove existing data

associated with the PDI and third-party provider and replace them with the data provided.

Update Gateway Metadata: Update existing data. This option will not delete existing data. It

is ideal for updating field mapping templates with new information.

Customize Gateway Metadata: Add fields, custom metadata (UDFs), Java custom

mappings, and flow definition customizations to the Primavera Gateway schema.

Swap ERP Provider: Replace the existing third-party provider. This option will replace the

data in all of the tables that are associated with the existing third-party schema. The data

associated with business flows and schedules will remain intact.

For more details on using the Gateway Configuration Utility to create a new database or add

third-party application UDFs and codes to P6, refer to the Primavera Gateway Installation and

Configuration Guide.

For more details on using the Gateway Configuration Utility to update the metadata and swap the

third party provider files, refer to the Primavera Gateway Developers Guide.

To access this feature:

All the utilities are available in the Primavera Gateway_home>\pdi\snapshots\dbsetup

folder. Launch the file appropriate for your environment and associated with the task you would

like to complete:

DBSetup-Install

DBSetup-SetupUtility

DBSetup-Update

11

Creating Users

Users and roles for the Primavera Gateway application are created in the WebLogic domain. User

access and available functions in Gateway will depend on roles assigned to the user. Gateway

installs three roles:

PrimaveraGatewayDeveloper: A user assigned to this role will have access to create the

flow type and field mapping templates of the data available to be transferred between

deployments. This user will also have access to add, edit or delete the deployment

connection information for the systems sharing the data. When the user logs into Primavera

Gateway, he will see the Data Dictionary, Flow Type and Configuration sections.

PrimaveraGatewayUser: A user assigned to this role will have access to add, edit, delete

and run scheduled data transfer between deployments. The user will also be able to

monitor the results of the scheduled jobs. When the user logs into Primavera Gateway, he

will see the Synchronization and Monitoring sections.

PrimaveraGatewayAdmin: A user assigned to this role is a super-user and will have access to

perform all functions in the application.

12

To access this feature:

Log into your WebLogic Server Administrator Console. The users are created in Security Realms ->

myrealm -> Users and Groups section.

13

Configuring the Third-Party Provider

The Third-Party Provider is a group of XML files that contain the data definitions and mappings of

the third-party fields to be exchanged between P6 EPPM and the third-party system. Primavera

Gateway is shipped with a sample third-party provider for use in developing a provider.

Developing a third-party provider involves the following steps:

Determine data to be exchanged between the third-party system and P6 EPPM.

Design and create data definition XML files that include this data.

Determine flows to support integration of the data.

Write the Java provider code that supports these flows.

Create a provider description XML file.

Package all of the artifacts together so that they can be installed.

Install and test the third-party provider.

When determining data to exchange between the two systems, use the Data Dictionary for P6 in

Primavera Gateway to view business object fields and descriptions.

For more details on developing a third-party provider, refer to the Primavera Gateway Developers

Guide.

To access this feature:

The third-party sample files, if installed, are located in the <Primavera Gateway_home>\erp

folder.

To access the P6 Data Dictionary, log into Primavera Gateway with either admin role or developer

role privileges and access the Data Dictionary section.

14

Adding Configuration Deployments

In order to synchronize data between systems, the location of those systems must be

configured. The developer cannot configure field mappings or create flow type templates until a

configuration deployment is added for both P6 and the third-party system. The Primavera

Gateway allows multiple configuration deployments to be added.

The P6 deployment parameters require username and password for a P6 super-user, the URL for

the P6 Adapter, Keystore information if using Encryption, and the P6 currency.

The third-party deployment parameters require username and password for the system and server

name and port number where the system resides.

To access this feature:

In the Primavera Gateway application, click the Configuration section. Select the options to

either add a P6 or ERP deployment.

15

Creating Business Flows

Business flows must be created before data can be synchronized between deployments. Fields,

parameters and mappings that are seen in each flow type are generated from the P6 and

third-party provider xml files.

There are three flow types available:

Import Master Data: Import global data such as resources, roles, and rates from the

third-party system into P6 EPPM. The third-party deployment is considered the source when

comparing and transferring the data.

Import Master Data: Import global data such as resources, roles, and rates from the

third-party system into P6 EPPM. The third-party deployment is considered the source when

comparing and transferring the data.

Import Project Data: Import project data from the third-party system into P6 EPPM. When

the data is transferred, if the project does not already exist in P6 EPPM, it will be created. If

the project exists it will the update data accordingly.

Export Project Data: Export project data from P6 EPPM into the third-party system.

When accessing the flow types there are three parts:

Information: Contains the overall flow information for the selected flow type. It provides the

steps that will be followed for the data synchronization and the parameters to be

considered for the synchronization.

Field Mappings: Contains the data fields that can be used to synchronize the deployments.

When clicking on the Field Mapping Name, you can view how the fields are mapped

between the PDI, P6 EPPM and third-party systems.

16

Business Flows: Contains the templates to be used by the user to create synchronizations.

When creating the template, configure the fields that will be available for synchronization

and then select the default values and attributes of those fields.

To access this feature:

Select Flow Type and then select the type of business flow to be created.

17

Synchronizing the Data

Synchronizing the Data

To transfer data between P6 EPPM and a third-party application, a synchronization must be

created and scheduled. Multiple synchronizations can be created. A synchronization cannot be

created unless a business flow template exists. You have the flexibility of scheduling when the

synchronization occurs, how often it runs, or executing it immediately.

18

Synchronizations can be monitored to determine if they completed successfully or require

troubleshooting. The list of synchronization jobs can be filtered by the business flow type or by

status. The details of a failed job can be viewed by clicking on the failed link.

To access this feature:

To add, edit, or schedule a synchronization job, click the Synchronizations section. The jobs can

be monitored by clicking the Monitoring section.

19

Legal Notices

Oracle Primavera - Introducing Primavera Gateway

Copyright © 2013, Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or

display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be

error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone

licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated

software, any programs installed on the hardware, and/or documentation, delivered to U.S.

Government end users are “commercial computer software" pursuant to the applicable Federal

Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the programs, including any operating system,

integrated software, any programs installed on the hardware, and/or documentation, shall be

subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. It is not developed or intended for use in any inherently dangerous applications,

including applications that may create a risk of personal injury. If you use this software or hardware

in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup,

redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates

disclaim any liability for any damages caused by use of this software or hardware in dangerous

applications.

This software or hardware and documentation may provide access to or information on content,

products and services from third parties. Oracle Corporation and its affiliates are not responsible for

and expressly disclaim all warranties of any kind with respect to third-party content, products, and

services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages

incurred due to your access to or use of third-party content, products, or services.