Gateway Installation and Configuration Guide for …...Gateway Installation and Configuration Guide for On-Premises 6 Primavera Gateway On-Premises Installation Prerequisites Primavera

GGaatteewwaayy IInnssttaallllaattiioonn aanndd CCoonnffiigguurraattiioonn GGuuiiddee ffoorr OOnn--PPrreemmiisseessVVeerrssiioonn 1177

SSeepptteemmbbeerr 22001177

3

Contents

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

Downloading Primavera Gateway ................................................................... 5

Primavera Gateway On-Premises Installation Prerequisites ................................... 6

Execute a Manual Script Before Gateway Installation .............................................. 8

Running the Repository Creation Utility (RCU) ...................................................... 8

Installing Primavera Gateway ...................................................................... 11

Installing Primavera Gateway Using the Wizard ................................................... 11

Installing and Configuring Primavera Gateway ............................................. 11

Installing Primavera Gateway Application Only ............................................ 17

Installing Primavera Gateway Database Only ............................................... 18

Installing Primavera Gateway Using the Save Response File .................................... 19

Installing the Gateway Database Using the Install Utility........................................ 20

Starting and Stopping the Primavera Gateway Domain .......................................... 21

On Windows System for On-Premises ........................................................ 21

On Linux and Solaris Systems for On-Premises ........................................... 22

Configuring Primavera Gateway ................................................................... 23

Creating Users and Associating them with a Role ................................................. 23

Configuring Gateway Domain for P6 Event Notification for On-Premises ..................... 25

Using Gateway Configuration Utilities .............................................................. 27

Adding User-Defined Fields (UDFs) and Codes to P6 EPPM ................................ 27

Adding P6 User-Defined Fields and Codes to Providers ................................... 29

Adding, Updating, or Customizing Gateway Metadata .................................... 29

Adding or Removing Providers ................................................................ 31

Adding or Removing Customizations ......................................................... 32

Updating the gateway.ear File for On-Premises .................................................. 33

Deploying SampleRestAPI in WebLogic ............................................................. 34

Configuring Deployment Targets .................................................................... 35

Adding an EnterpriseTrack Deployment Connection ....................................... 36

Adding or Editing a File Deployment Connection .......................................... 36

Adding or Editing a P6 Deployment Connection ............................................ 37

Adding or Editing a Prime Deployment Connection ........................................ 39

Adding a Sample Deployment Connection ................................................... 39

Adding or Editing a Unifier Deployment Connection ....................................... 40

Enabling Encryption Between Gateway and P6 Web Services ................................... 40

Gateway Installation and Configuration Guide for On-Premises

4

Configuring Gateway User Interface Settings ................................................... 42

Configuring Online Help ............................................................................. 45

Hosting Online Help ................................................................................... 45

Deploying Help Locally ................................................................................ 45

Downloading Customization SDK ................................................................... 46

Performing a Gateway Environment Validation Check ........................................ 47

Uninstalling Primavera Gateway ................................................................... 49

Legal Notices .......................................................................................... 50

5

Overview

Primavera Gateway can be installed on a managed server or on an admin server. Choose the installation option based on how you plan to use Gateway with your enterprise application.

Managed server installation

Install Gateway on a managed server if you plan to call Gateway REST API from the user interface of your enterprise application.

For example, install Gateway on a managed server if you plan to create Gateway objects on-demand from within the Unifier interface and push the objects to Gateway user interface.

Admin server installation

Install Gateway on an admin server if you plan to:

not use Gateway REST API

perform all integration tasks within Gateway only

This guide describes how to:

Download and install Primavera Gateway on a managed server (with OWSM enabled for rest apis) and on an admin server

Set up and configure the WebLogic for Primavera Gateway

Create users and add them to the Primavera Gateway user groups

Configure LDAP directory

Configure Primavera Gateway components

Configure online help

This guide is intended for IT professionals who are installing and configuring the server environment for Primavera Gateway and who are supporting Primavera Gateway users. For the full list of system requirements and versions, see the Primavera Gateway Tested Configurationsdocument.

Downloading Primavera Gateway

To download Primavera Gateway:

1) Go to the Oracle Software Delivery Cloud.

2) Download Primavera Gateway and extract the contents into the following folders:

gatewayapiclient

GatewayUtility

script

3) Review the Supported Technologies and Tested Configurations documents for Primavera Gateway in Oracle Help Center.


6

Primavera Gateway On-Premises Installation Prerequisites

Primavera Gateway can be installed on a managed server or an admin server. Before you install Primavera Gateway, you must install and configure the following applications to setup on-premises environment for Primavera Gateway:

1) Install Oracle database.

For supported versions of the database, see the Tested Configurations document.

For licensing details, contact your Oracle account representative.

Notes:

You must also install Oracle Multimedia, along with these supporting components: Oracle JVM, Oracle XML DB (XDB), and XML Developer's Kit (XDK). Unless you specify otherwise, all these components automatically get installed with the latest versions of the supported Oracle database. If you chose not to install these components, you will need to install them before you install Primavera Gateway. See the Oracle Multimedia's User's Guide on Oracle Help Center for information on how to install these components.

Oracle Text is a required component of Oracle Database.

You must use UTF8 encoding to support a localized Primavera Gateway user interface.

2) Download, install, and configure JDK from the Oracle website.

For supported versions of Java, see the Tested Configurations document.

a. Check for the correct java version. Execute the command: java -version

b. Set the JAVA_HOME environment variable as follows:

On Windows installations: Set the JAVA_HOME to the installed JDK location.

On Linux and Solaris installations: Export JAVA_HOME variable to installed JDK location.

c. Set the PATH environment variable as follows:

On Windows installations: Edit the PATH environment variable and include the location of Java_Home/bin folder.

On Linux and Solaris installations: Edit the PATH environment variable and include the location of Java_Home/bin folder.

Note: The JDK folder name must not contain a space.

3) Download Primavera Gateway and only execute the manual_script_before_install.sql located in the script folder.

This script grants sys.DBMS_REPUTIL privileges to the system user which will be validated during Gateway database installation on a managed server.

For more details, see Execute a Manual Script Before Gateway Installation (on page 8).

4) Download and install Oracle WebLogic.


7

For supported versions, see the Tested Configurations document.

For installation instructions, refer to Oracle WebLogic documentation.

For Gateway on Managed Server Installations

If you plan to install Gatewayon a managed server,

a. Download and run the WebLogic jar files in the following sequence:

1. WebLogic Server, fmw_<version>_wls.jar

2. Run Oracle Fusion Middleware, fmw_<version>_infrastructure.jar

Oracle Fusion Middleware installs specific files that WebLogic needs to work with Primavera Gateway. This file is part of Application Development Runtime. These files ensure that the correct templates are used when creating or extending a WebLogic domain. It will also download the Repository Creation Utility (RCU).

Note: For this installation, set Oracle Home as the WebLogic home.

3. Run the Repository Creation Utility (RCU).

For detailed instructions, see Running the Repository Creation Utility (RCU) (on page 8).

For Gateway on Admin Server Installations

If you plan to install Gateway on an admin server, download and run fmw_<version>_wls.jar only.

Note: On Windows, Oracle recommends you install the application server to a folder with a short name containing no spaces.

5) Download and install any of the following Primavera applications that you plan to exchange and share data using Gateway:

P6 EPPM and P6 Web Services

Unifier

EnterpriseTrack

For product-specific installation instructions, go to https://docs.oracle.com/en/industries/construction-engineering/

6) If you plan to exchange and share data with third-party enterprise applications using Primavera Gateway, then download and install any of the following enterprise applications supported in Gateway:

Oracle E-Business Suite

Oracle Value Chain Planning

7) For each third-party enterprise application supported in Gateway, download the corresponding third-party provider files into a separate folder.

Note: You will need to enter these folder locations on the Select Third-Party Providers screen when installing Primavera Gateway.


8

Execute a Manual Script Before Gateway Installation

Execute the following manual script to grant sys.DBMS_REPUTIL privileges to the system user which will be validated during database installation:

1) From the command line, execute:

sqlplus <sysdba_username>/<sysdba_password>@<SID> as sysdba

Where:

<sysdba_username> is a sysdba user name (sys by default)

<sysdba_password> is a sysdba password

<SID> is a SID of the Oracle database instance

For example, sqlplus sys/myPassword@ORCL as sysdba

Note: The command will be different if you are connecting from the host other than the host where the database is installed, or connecting to the database using a service name.

2) At the SQL prompt, execute:

SQL>@<unzip location>\script\manual_script_before_install.sql

Running the Repository Creation Utility (RCU)

When Primavera Gateway is installed on a managed server, Oracle Web Services Manager (OWSM) authentication is required to support external Rest service authentication. The RCU installs the schema needed to support OWSM authentication.

Run the Repository Creation Utility as follows:

1) Locate the RCU utility.

For example, C:/Oracle/Middleware/Oracle_Home/oracle_common/bin

2) Run the RCU:

For Windows installations: Run rcu.bat

For Linux and Solaris installations: Run ./rcu.sh

3) On the Welcome screen, select Next.

Note: Select Next on each screen to advance to the next step.

4) On the Create Repository screen, select Create Repository and System Load and Product Load.

5) On the Database Connection Details screen, enter the following details:

Database Type: Select Oracle Database from the list.

Host Name: The host name or the server IP address.

Port: A unique port number for the Gateway database schema. Port 1521 displays by default.

Service Name: The global database name. For example, pdborcl.us.oracle.com.


9

Username: The user name with SYSDBA privileges who can install a schema. For example, system.

Password: The password for user name provided above.

Role: Role of the user creating the MDS schema. The user must have SYSDBA privileges.

6) On the Select Components screen:

a. Select Create new prefix. Make a note of the prefix you choose.

DEV displays by default. This information is required when you run the Gateway install wizard.

b. In the Components section, select the following:

Metadata Services

Oracle Platform Security Services

Audit Services

Audit Services Append

Audit Services Viewer

Common Infrastructure Services

7) On the Schema Passwords screen, select Use same passwords for all components. Make a note of the password you use.

8) On the Map Tablespaces screen, select the defaults. Make notes of your selections.

9) On the Summary screen, review the selected options and then select Create.

10) When the wizard is finished, select Close.

11

Installing Primavera Gateway

This chapter describes how to install Primavera Gateway using the following methods:

Installing Primavera Gateway Using the Wizard (on page 11)

Installing Primavera Gateway Using the Save Response File (on page 19)

Installing the Gateway Database Using the Install Utility (on page 20)

In This Section

Installing Primavera Gateway Using the Wizard ...................................................... 11 Installing Primavera Gateway Using the Save Response File .................................. 19 Installing the Gateway Database Using the Install Utility .......................................... 20 Starting and Stopping the Primavera Gateway Domain ........................................... 21

Installing Primavera Gateway Using the Wizard

The Primavera Gatewayinstallation wizard provides three installation options:

Install and Configure Primavera Gateway: Select this installation option to install the Primavera Gateway application, configure the WebLogic domain for Gateway, and create and connect to the Gateway database. This option is selected by default for all new installations.

For more details, see Installing and Configuring Primavera Gateway (on page 11)

If you have already installed Primavera Gateway, you can also use the installation wizard to:

Install Primavera Gateway: Select this installation option to only install the Primavera Gateway application. It will not create the WebLogic domain, and will not create or connect to the Gateway database.

For more details, see Installing Primavera Gateway Application Only (on page 17).

Install Primavera Gateway Database: Select this installation option to only create a new Gateway database. It will not install the Gateway application or the WebLogic domain for Gateway.

For more details, see Installing Primavera Gateway Database Only (on page 18)

Installing and Configuring Primavera Gateway

If you want to install and configure an entirely new Primavera Gatewayversion, a Primavera Gateway database, Gateway domain in WebLogic, and providers delivered with Primavera Gatewayare installed and configured as follows:

1) Invoke the Primavera Gateway installation wizard.

For Windows 64-bit Installations:

From the <Gateway Download Folder> directory, double-click installGateway.bat

For Linux and Solaris 64-bit Installations:


12

a. Run the installer unzip the files, and give execute permission using the syntax: chmod 755 installGateway.sh

b. From the <Gateway Download Folder> directory, execute: ./installGateway.sh



3) On the Installation Location screen, enter the following information:

Primavera Gateway Home: Enter the path and directory or select Browse to select the directory and path for installing Primavera Gateway.

For Windows installations, the default Primavera home installation location is C:\PrimaveraGateway.

For Linux installations, the default Primavera home installation location is /home/<User ID>/PrimaveraGateway.

For Solaris installations, the default Primavera home installation location is /home/<User ID>/PrimaveraGateway.

4) On the Install and Configure screen, select the Install and Configure Primavera Gatewayoption.

5) On the Database Installation screen select any of the following database installation options:

Install New Database: Select this option to install a new Primavera Gateway database. If the database already exists, enter a new schema owner.

Use Existing Database: Select this option to install the Primavera Gateway application, and continue using the current Gateway database. An option to upgrade the database will be provided if a previous version is detected.

6) On the Connection Details screen, enter the following information to connect to the Gateway database:

Database Host Address: Enter the host name or the server IP address for the Primavera Gateway database.

Database Host Port: Enter a unique port number of maximum 5 digits for the Gateway database schema. Port number 1521 displays by default.

Database Name: Enter the database name to connect with the Gateway database. By default, orcl. Select Service to deploy Gateway in a managed server.

SID: Select this option to connect to the database using the system identifier.

Service: Select this option if you choose to install Primavera Gateway on a managed server, and connect to the database using a service name.

If you chose Install New Database, enter the following additional information:

Schema Owner: Enter the name of the Primavera Gateway database schema owner.

Schema Password: Enter a case-sensitive password for the schema owner.

Confirm Password: Re-enter the case-sensitive password.


13

Note: Make a note of the schema owner and password. You will need these to connect to the Gateway database.

DBA User Name: Enter the user name of the Oracle database administrator.

DBA Password: Enter the password of the Oracle database administrator.

Select Test Connection to check for database connectivity. If the test is successful, the following message displays: Connection is successful. If the test is not successful, check the port number specified, schema user ID and case-sensitive password combination, SID or Service value, and the database host address.

If you chose Use Existing Database, then enter the Schema Password, and the DBA Password.

7) On the JDK and Middleware Locations screen, enter the following information:

Java Home Directory: Enter or select Browse to locate the JAVA_HOME location that will be used by the WebLogic domain.

Note: Refer to the Tested Configurations document for supported versions of JDK.

Oracle Middleware Home: Enter or select Browse to the WebLogic Oracle Home directory.

WebLogic Server Directory: Populates the WebLogic server directory by default. For example, C:\<WebLogic_Home>\wlserver.

Domain Location: Populates the WebLogic domain folder by default. For example, C:\<WebLogic_Home>\user_projects\domains.

8) On the Create New Domain screen, enter the following information to create the WebLogic domain for Primavera Gateway:

Administrator User Name: Enter a name for the WebLogic domain administrator.

Administrator User Password: Enter an alphanumeric password of at least 8 characters for the WebLogic domain administrator. Passwords may contain the following special characters: underscore (_), dollar ($), or pound (#).

Note: Make a note of the domain administrator user name and password.

Domain Name: Enter a new WebLogic domain name for Primavera Gateway. For example, PrimaveraGateway. The installer will create a sub-folder with this domain name under the domain location folder provided on the previous screen.


Administrator Server Port: Enter a unique SSL port number for the new domain.

Administrator Server SSL Port: Enter a unique port number for the new SSL domain.

9) (Optional) If you chose to install Gateway on a managed server the following additional screens display:

a. On the Managed Server Details screen:

Managed Server Deployment: Select this option to deploy Primavera Gateway on a Managed server. Also specify a database service name in the Database Connection Details screen.


14

Managed Server Port: Enter a unique port number for the managed server.

Node Manager Port: Enter a unique port number for the node manager. The port number 5556 displays by default.

a. On the MDS Database Details screen, enter the MDS database connection information that was initially specified when running the RCU:

Database Host Address: Enter the host name or the server IP address for the MDS database.

Database Host Port: Enter a unique port number for the MDS database schema.

Database Service Name: Enter the service name to connect to the MDS database.

MDS Schema Password: Enter the password for the MDS schema.

MDS Schema Prefix: Enter the prefix that was used for the MDS schema in the RCU.

10) On the Gateway Administrator User Information screen, create a user profile for a Primavera Gateway administrator as follows:

Gateway Administrator User Name: Enter a name for the Primavera Gateway administrator. The admin user, GatewayAdmin, displays by default.

Gateway Administrator Password: Enter an alphanumeric password of at least 8 characters for the Primavera Gateway administrator.


11) (Optional) If you choose to configure an LDAP Directory, enter the following information and select Next on each screen. These screens display only if you chose to install Primavera Gateway on a managed server:

a. On the LDAP Server Details screen, enter the following information:

Configure LDAP Server: Select this option to configure an LDAP server.

Directory Server Type: Select the type of LDAP directory server from the drop-down list. Choices include: Oracle Internet Directory, Oracle Unified Directory, Oracle Directory Server Enterprise Edition, and Microsoft Active Directory.

Server URL: Enter the LDAP server URL in the format, ldap://<oid_host>:<oid_port> or ldaps://<oid_host>:<oid_port>. To use SSL (ldaps), you may need to configure the Custom Trust Keystore for the LDAP server in WebLogic domain before users can authenticate successfully. For more details, refer to WebLogic documentation.

Server Principal: Enter the Distinguished Name (DN) of the LDAP user that the WebLogic server should use to connect to the LDAP server in the format, cn=<user name>.

Server Password: Enter the password to connect to the LDAP server.

Server Search DN: Enter the SearchDN (Base DN) for users and roles in LDAP which will be used by Primavera Gateway to reconcile. Use format dc=<value>.

b. On the LDAP Server Attributes screen, enter the following information:

LDAP Group Container: Enter LDAP groups in Distinguished Names (DN) format. For example, cn=groups,dc=myDomain,dc=com.

LDAP User Container: Enter LDAP user groups in Distinguished Names (DN) format. For example, cn=Users,dc=myDomain,dc=com.


15

User Name: Depending on the LDAP server directory type, select the default user name attribute from the drop-down list. Select uid, sn, or cn for Oracle Internet Directory or Oracle Unified Directory. Select cn or sAMaccountname for Microsoft Active Directory. Select cn for Oracle Directory Server.

User Object: Depending on the LDAP server directory type, select the default object class of users. Select inetOrgPerson, person, or organizationalPerson for Oracle Internet Directory or Oracle Unified Directory; user for Microsoft Active Directory; person or groupOfUniqueNames for Oracle Directory Server.

Group Attribute: Select the cn attribute that uniquely identifies the group from the drop-down list.

Group Object: Depending on the LDAP Directory server type, select the attribute that uniquely identifies the object class of groups from the drop-down list. Select groupOfUniqueNames for Oracle Internet Directory and Oracle Unified Directory; groupOfUniqueNames for Oracle Directory Server; group for Microsoft Active Directory.

c. On the LDAP Server Mapping screen, enter the LDAP group name for each Gateway Role group. For example, enter LDAP Group, Administrators for the Gateway Administrators Group. Ensure the LDAP group is specified in the LDAP Group Containerfield.

12) On the Primavera Providers screen, the following providers will be installed by default:

EnterpriseTrack

File

P6

Prime

Unifier

Select Restore Providers to restore all primavera providers in the displayed list.

Select Remove Provider to remove a selected provider from the displayed list.

13) On the Third Party Providers screen, select the providers you wish to install.

Primavera's Sample Provider: Select this option to install the Primavera sample provider packaged with Gateway. This option is selected by default.

Third-Party Providers: Select this option to add or delete alternative third-party providers.

Select Add Provider to navigate and locate the home directory for each third-party provider. Ensure that the lib sub-folder includes the provider's jar file, the datasub-folder includes the metadata xml files. The optional supplement sub-folder can contain any additional files. Folder names are case-sensitive.

Select Delete Provider to delete a selected third-party provider from the displayed list.

Do Not Add Provider: Select this option when you choose to install or upgrade only the Gateway database.

14) If you chose to install the P6 provider on the Primavera Providers screen, then set up P6 deployment in Gateway on the Configure P6 Deployment screen:

Configure P6 Deployment: Select this option to configure P6 deployment in Gateway.


16

P6 Webservices Authentication Type: Select Username Token or SAML 2.0 from the list.

Username: Enter the name of the P6 administrator.

Password: Enter the case-sensitive password of the P6 administrator.

Endpoint URL: Enter the URL to connect with P6 Web Services in the format, http:<host name>:<port>/p6ws/services/SyncServiceV1

P6 Database Instance ID: Enter the database instance ID associated with the P6 application.

Enable Encryption: Select this option if you want to enable encryption when using P6 web services.

Keystore File: Enter or Browse... to the keystore file.

For more details on how to generate a keystore file and keystore password, see Enabling Encryption Between Gateway and P6 Web Services (on page 40). (on premises only)

Keystore Password: Enter the password for the keystore file.

Certificate Alias: Enter the certificate alias used for authentication.

P6 Currency: Enter the base currency for the P6 deployment.

15) If you chose to install Unifier provider on the Primavera Providers screen, then set up an Unifier deployment in Gateway on the Configure Unifier Deployment screen:

Configure Unifier Deployment: Select this option to configure Unifier deployment in Gateway.

Short Name: Enter the short name of the company used in Unifier.

Authentication Code: Enter the authentication code to use when data is integrated with Unifier from external systems using web services.

End Point URL: Enter the URL to connect with Unifier application in the format: http://<host name>:<port>

16) The Installation Summary screen displays all the components selected for installation in the previous steps. Review all the selected installation options. Select Save if you want to save the installation summary details in an .ini file. This is also a Saved Response file.

Select Back or select the appropriate window in the left pane to change your install option.

Select Install to begin installing Primavera Gateway.

Note: Save the stored .ini file as a backup of your current installation and configuration choices in a secure location.

17) The Installation Progress screen displays a success message on successful completion.

Note: Copy the properties files in the wlst folder to a save location if you want to replicate the installation using the silent installer later.

18) The Configuration Progress screen displays the progression of the installation and configuration tasks.

19) On the Installation Complete screen, select Finish to complete Primavera Gateway installation and close the wizard. Log in to Primavera Gateway with the Gateway Administrator user profile created during installation.


17

Installing Primavera Gateway Application Only

If you want to install Primavera Gateway application only, run the following installation wizard sequence:

Note: This installation sequence will not create a Gateway WebLogic domain, and will not create or connect to the Gateway database.


On Windows 64-bit Installations:

From the <Gateway Download Folder> directory, double-click installGateway.bat

On Linux and Solaris 64-bit Installations:

a. Run the installer unzip the files, and give execute permission using the syntax: chmod 755 installGateway.sh

b. From the <Gateway Download Folder> directory, execute: ./installGateway.sh








4) On the Install Now and Configure Later screen, select the Install Primavera Gatewayoption.







18


Installing Primavera Gateway Database Only

If you want to install the Primavera Gatewaydatabase only, run the following installation wizard sequence:

Note: This installation sequence will not install the Gateway application or the WebLogic domain for Gateway.


On Windows 64-bit Installations:

From the <Gateway Download Folder>/GenericInstaller directory, double-click InstallGateway.bat

On Linux and Solaris 64-bit Installations:

a. Run the installer unzip the files, and give execute permission using the syntax: chmod 755 InstallGateway.sh

b. From the <Gateway Download Folder>/GenericInstaller directory, execute: ./InstallGateway.bat








4) On the Install Database Only screen, select the Install Primavera Gateway Databaseoption.

5) On the Connection Details screen, enter the following information to connect to the Gateway database:

Database Host Address: Enter the host name or the server IP address for the Primavera Gateway database.

Database Host Port: Enter a unique port number of maximum 5 digits for the Gateway database schema. Port number 1521 displays by default.

Database Name: Enter the database name to connect with the Gateway database. By default, orcl. Select Service to deploy Gateway in a managed server.

SID: Select this option to connect to the database using the system identifier.


19

Service: Select this option if you choose to install Primavera Gateway on a managed server, and connect to the database using a service name.

Schema Owner: Enter the name of the Primavera Gateway database schema owner.

Schema Password: Enter a case-sensitive password for the schema owner.


Note: Make a note of the schema owner and password. You will need these to connect to the Gateway database.

DBA User Name: Enter the user name of the Oracle database administrator.

DBA Password: Enter the password of the Oracle database administrator.

Select Test Connection to check for database connectivity. If the test is successful, the following message displays: Connection is successful. If the test is not successful, check the port number specified, schema user ID and case-sensitive password combination, SID or Service value, and the database host address.


Select Back or select the appropriate window in the left pane to change your install option.

Select Install to begin installing Primavera Gateway.






Installing Primavera Gateway Using the Save Response File

Use this method to clone Primavera Gateway installations across servers. To proceed with this installation method, you need the Save Response File which captures the options selected during installation. The Save Response file is created when you click Save on the Installation Summary screen of the installation wizard.

To install Primavera Gateway in the silent mode using the save response file created from the wizard installation:

1) Locate the Save Response File that was created using the Primavera Gateway installation wizard.


20

2) Edit the response file to replace all <SECURE VALUE> with the actual passwords in the properties file.

3) Run the installer in the silent mode as follows:

java -jar <installer jar file> -silent -respFile <response file location>

Note: The path to the .ini file must be the absolute path.

The output displays in the command console. Upon completion, the following success message displays: The installation of Primavera Gateway completed successfully.

4) Logs and errors from the installation are located in the following default locations:

For Windows installations, the default location is: C:\Program Files\Oracle\Inventory\logs

For Linux and Solaris installations, the default location is: <user home directory>/oraInventory/logs

Installing the Gateway Database Using the Install Utility

If you chose to only install the Gateway application using the wizard, you can:

Re-run the installation wizard, and select the Install Primavera Gateway Database option

For more details, see Installing Primavera Gateway Using the Wizard (on page 11).

or

Run the Gateway-DBInstallation utility.

To install the Gateway database using the Gateway-DBInstallation:

1) Download Primavera Gateway from the Oracle Software Delivery Cloud.

2) Extract the file contents to an <INSTALLER_FOLDER>.

3) Navigate to the utilities folder.

On Windows: Go to <Primavera_Gateway_Home>/gateway/app/utilities or go to <INSTALLER_FOLDER>/GatewayUtility.

On Linux and Solaris: Go to <Primavera_Gateway_Home>/gateway/app/utilities or go to <INSTALLER_FOLDER>/GatewayUtility

4) If you are installing on a non-Microsoft Windows system, type the following command:

chmod 755 Gateway-DBInstallation.sh

5) Run the following command:

For Windows: Run Gateway-DBInstallation.bat

For Linux and Solaris: Run ./Gateway-DBInstallation.sh

6) Enter the following database connection details to the existing Gateway database:

DBA User Name: Enter the name of the database administrator.

DBA Password: Enter the password for the database administrator.

Database Host: Enter the host name of the Oracle database on which you will be updating the Primavera Gateway database.

Database Host Port: Enter the port number of the Oracle database.

Database Name: Enter the Gateway database name and select any of the following methods to connect to the database.


21

SID: Enter the SID of the Oracle database.

Service: Enter the service name of the Oracle database.

Schema Owner: Enter the name of the Gateway schema owner.

Schema Password: Enter the password of the Gateway schema owner.

Update provider and Gateway metadata from the new Gateway database you are installing as follows:

Provider data folder: Go to <INSTALLER_FOLDER>/GatewayUtility/<ProviderName>/data folder of each provider extracted in Step 2, and select Add. .

For example, to install the Sample database and P6 data. In that provider data folder, include the P6provider\data folder, the sampleprovider\data folder and the sampleprovider\data\p6 folder to create the Gateway database. Otherwise, the error message: No field mapping data found, displays.

Gateway data folder: Go to the <INSTALLER_FOLDER>/GatewayUtility/gateway/data folder extracted in Step 2, and select Add.

7) Select Test Connection.

If the connection fails, modify applicable fields and repeat as necessary.

8) Select Run to install the Gateway database.

Starting and Stopping the Primavera Gateway Domain

Depending on the operating system, use the following commands to start and stop Primavera Gateway domain.

On Windows System for On-Premises

Start and stop the Gateway domain on Windows installations as follows:

Primavera Gateway Installed on an Admin Server

To start Primavera Gateway, from the Windows Start menu, select Oracle, Primavera Gateway,and then Start Primavera Gateway. This invokes startGatewayAS.cmd.

To stop Primavera Gateway, from the Windows Start menu, select Oracle, Primavera Gateway,and then Stop Primavera Gateway. This invokes the stopGatewayAS.cmd.

Primavera Gateway Installed on a Managed Server

To start Primavera Gateway, from the Windows Start menu, select Oracle, Primavera Gateway,and then Start Primavera Gateway. This invokes startGatewayMS.cmd.

To stop Primavera Gateway, from the Windows Start menu, select Oracle, Primavera Gateway,and then Stop Primavera Gateway. This invokes stopGatewayMS.cmd.


22

On Linux and Solaris Systems for On-Premises

Start and stop the Gateway domain on Linux and Solaris installations as follows:

Primavera Gateway Installed on an Admin Server

To start Primavera Gateway on an Admin server:

1) Enter cd <Primavera Gateway_Home>/WLST/adminserver

2) Run ./startGatewayAS.sh

Notes:

You may need to set permissions on the startGatewayAS.sh file. If so, enter the following command: chmod 755 startGatewayAS.sh.

You must use the <PrimaveraGateway_home>\WLST\startGatewayWLDomain.* scripts to start the Primavera Gateway domain because these scripts contain the specific memory and timezone settings required by Primavera Gateway.

To stop Primavera Gateway:

1) Enter cd <Primavera Gateway_Home>/WLST/adminserver

2) Run ./stopGatewayAS.sh

Note: You may need to set permissions on the stopGatewayAS.sh file. If so, enter the following command: chmod 755 stopGatewayAS.sh

Primavera Gateway Installed on a Managed Server

To start Primavera Gateway on a managed server:

1) Enter: cd <Primavera Gateway_Home>/wlst/managedserver.

2) Run: ./startGatewayMS.sh

Note: You may need to set permissions on the startGatewayMS.sh file. If so, enter the following command: chmod 755 startGatewayMS.sh

To stop Primavera Gateway on a managed server:

1) Enter: cd <Primavera Gateway_Home>/wlst/managedserver

2) Run: ./stopGatewayMS.sh

Note: You may need to set permissions on the stopGatewayMS.sh file. If so, enter the following command: chmod 755 stopGatewayMS.sh

23

Configuring Primavera Gateway

This chapter describes how to:

Configure Primavera Gateway using the configuration utilities

Create Gateway users and associating them with a role

Configure provider deployment targets to exchange data between source and destination applications

Configure online help

In This Section

Creating Users and Associating them with a Role ................................................... 23 Configuring Gateway Domain for P6 Event Notification for On-Premises ................ 25 Using Gateway Configuration Utilities ...................................................................... 27 Updating the gateway.ear File for On-Premises....................................................... 33 Deploying SampleRestAPI in WebLogic .................................................................. 34 Configuring Deployment Targets ............................................................................. 35 Enabling Encryption Between Gateway and P6 Web Services ................................ 40

Creating Users and Associating them with a Role

Gateway users and user groups are created in the Gateway WebLogic domain. By default, the following types of user roles are created using the Gateway installation wizard:

PrimaveraGatewayAdmin

Users have complete access to the entire Gateway application as a user, developer, and administrator. Assign this role to create a Gateway administrator with complete administration privileges and data access privileges.

PrimaveraGatewayAdminNoData

Users with this role can administer the Gateway application, however they do not have access to view the actual data being transferred on the Job Details page of a synchronization in the Gateway application. This role limits the user's access to sensitive data. Assign this role to create additional gateway administrators, but with no access to data.

PrimaveraGatewayDeveloper

Users with this role can create new providers for Gateway and also customize delivered providers to support their ERP applications.

PrimaveraGatewayUser

Users with this role can create, run and monitor synchronization jobs in the Gateway application. They can also view the actual data being transferred on the Job Details page of a synchronization. Assign this role to create Gateway users with access to data.

PrimaveraGatewayUserNoData


24

Users with this role can create, run and monitor synchronization jobs, however, they cannot view the actual data being transferred on the Job Details page of a synchronization. Assign this role to create Gateway users with no access to data.

If Gateway is installed with LDAP configuration, then create users in LDAP. Otherwise, create users and assign their roles as follows:

1) Ensure the Primavera Gateway domain is running.

2) Sign in to the WebLogic Administration Server Console for the Gateway domain:

a. In a browser, enter the following location:

http://<hostname>:<port>/console

Where, hostname and port is the hostname and port of your Primavera Gateway domain in WebLogic. The default port is 7001.

b. Enter the WebLogic administrator user name and password.

3) In the Change Center pane, select Lock and Edit before you make any changes to the domain.

4) Select Security Realms.

5) Select myrealm.

6) Create users and assign them to the user groups and roles created in the previous steps as follows.

a. Select the Users and Groups tab, Users tab, and then select New.

b. Enter a Name and Description for the user.

c. Enter a Password for the user and confirm it.

d. Select OK.

e. Now select the check box adjacent to the user name, and select the user

f. In the Settings for <user name> pane, select the Groups tab.

g. Depending on the group that you would like to assign to the user in Gateway, move one of the following items to the Chosen box.

PrimaveraGatewayAdmin

PrimaveraGatewayAdminNoData

PrimaveraGatewayDeveloper

PrimaveraGatewayUser

PrimaveraGatewayUserNoData

h. Select Save.

i. Repeat step 6 for each user.

7) Select Activate Changes.

8) Select Release Configuration.

9) Verify the user name and password by logging into Primavera Gateway with the user name and password that you just created.


25

Configuring Gateway Domain for P6 Event Notification for On-Premises

If you choose to use the P6 Event provider delivered in Gateway, then configure the Gateway WebLogic domain to consume P6 event messages as follows:








4) Create a JMS server as follows:

a. In the Domain Structure pane, expand Services, Messaging, JMS Servers.

b. In the Summary of JMS Servers pane, select New.


1. Enter a Name for the JMS Server. For example, Gateway JMS Server.

2. Select Create a New Store.

3. In the Type list, select File Store.

4. Enter a Name for the File Store.

5. Select the Target for the file store:

For Admin server, select AdminServer.

For Managed server, select GatewayCluster.

6. Enter the Directory of the physical location of the file store. For example, c:\JMSFilestore.

7. Select OK.

8. Select Finish.

5) Create a JMS module as follows:

a. In the Domain Structure pane, expand Services, Messaging, and JMS Modules

b. In the Summary of JMS Modules pane, select New.

1. Enter a Name for the JMS module.

2. Depending on your configuration, select the Target for the file store, as AdminServer,or GatewayCluster for a managed server.

3. Select Finish.

6) Create a Foreign Server in the JMS module as follows:

a. In the Domain Structure pane, expand Services, Messaging, and JMS Modules.

b. Select the JMS module created in step 5.

c. On the Configuration tab of the Settings for <JMS Module> pane, select New.

d. Select Foreign Server.


26

e. Enter a Name for the foreign server.

f. Depending on the configuration, select the Target as AdminServer, or gatewayCluster for a Managed server.

g. Select Advanced Targeting and then select Create a New SubDeployment.

h. Enter a name for the subdeployment and then select OK.

i. In the subdeployment list, select the created subdeployment.

j. Depending on your configuration, select the Target as AdminServer, or gatewayCluster for a Managed server, and the JMS server created in step 4.

k. Select Finish.

l. Select Save to save the foreign server with a subdeployment.

7) Enter configuration settings for the foreign server created as follows:

a. Select the foreign server created in step 6.

b. In the Settings for <Foreign Server Name> pane, select the Configuration tab, and then the General tab.

c. Select the new foreign server created and enter values for the following configuration settings:

In the JNDI Initial Context Factory field, retain the default value.

In the JNDI Connection URL field, enter the URL to the P6 EPPM domain in the format: t3://<P6_EPPM_host>:<port>/

In the JNDI Properties Credential field, enter the P6 EPPM WebLogic domain password.

In the Confirm JNDI Properties Credential field, reconfirm the entered password.

In the JNDI Properties field, enter the P6 EPPM WebLogic domain user name in the following format: java.naming.security.principal=<P6 EPPM WebLogic domain user name>

Select Save. The newly created foreign server displays in the Configuration tab.

d. Create a connection factory for the foreign server as follows:

1. In the Settings for <Foreign Server Name> pane, select the Configuration tab, and then the Connection Factories tab.

2. Select New.

3. Enter a Name for the connection factory.

4. Enter the Local JNDI Name. For example, jms/newCF.

Note: Make a note of the value entered in this field. You will need to enter this value to set up an event provider to a P6 Application deployment.

5. Enter the JNDI name of the P6 EPPM Connection Factory as the Remote JNDI Name. For example, jms/P6ConnectionFactory.

6. Select OK.

e. Create a destination for the foreign server as follows:

1. In the Settings for <Foreign Server Name> pane, select the Configuration tab, and then the Destinations tab.

2. Select New.


27

3. Enter a name for the foreign destination.

4. In the Local JNDI Name, enter the name of the JMS queue used by Gateway. For example, jms/newGWQueue.

Note: Make a note of the value entered in this field. You will need to enter this value to set up an event provider to a P6 Application deployment.

5. Enter the name of the P6 EPPM JMS queue as the Remote JNDI Name. For example, jms/P6Queue.

6. Select OK.

8) In the Change Center pane, select Activate Changes to enforce all the changes made to the domain.

Using Gateway Configuration Utilities

The following configuration utilities are provided in Primavera Gateway. Run each utility for the purpose described below:

Gateway-P6Setup: Run this utility to add User Defined Fields (UDFs) and codes to P6 EPPM.

Access the Gateway-P6Setup utility from the <Primavera_Gateway_Home>\gateway\app\utilities folder or the <INSTALLER_FOLDER>\GatewayUtility folder.

Gateway-Configuration: Run this utility to manage metadata, and add or remove providers and customizations.

The following configuration options are available:

Manage Gateway metadata

Manage providers

Manage customizations

Access the Gateway-Configuration utility from the <Primavera_Gateway_Home>\gateway\app\utilities folder or the <INSTALLER_FOLDER>\GatewayUtility folder.

Note: Before executing the utilities on Windows, Linux, or Solaris, ensure the following:

The bin folder of the supported Java JDK is included in the PATH.

If there are other JDK bin folders in the PATH, then the supported Java JDK should be listed first.

Adding User-Defined Fields (UDFs) and Codes to P6 EPPM

You have the option to add User-Defined Fields (UDFs) and codes to P6 EPPM and to prepare the P6 EPPM database for synchronizing the data. Use this procedure to also add UDFs and codes from Oracle Prime, Primavera Unifier, Sample provider and third-party applications to P6 EPPM.


28

For example, if your application has UDFs or codes that P6 EPPM does not have, you can add these UDFs or codes using an XML file that you edit and then point to it in the Gateway Configuration utility. The XML file needs to conform to the DataConfiguration.xsd schema. For more information on the DataConfiguration.xsd schema, see the Primavera Gateway Provider Development Guide.

To add your application UDFs or codes to P6 EPPM:

1) Ensure that your JAVA_HOME variable is pointing to a supported JDK folder.

Note: Ensure the following:


If there are other JDK bin folders in the PATH, it should be listed first.


On Windows: Go to <Primavera_Gateway_Home>\gateway\app\utilities folder.

On Linux and Solaris: Go to <Primavera_Gateway_Home>/gateway/app/utilities folder.

3) If you are installing on a non-Microsoft Windows system, type the following command to give execute permission for the utility:

chmod 755 Gateway-P6Setup.sh


For Windows installation, run Gateway-P6Setup.bat

For Linux and Solaris installations, run ./Gateway-P6Setup.sh

5) Enter the following information in the Primavera P6 Data Setup Utility dialog box:

a. In the Authentication Type field, select UserName Token or SAML 2.0 Token.

b. In the P6 Admin User Name field, enter the user name of a user who has admin privileges on the P6 deployment.

c. In the P6 Admin Password field, enter the password of the admin user.

d. If you chose SAML2.0 Authentication type, then enter or Browse and select the SAML2.0 Token File.

e. In the P6 WebServices URL field, enter the URL of the SyncServiceV1 web service in the following format:

<protocol>://<hostname>:<port number>/p6ws/services/SyncServiceV1?wsdl

f. In the P6 database instance ID, enter the system ID (SID) from P6 Admin configuration of the P6 database instance.

g. Select the Enable Encryption option if this feature is activated.

h. If a Keystore File has been generated, enter the following information:

1. Browse and select the Keystore File.

2. Enter the Keystore Password for the Keystore File.

3. Enter the Certificate Alias provided by the Certifying Authority.

i. In the P6 Data XML File Path, enter or select Browse to specify the path to the XML file that you modified with the UDFs or codes which you want to add to P6 EPPM.


29

For a P6 EPPM with Sample provider integration, ensure you have installed the Sample provider, and now select the SampleP6DataSetup.xml in the <Primavera_Gateway_Home>\providers\sample\sampleprovider\p6data folder. Enter the absolute path to the file.

For a P6 EPPM with Oracle Prime integration, select the PrimeP6DataSetup.xml file in the <Primavera_Gateway_Home>\providers\primeprovider\p6data folder. Enter the absolute path to the file.

For a P6 EPPM with any third-party enterprise application integration, select the relevant <third-party provider P6datasetup>XML file from the data/p6data folder. Enter the absolute path to the file.

j. Select Run. The UDFs or codes will be imported into the P6 EPPM deployment you selected.

k. Select Finish to close the utility.

Adding P6 User-Defined Fields and Codes to Providers

To have additional P6 UDFs and codes available for synchronization and field mapping templates for a selected provider, the UDFs and codes must be included in the:

MetaData.xml

P6ExtraMetaData.xml

PDIExtraMetaData.xml

Adding P6 UDFs and Codes to the Sample Provider

Add UDFs or codes in the P6ExtraMetaData and PDIExtraMetaData files in the <Primavera_Gateway_Home>\providers\sample\sampleprovider\data\p6 folder.

Adding P6 UDFs and Codes to the Prime Provider

Add UDFs or codes in the P6ExtraMetaData and PDIExtraMetaData file in the <Primavera_Gateway_Home>\providers\primeprovider\data\p6 folder.

Adding P6 UDFs and Codes to the Unifier Provider

Add UDFs or codes in the PDIExtraMetaData.xml file in the <Primavera_Gateway_Home>\providers\unifierprovider\data\p6 folder.

Adding P6 UDFs and Codes for Third-party Providers

For all third-party providers, add UDFs or codes in the P6ExtraMetaData.xml and PDIExtraMetaData.xml files located under the data folder of the third-party provider.

Note: Ensure that P6data folder is listed before the third-party provider folders.Otherwise the third-party provider will fail to load.

Adding, Updating, or Customizing Gateway Metadata

After modifying the P6ExtraMetaData and PDIExtraMetaData files, run the Gateway-Configuration utility to add your application's UDFs or Codes in the Gateway metadata as follows:


30

1) If you are installing on a non-Microsoft Windows system, type the following command to give execute permission for the utility:

chmod 755 Gateway-Configuration.sh


On Windows: Go to C:\<Primavera_Gateway_Home>\gateway\app\utilities

On Linux and Solaris: Go to C:/<Primavera_Gateway_Home>/gateway/app/utilities


On Windows: Run Gateway-Configuration.bat

On Linux and Solaris: Run ./Gateway-Configuration.sh

4) In the Primavera Gateway Configuration Utility dialog box, enter the following information:

a. Select Manage Metadata, and select Next.

b. Select any of the following options to manage Gateway metadata and select Next.

Replace Gateway Metadata

Update Gateway Metadata

Customize Gateway Metadata

Note: The Customize Gateway Metadata option only updates the Gateway database with metadata.

5) Based on the Manage Metadata option selected in the previous step, enter the following database connection details:

a. In the DBA User Name field, enter the user name of the oracle database administrator.

b. In the DBA Password field, enter the password of the oracle database administrator.

c. In the Database Host field, enter the host name of the Oracle database on which you will be updating the Primavera Gateway database.

d. In the Database Host Port field, enter the port number of the Oracle database.

e. In the Database Name field, enter the Gateway database name and select any of the following methods to connect to the database.

In the SID field, enter the SID of the Oracle database.

In the Service field, enter the service name of the Oracle database.

f. In the Schema Owner field, enter the schema owner name.

g. In the Schema Password field, enter the password for the schema owner.

h. In the Provider data folder field, verify the path name for the following, as applicable:

If you are using the Sample provider, then verify that this field contains the <Primavera_Gateway_Home>\providers\sample directory that contains all the Sample XML metadata mapping templates.

If you chose to install additional providers, then verify that this field contains the home directory for each provider. The XML files in the associated datasubdirectory must include all the required data to load metadata and mapping templates.

For more information about these files, see the Primavera Gateway Provider Development Guide.


31

To add providers, select Add and locate the data folder for each provider you wish to add.

To remove providers, select a provider and select Remove.

i. In the Gateway Data Folder field, verify the path name to the gateway data folder. For example, C:/PrimaveraGateway/gateway/data.

j. If you chose to Customize Gateway Metadata, then specify the XML file in the Customization XML field. Enter the path name or select Browse and locate the customization file created for the specific provider.

Note: This field displays only when you select the Customize Gateway Metadata option.

k. Select Test Connection. If the connection fails, modify the applicable fields and repeat as necessary.

l. Select Run to run the configuration utility.

Adding or Removing Providers

To add or remove providers, including Primavera providers, from Primavera Gateway:

1) Stop the Gateway domain before adding or removing providers or customizations.

2) Ensure the following:


If there are other JDK bin folders in the PATH, they should be listed first.


On Windows: Go to <Primavera_Gateway_Home>/gateway\app\utilities folder.

On Linux and Solaris: Go to <Primavera_Gateway_Home>/gateway/app/utilities folder.

4) If you are installing on a non-Microsoft Windows system, type the following command:



For Windows installations, run Gateway-Configuration.bat

For Linux and Solaris installations, run ./Gateway-Configuration.sh


a. Select Manage Providers, and select Next.

Selecting this option updates the gateway.ear file and the Gateway database with custom metadata from the XML files.

b. In the Select Gateway ear file (gateway.ear) location, enter or click Browse to locate the .ear file.

c. In the Gateway domain location field, enter or click Browse to specify the Gateway domain.

d. In the Installed Gateway Providers field, review the list of providers displayed and perform any of the following actions:

To add a provider, select Add Provider, and navigate to the location of the provider.


32

To remove a provider listed in the Gateway user interface, select the Removeoption for that provider.

To upgrade an existing third-party provider, select the Update option for that provider.

7) Enter the following database connection details:

a. In the DBA User Name field, enter the name of the database administrator.

b. In the DBA Password field, enter the password for the database administrator.

c. In the Database Host field, enter the host name of the Oracle database on which you will be updating the Primavera Gateway database.

d. In the Database Host Port field, enter or verify the port number of the Oracle database.

e. In the Database Name field, enter the Gateway database name and select any of the following methods to connect to the database.

In the SID field, enter the SID of the Oracle database.

In the Service field, enter the service name of the Oracle database.

f. In the Schema Owner field, enter the database user name to be used for the Primavera Gateway database. (This name should match the Schema Owner name when you installed Primavera Gateway.)

g. In the Schema Password field, enter the database password to be used for the Primavera Gateway database.

h. Select Test Connection. Modify the applicable fields if the connection fails and repeat as necessary.

i. Click Update. The status field displays a success message.

j. Click Finish to exit the configuration utility.

Adding or Removing Customizations

Use this procedure if a customization includes XML files, jar files, and other files such as Java customizations. If you have installed Gateway on a managed server, see Updating the gateway.ear File for On-Premises (on page 33) for more details.

Note: If a customization does not include any jar files, and uses Groovy customization, then upload the XML file from the Gateway user interface.

To add or remove customization files in Gateway:

1) Stop the Gateway domain before adding or removing providers or customizations.

2) Ensure the following:


If there are other JDK bin folders in the PATH, it should be listed first.

3) Navigate to the <Primavera_Gateway_Home>/gateway/app/utilities folder.

4) If you are installing on a non-Microsoft Windows system, type the following command for execute privileges:




33

For Windows installations, run Gateway-Configuration.bat

For Linux and Solaris installations, run ./Gateway-Configuration.sh


a. Select Manage Customizations, and select Next.

Selecting this option updates the gateway.ear file and the Gateway database with custom metadata from the customization XML files.

b. In the Select Gateway ear file (gateway.ear) location, enter or select Browse to locate the .ear file.

c. In the Installed Gateway Customizations field, review the list of customization files displayed in the dialog box, and perform any of the following actions:

To add a customization, select Add Customization, and navigate to the folder location of the customization file.

To remove a customization, select the customization in the Remove column.

7) Enter the following database connection details:

DBA User Name: Enter the name of the database administrator.

DBA Password: Enter the password for the database administrator.

Database Host: Enter the host name of the Oracle database on which you will be updating the Primavera Gateway database.

Database Host Port: Enter the port number of the Oracle database.

Database Name: Enter the Gateway database name and select any of the following methods to connect to the database.

SID: Enter the SID of the Oracle database.

Service: Enter the service name of the Oracle database.

Schema Owner: Enter the name of Gateway schema owner. (This name should match the name that was entered when you installed Primavera Gateway.)

Schema Password: Enter the password for the schema owner.

Select Test Connection. Modify the applicable fields if the connection fails and repeat as necessary.

Select Update. The status field displays a success message.

Select Finish to exit the configuration utility.

8) Redeploy gateway.ear in WebLogic to ensure the changes are reflected in Primavera Gateway. For more details, see Updating the gateway.ear File for On-Premises (on page 33).

Updating the gateway.ear File for On-Premises

Upgrade Primavera Gateway by updating the gateway.ear in WebLogic.

Prerequisite

Backup the existing .ear file before copying the new .ear file.

Procedure

Complete the following steps to update the gateway.ear file in WebLogic:


34


2) Sign in to the WebLogic Administration Server Console for Primavera Gateway domain:


Where, <hostname> and <port> is that of the Primavera Gateway domain in WebLogic. The default port is 7001.

3) Enter the WebLogic administrator user name and password.

4) In the Change Center pane, select Lock & Edit.

5) In the Domain Structure pane, select Deployments.

6) Stop the Gateway deployment as follows:

a. In the Deployments tab, select gateway in the Name column.

b. Select the Control tab.

c. Select gateway.

d. Select Stop to stop the current Gateway deployment.

7) Update the gateway.ear file as follows:

a. Select the Configuration tab.

b. Select gateway in the Name column.

c. Select Update to update gateway.ear.

d. Save the changes.

8) In the Change Center pane, select Activate Changes.

9) Restart gateway deployment.

Deploying SampleRestAPI in WebLogic

If you plan to add an File Deployment with XML format in Gateway, and send data using a rest service, you will need to deploy the rest api in WebLogic. A rest api called SampleRestAPI is delivered with Primavera Gateway. For demonstration purposes, deploy SampleRestAPI in WebLogic, preferably in a separate domain.








4) Create a new WebLogic domain or use an existing domain on an Admin server or a Managed server.

5) Deploy the SampleRestAPI as follows:

a. In the Domain Structure pane, select Deployments.

b. In the Summary of Deployments pane, in the Control tab, select Install.


35

c. In the Install Application Assistant pane:

1. Go to <Gateway_Home>/providers/fileprovider/samplerestapi/output folder.

2. Select the fileprovidersamplerestapi.war file.


3. Select Install this deployment as an application.

d. Review the configuration settings you have chosen, then select Finish to complete the installation.

The Rest API is now deployed in WebLogic.

6) Set the system properties for files to read from and to write to as follows:

a. In the Domain Structure pane, select Servers.

b. In the Servers pane, select the server where the rest api has been deployed.

c. Select the Server Start tab.

d. In the Arguments field, enter the following file locations:

-Dapi.data.read.global.path = <folder containing global data>/masterdata.xml

-Dapi.data.read.project.path = <folder containing the project data>/projectdata.xml

-Dapi.data.write.global.path = <folder containing the global data>/outmasterdata.xml

-Dapi.write.read.project.path = <folder containing the global data>/outprojectdata.xml

e. Select Save.

7) In the Settings for <Gateway Domain Name> window, select Save.

8) In the Domain Structure pane, select Activate Changes.

9) Start the SampleRestAPI deployment.

10) Proceed to setup the XML deployment in the Gateway user interface. For more details, see the Online Help.

Configuring Deployment Targets

Depending on the applications you chose for sharing data, and the providers installed in Gateway, you must configure each provider and specify a deployment target in the Gateway user interface. This information is required to ensure Gateway knows where to receive and send data.

For more details on how to add, edit, or configure a deployment in Gateway, see the relevant Setup Guide.


36

Adding an EnterpriseTrack Deployment Connection

To move data between applications, Primavera Gateway needs to know where to get and send information. If you choose to integrate with Instantis EnterpriseTrack, add an application deployment connection for Oracle Instantis EnterpriseTrack by specifying an Endpoint URL as follows:

1) Enter the Primavera Gateway URL in the format:

http://<host name>:<port number>/gateway

Where, <host name> and <port number> should match those of your Primavera Gateway domain.

2) Sign in to Primavera Gateway with administration credentials.

3) In the sidebar, select Configuration.

4) Select the Deployments tab.

5) Select Add... to invoke the Add Deployment wizard.

6) In the General step, select the EnterpriseTrack provider and name the deployment.

7) In the Deployment step, set up EnterpriseTrack connectivity from Gateway as follows:

EnterpriseTrack Login ID: Enter the login ID that has all the necessary permissions to update project attributes. Otherwise, project import may fail.

EnterpriseTrack Password: Enter the password of the EnterpriseTrack user.

EnterpriseTrack Login URL: Enter the URL for accessing the application in the format: http://<server_name>/SiteWand/Submission/<accountname>

EnterpriseTrack Initiative: Enter a valid initiative to create or update a project.

Date Format: Enter a valid date format supported in EnterpriseTrack.

EnterpriseTrack Connector Debug Flag: Set the flag value to Y if you want to enable debugging generate a log file.

8) Select Test Connection ensure connectivity with Gateway is established.

9) Select Save.

Tips

You can also edit a deployment and select Save in any step to exit the wizard.

Adding or Editing a File Deployment Connection

To move data between applications, Primavera Gateway needs to know where to get and send information. The File provider enables you to export and import data in XML and CSV file formats with the application you choose to integrate with. The XML file must conform to the Gateway schema.

Add a File provider deployment as follows:

1) Sign in to Primavera Gateway with administrator credentials.



4) Select Add... or Edit... to invoke the Deployment wizard.


37

5) In the General step, select File and name the deployment.

6) In the Deployment step, set up the data source as follows:

7) In the File Format field, select CSV/XLS/XLSX or XML.

8) Select any of the following methods to upload a file:

To upload a file from your local machine:

File Data Source Type: Select File Upload

(On-premises only) To select a file on a Gateway server, enter the following information:

File Data Source Type: Select File Path.

Shared Folder on the Gateway Server: Enter the file path and folder location of the data file. For example, C:\gateway\file

To upload a file using the FTP server, enter the following connection details:

File Data Source Type: Select FTPService.

FTP File Transfer Protocol list: Select FTP or SFTP.

FTP Service User Name: Enter the user name to sign in to the FTP service.

FTP Service Password: Enter the FTP user's password.

FTP Server Host: Enter the server hosting the FTP service.

FTP Server Port Number: Enter the port number associated with the FTP server.

FTP Server Folder Path: Enter the default folder location on the ftp server that will contain the XML file.

To upload a file using REST API, enter the following rest service connection details.

File Data Source Type: Select RestService.

Rest Service User Name: Enter the user name to sign in to the REST service.

Rest Service Password: Enter the REST service user's password.

Rest Service URL: Enter the URL address of the REST service.

Note: RestService only supports XML file format.

9) Select Test Connection to ensure connectivity with the source or destination application.

10) Select Save.

Tips


Adding or Editing a P6 Deployment Connection

To move data between applications, Primavera Gateway needs to know where to get and send information. Set this up by adding application deployment connections by specifying an EndpointURL for each application.

Add or edit a P6 deployment connection as follows:


http://<host name>:<port>/gateway

Where, <host name> and <port> should match those of your Primavera Gateway domain.


38




5) Select Add... or Edit....

The Deployment wizard displays.

6) In the General step, select P6 Provider, and name the deployment.


7) In the Deployment step, set up P6 connectivity from Gateway as follows:

Authentication Type: Select SAML 2.0 or Username Token from the list.

SAML 2.0 Token File: If you chose SAML 2.0 authentication, then browse or enter the location of the downloaded SAML 2.0 token XML file that is used by the P6 Web Services for authentication.

Username: Enter the name of the P6 administrator.

Password: Enter the case-sensitive password of the P6 administrator.

Endpoint URL: Enter the URL to connect with P6 Web Services in the format, http:<host name>:<port>/p6ws/services/SyncServiceV1

P6 Database Instance ID: Enter the database instance ID associated with the P6 application.

Enable Encryption: Select this option if you want to enable encryption when using P6 web services.

Keystore File: Enter or Browse... to the keystore file.

For more details on how to generate a keystore file and keystore password, see Enabling Encryption Between Gateway and P6 Web Services (on page 40).

Keystore Password: Enter the password for the keystore file.

Certificate Alias: Enter the certificate alias used for authentication.

P6 Currency: Enter the base currency for the P6 deployment.

8) (Optional) If you choose to synchronize P6 events on the web using the delivered P6 Event provider, enter the following information in the Event Provider tab:

In the JMS Connection Factory field, enter the local JNDI name from the Connection Factory object created in Configuring Gateway Domain for P6 Event Notification for On-Premises (on page 25). The connection factory contains a set of configuration parameters to connect with the P6 event provider. (on premises only)

In the JMS Queue field, enter the local JNDI name of the JMS Queue used to send and receive messages on P6 events from the destination setup created in Configuring Gateway Domain for P6 Event Notification for On-Premises (on page 25).

9) Select Test Connection to ensure connectivity with P6 is established.

10) Select Save.

Tips



39

Adding or Editing a Prime Deployment Connection

To move data between applications, you must first add application deployment connections for Prime and P6 so Primavera Gateway knows where to retrieve and send information.

To add an application deployment connection you must specify the Endpoint URL:





5) In the General step, select the Prime provider from the drop-down and name the deployment.

6) In the Deployment step, set up Prime connectivity from Gateway as follows:

User Name: Enter the name of the user with administration access to the Prime application.

Password: Enter the password to the Prime application.

End Point: Enter the URL to connect to the Prime application in the format: http://<server>:port/primeapi

7) Select Test Connection to ensure connectivity with Prime is established.

8) Select Save.

Adding a Sample Deployment Connection

To move data between applications, Primavera Gateway needs to know where to get and send information. If you choose to integrate with the Sample provider, add an application deployment connection for the Sample provider by specifying an Endpoint URL as follows:


http://<host name>:<port number>/gateway

Where, <host name> and <port number> should match those of your Primavera Gateway domain.




5) Select Add... to invoke the Add Deployment wizard.

6) In the General step, select the Sample provider and name the deployment.

7) In the Deployment step, set up connectivity from Gateway as follows:

Deployment Name: Enter a name for the Sample provider deployment.

Description: Enter a description for the deployment.

User Name: Enter the name of the user having access to the Sample provider deployment.

Password: Enter the user's password.

XML File Source: Enter the location of the XML file that is to be used by the Sample provider.


40

Data Source Type: Select the format of the data source being used. Choices include: File, Database.

8) In the Event Provider step:

Event File Path: Enter the file path and file name (XML file) that is to be used to trigger Sample eventing.

9) Select Test Connection to ensure connectivity with Gateway is established.

10) Select Save.

Tips


Adding or Editing a Unifier Deployment Connection

To move data between applications, Primavera Gateway needs to know where to get and send information. You set this up by adding application deployment connections by specifying an Endpoint URL for each application.

Add a Unifier deployment connection as follows:





5) In the General step, select the Unifier provider and name the deployment.

6) In the Deployment step, set up Unifier connectivity from Gateway as follows:

Short Name: Enter the short name of the company used in Unifier.

Authentication Code: Enter the authentication code to use when data is integrated with Unifier from external systems using web services.

End Point URL: Enter the URL to connect with Unifier application in the format: http://<host name>:<port>

7) Select Test Connection to ensure connectivity with Unifier is established.

8) Select Save.

Tips


Enabling Encryption Between Gateway and P6 Web Services

To ensure all requests and responses between Primavera Gateway and P6 Web Services are encrypted, you need a keystore file for encryption. There are several methods for generating a keystore file. You can use the following sequence to generate and use the same keystore file on all servers:

1) Create a Keystore file as follows:

a. Create a folder, for example, C:\keystore.

b. Use the Java keytool genkey command to create a keystore with the private key:


41

From the command line, execute:

keytool -genkey -alias <alias_name> -keyalg RSA -sigalg SHA1withRSA -keypass <keyPassword> -storepass <storePassword> -keystore <keystore file location>

Where:

<alias> is the key alias

<keyPassword> is the password of the private key

<storePassword> is the password of the keystore

For example:

keytool -genkey -alias myAlias -keyalg RSA -sigalg SHA1withRSA -keypass myPassword -storepass myPassword -keystore c:\keystore\keystore.jks

c. Enter information for each of the following questions:

What is your first and last name?

Enter the Gateway host name.

What is the name of your organization?

What is the name of your city or locality?

What is the name of your state or province?

What is the two-letter country code for this unit? For example, US.

Is CN=<Gateway host name>, OU=<organization unit name>, O=<organization name>, L=<location>, ST=<state code>, C=<country code> correct? Enter Y or N.

Note: If P6 Web Services is deployed on other than a Gateway machine, then copy the keystore folder with keystore.jks to the P6 Web Services machine.

2) In the Gateway user interface, select the Configuration tab and enter deployment information for P6. For more details, see Adding or Editing a P6 Deployment Connection(on page 37).

3) In P6 EPPM administration application:

a. Enter the keystore information that was entered in the keystore file. The values must be identical.

b. Modify the message protection node setting as follows:

Set the Require Timestamp value as True.

Set the Require Digital Signature for Incoming Messages value as True.

Set the Require Encryption for Incoming Messages value as True.

In the KeyStore Type field, enter JKS.

In the File Location field, enter the location of the .jks file. For example, c:\keystore\keystore.jks

In the KeyStore Password field, enter the password for the keystore file provided in keytool command.

In the Private Key Alias field, enter the alias name provided in keytool command.


42

In the Private Key Password field, enter the private key password for the keystore file provided in the keytool command.

Set the Encrypt Response value as True.

If the encryption is on in Primavera Gateway, then NONCE and CREATED are included in the header for UserName Token authentication. To enable this:

Set the NONCE value as True.

Set the CREATED value as True.

4) After encryption is set, restart P6 Web Services.

Configuring Gateway User Interface Settings

Use the Settings dialog box to configure Gateway settings such as the Help location or whether to create new code values during synchronization. The settings available in this dialog box may vary depending on the specific providers Primavera Gateway is currently using.

To configure Gateway application settings:

1) Select and then select Settings.

2) Update the settings as necessary and select Save when finished.

On the General tab:

Help URL: The version of the help system that is hosted by Oracle is located at http://docs.oracle.com/cd/E80548_01/help/en/index.html

(on premises only) If you deployed the local Help, then enter the default Help URL location as: http://<hostname>:<port>/gatewayhelp

Maximum number of job logs to display: Enter a value to control the number of logs displayed on the Monitoring page.

Maximum wait time for the parallel load/convert steps to complete (in minutes):Enter the number of minutes after which a synchronization job process is to be timed out. By default, the duration is set to 30 minutes. The job status of a timed-out synchronization is set to Failed.

Maximum concurrent jobs in a node: Enter the maximum number of jobs that can be executed concurrently at a node.

Job Polling Interval (in seconds): Enter the wait time interval in seconds to check the database if there are new jobs to run.

Maximum File Size Limit (in MB): Enter the maximum file size limit for uploading files from Gateway user interface or from external applications. The file size limit applies to all providers and all supported file formats: CSV, XML, XLS, and XLSX.

If you choose to integrate with P6, enter the following information on the P6 tab:

Create new resource code values during synchronization to P6: Select this option to enable the creation of new resource code values in the P6 EPPM resource code dictionary if these values do not already exist.

Create new project code values during synchronization to P6: Select this option to enable the creation of new project code values in the P6 EPPM project code dictionary if these values do not already exist.

Configuring Gateway User Interface Settings

43

Create new activity code values during synchronization to P6: Select this option to enable the creation of new global activity code values in the P6 EPPM activity code dictionary if these values do not already exist.

Include time zone when exporting from P6: Select this option to export P6 server time zone information along with P6 date and time fields. By default, this option is not selected, except for spread interval data in P6.

Note: This time zone setting applies only for a P6 - Prime integration.

Update activity resource assignments when assigned UDF values match: Enter the UDF code value that is assigned to resource assignments which you want to update during a synchronization. Use this to update the resource assignment with the matching UDF value when the assignment exists multiple times on an activity.

Maximum wait time for the summarizer to complete (in seconds): Enter the amount of time in seconds to wait for the summarizer to complete before a warning is given.

On the Mail Configuration tab:

SMTP Server: Enter the SMTP server address of your email server.

Port Number: Enter the port number of your email server.

Email Security: Select the applicable email security type. Choices include, SSL, TLS, and None.

Email Address: Enter the email address for the user who set up Primavera Gateway.

Authorized User: Enter the user name for this email account.

Password: Enter the password for the authorized user.

Bounce Email Address: Enter an alternate email address to be used if mail fails to be delivered to the first email address.

45

Configuring Online Help

Primavera Gateway provides two configuration options you can use to set up online help:

Hosting Online Help (on page 45) (default configuration)

Deploying Help Locally (on page 45)

In This Section

Hosting Online Help ................................................................................................. 45 Deploying Help Locally ............................................................................................ 45

Hosting Online Help

This is the default configuration for the application online help. The online help is hosted by Oracle, where it is accessed when users select Help in the Gateway application. This version is the most up-to-date version of the help.

The hosted version is the default setting in Gateway Configuration Settings.

Deploying Help Locally

If you want to deploy the application help locally, you must download the online help WAR file and deploy it in your environment. The WAR file can be deployed in the same domain as Primavera Gateway or in a separate domain.

After you download and deploy the help locally, you must specify the URL to access the online help in the Configuration Settings of the Gateway application. For information about configuring the Online Help location setting, refer to Configuring Gateway User Interface Settings (on page 42).

To deploy the Gateway help locally:

1) Download the Gateway Help WAR file from: http://docs.oracle.com/cd/E80548_01/help/war/gatewayhelp.war

2) Sign in to the WebLogic Administration Console at: http://<hostname>:<port>/console

3) In the Change Center pane, select Lock & Edit.

4) In the Domain Structure pane, select Deployments.

5) In the Summary of Deployments pane, select the Control tab.

6) Select Install.

7) In the Install Application Assistant pane:

a. Enter the path of the directory where the online help WAR file is located.

b. Select the gatewayhelp.war option.


46


c. Select the Install this deployment as an application option.

d. Depending on your configuration, select the Target as AdminServer or GatewayCluster for a managed server.

8) Review the configuration settings you have chosen, and then select Finish to complete the installation.

9) In the Settings for Primavera window, select Save.

10) Select Activate Changes.

11) In the Summary of Deployments pane, select Start for gatewayhelp.war.

12) To test the online help deployment, launch a web browser and enter the URL of the online help deployment using this address: http://<hostname>:<port>/gatewayhelp/en/user/helpmain.htm.

Downloading Customization SDK

To extend Gateway features outside the Primavera Gateway framework, download Customization SDK as follows:

1) Select the Help menu.

2) Select Customization SDK from the list.

3) Save Customization.zip to a local folder.

4) Extract the zip contents.

5) Use the Customization SDK to create the following features:

External custom steps

Create, deploy, and maintain external custom steps outside the Gateway framework when Gateway is deployed as a cloud service or on-premises. Use external custom steps in business flows and synchronizations as-needed and on-demand.

Control or limit the use of external custom steps to specific combinations of source and destination applications.

For more details how to implement an external custom step, see gateway_external_custom_step_SDK.HTM in the SDK download.

A Sample External Custom Step is also delivered in Gateway. For more details on how to use the Sample External Custom Step in a business flow and a synchronization, see Readme_Gateway_External_Custom_Step.txt in the SDK download.

External Providers

Create, deploy, and maintain external providers outside the Primavera Gateway framework to support integrations with new applications. An external provider is a generic provider application that can be called on-demand to support integrations with any new ERP application.

For more details on how to implement external provider applications, see gateway_external_provider_SDK.HTM in the SDK download.

Performing a Gateway Environment Validation Check

47

A Sample External Provider is also delivered in Gateway. For more details on how to use the Sample External Provider in a business flow and a synchronization, see Readme_Gateway_External_Provider.txt in the SDK download.

Note: Customization SDK is available for Gateway as a cloud service, and on-premises installations on a managed server.

Performing a Gateway Environment Validation Check

After installing or upgrading Gateway, run the Environment Validation Check utility to perform a quick status check on the server environments required to run Gateway as follows:

1) Go to: ../<Gateway download location>/Gateway/validationchecker

2) Edit validationchecker.properties.

Note: You can also use the information from the <gateway installed location>\wlst\gateway_config.properties to include in validationchecker.properties.

3) Update the properties file with Gateway database connection details, and select Save.

4) Run the following executable:

For Windows 64-bit Installations: Run EnvironmentCheck.bat

For Linux and Solaris 64-bit Installations: Run /EnvironmentCheck.sh

5) An EnvironmentCheck.html is generated in the validationchecker folder.

6) Open EnvironmentCheck.html and review the following information:

Versions of JDK, Gateway providers, and the Oracle database

Pass or fail status of tablespaces, DB connection, Gateway schema and Gateway application

49

Uninstalling Primavera Gateway

Uninstall Primavera Gateway as follows:

1) Invoke the Uninstall wizard as follows:

For Windows, from the Start menu, select Oracle,-<Gateway Home>, Uninstall Oracle Software.

or

Execute <Gateway installed folder>\oui\bin\deinstall.cmd

For Linux and Solaris, execute the following commands:

cd <GatewayHome>/oui/bin

./deinstall.sh



3) On the Deinstallation Summary screen, select Deinstall.

4) On the Deinstallation Progress screen select any of the following buttons:

Select View Messages to review messages during the uninstall process.

Select View Log to view log messages during the uninstall process.

5) On the Deinstallation Complete screen, select Finish to exit the wizard.

6) Delete the Gateway domain folder.

For Admin server, delete the Gateway domain folder from the <WebLogic_HOME>/user_projects/domains directory.

For Managed server, delete the Gateway domain folder from the <WebLogic_HOME>/user_projects/domains and <WebLogic_HOME>/user_projects/applications directories.

7) If installed on a managed server, run the RCU utility and drop the repository.

8) Log in to the Oracle database and drop the Gateway schema user that was created at installation.

9) Delete the Primavera Gateway home folder that was created during installation.

50

Oracle Primavera Gateway Installation and Configuration Guide for On-Premises

Copyright © 2013, 2017, 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.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

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.

Legal Notices

Documents

Gateway Installation and Configuration Guide for …...Gateway Installation and Configuration Guide for On-Premises 6 Primavera Gateway On-Premises Installation Prerequisites Primavera