API Setup

Primavera P6 Integration API
Administrators Guide
Version 6.2.1
Copyright 2003, 2009, Oracle and/or its affiliates. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software-Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party. To view the P6 Commercial Notices and Disclosures for Documentation, go to the \Documentation\<language>\Notices and Disclosures folder of the P6 physical media or download. After installing Primavera P6 Integration API, it is also available in the \docs folder of your Primavera P6 Integration API installation folder.
iii
Table of Contents
Preface...................................................................................................v
Using this Administrators Guide ........................................................................ vi Where to Get Support .........................................................................................vii
Installing the Integration API.............................................................1

What is the Integration API?................................................................................. 2 System Requirements............................................................................................ 3 Integration API Installation Process ..................................................................... 4 Deploying the Integration API for Remote Mode ................................................ 7 Changing Database Configuration Settings ........................................................ 12 Enabling Access.................................................................................................. 13 Java Security Manager ........................................................................................ 14 Using the Primavera Administrator Application ................................................ 15 Starting the Primavera Administrator Application ............................................. 16 Reviewing and Modifying Integration API Configurations................................ 17 Integration API Configuration Settings .............................................................. 21
Configuring Authentication Modes ..................................................45

Authentication Modes......................................................................................... 46 Implementing Non-Native Authentication.......................................................... 47 Choosing an Authentication Scheme .................................................................. 48 Running the Authentication Configuration Wizard ............................................ 49 Configuring Integration API Authentication ...................................................... 60 Logon/Logout Changes to Support Authentication Modes ................................ 61
Index....................................................................................................63
Preface
In this preface:
Using this Administrators Guide Where to Get Support
The Primavera Integration API is a Javabased API and server that enables developers to create client code that can seamlessly access Primaveras project management functionality.
vi
Primavera Integration API
Using this Administrators Guide

This guide describes the steps required to install the Primavera Integration API and how to configure it to use one of three authentication modes. It is organized as follows: Installing the Integration API Describes how to install the Primavera P6 Integration API and explains how to use the Primavera Administrator to review, modify, add, and delete Integration API server configurations. Configuring Authentication Modes Describes the authentication modes available in this release and explains how to configure the Primavera Integration API to operate using one of three authentication modes.
Preface
vii
Where to Get Support

If you have a question about using Primavera products that you or your network administrator cannot resolve with information in the documentation or Help, contact Primavera Customer Support at the times and locations listed below. Please provide your Primavera product serial number when contacting Primavera. Each interaction is logged to help Primavera resolve your questions quickly.
Office
Time Zone Hours

8:008:00 (MonFri) 9:002:00 (Sat) 8:306:30 (MonThur) 8:305:30 (Fri) 8:005:00 (MonFri)
Telephone
+1-610-668-3030
FAX
+1-610-667-0652
E-mail Address*
support@primavera.com
Bala Cynwyd, ET Pennsylvania, USA London, England, UK GMT
+44-20-8563-5555
+44-20-8563-5543
Hong Kong
GMT +8
+852-2111-8299
+852-2111-9477
*Primavera's Web site at http://www.primavera.com/customer/index.asp provides support and product information, such as knowledge bases, file downloads, user group and newsgroup information, and a product enhancement request form.
In the United States, Primavera periodically and randomly monitors technical support calls to ensure that you receive the highest quality support.
All Primavera products are backed by comprehensive support and training.
Administators Guide
Installing the Integration API

In this chapter:
What is the Integration API? System Requirements Integration API Installation Process Deploying the Integration API for Remote Mode Changing Database Configuration Settings Enabling Access Java Security Manager Using the Primavera Administrator Application Starting the Primavera Administrator Application Reviewing and Modifying Integration API Configurations Integration API Configuration Settings
This chapter describes how to install the Primavera Integration API. In addition, this chapter explains how to use the Primavera Administrator to review, modify, add, and delete Integration API server configurations.
What is the Integration API?

The Primavera Integration API is a Java-based API and server that enables developers to create client code that can seamlessly access Primaveras project management functionality.
System Requirements
The Primavera Integration API has the following system requirements for both local and remote mode installations: Java Runtime Environment
If you write code against the interface, you need to install the Java Development Kit (JDK), version 1.5.x, also known as J2SE 5.0. While the Primavera Integration API is compatible with any 1.5 version, we recommend using Update 13 or later. The Integrated Development Environment (IDE) you use to create code must work with this version. If you do not plan on writing code against the interface and will only be running the sample applications, you will need to install only the Java Runtime Environment (JRE), version 1.5.x, also known as J2SE 5.0. While the Primavera Integration API is compatible with any 1.5 version, we recommend using Update 13 or later. You can download the JRE or Java JDK from the Sun Microsystems Web site. If you are using the Java JDK, ensure that it is installed before running the Integration API setup.
For the full list of supported operating systems and database versions, refer to the testedcfg.pdf file, which is provided in the \Documentation\ <language>\Technical Documentation folder on the P6 physical media or download.
Operating Systems The Primavera Integration API is fully supported on Windows, Solaris, and Linux operating systems.
Even though the JRE and JDK are available on other operating systems, they have not been tested by Primavera Systems.
Project Management Database
A Primavera P6 project management database (Oracle, SQLServer, and SQL Server Express are supported)
Application Servers Remote mode installations of the Primavera Integration API require one of the following supported application servers:

JBoss 4.0.5 BEA WebLogic Server 10 IBM WebSphere Application Server 6.1
Integration API Installation Process

For information on installing the project management database and the client application, see the Primavera P6 Administrators Guide (adminguide.pdf), which is provided in the \Documentation\ <language>\<industry> folder on the P6 physical media or download.
Before installing the Integration API, you need to install the project management database and the P6 Project Management client module. Additionally, you must uninstall any earlier versions of the API before installing the current version.
The Primavera Project Management client module does not have to be installed on the same server as the Primavera Integration API.
The Integration API Installer provides a wizard to guide you through the installation process, which includes

Choosing the installation mode Installing the Integration API client side and server side libraries Setting up and configuring the Integration API database
Before you start the installation, make sure you set the JAVA_HOME environment variable.
To install the Integration API 1 Go to the root folder of the Integration API Installation CD-ROM: For the Windows platform, double-click setup.exe. For the Solaris platform, run setupSolaris.bin For the Linux platform, run setupLinux.bin
Click Next on each wizard dialog box to advance to the next step.
2 On the Welcome screen, click Next. 3 On the Please select the installation type screen, specify the installation mode. Local Mode - Choose this option to use the API in local mode, without Java RMI. This option installs client-side and server-side Java libraries, database configuration tools, and javadoc. Client Side Packages Only - Choose this option to use the API in remote mode. This option installs client-side Java libraries and javadoc.
The maximum number of clients that can access a remote server at one time is approximately 50. This number may be less, depending on multiple factors (e.g., system hardware, network configuration, the number of available licenses, etc.).
After installing the client-side packages, to complete a remote mode installation, install the Integration API on a separate machine using the following option. Supported J2EE compatible application or Web servers
This option installs the Integration API application file, PrimaveraAPI.war, into the applications subdirectory of the destination you specify in the wizard. The PrimaveraAPI.war file contains both client-side and server-side libraries, database configuration tools, and the javadoc. You can deploy the Integration API as a Web application into any J2EE-compatible application or Web server that supports JDK/JRE 1.5.x. 4 On the Please specify the location of . . . dialog box, type or browse to the Integration API installation location and the location of the JRE. The default location of the Integration API is: c:\Program Files\Primavera\IntegrationAPI The default location of the JRE is: c:\Program Files\Java\jre1.5.x The setup wizard should detect and prefill the location of the JDK. Edit the location if desired.
If you setup the JAVA_HOME environment variable, the location of the JRE is automatically filled in for you.
5 On the Please select the components . . . dialog box, select the components to install, then click Next to start the installation. 6 On the dialog box that lists the components and features to be installed, click Next to start the installation. 7 On the Setup and Configuration of the Primavera Database dialog box, specify the database type.
You can later change the database type through the Integration API Database Configuration Setup.
8 On the Please enter the following information . . . dialog box, specify the database connection parameters.
The Integration API requires pubuser access (in the User Name field) to the database.The database name, host address, and host port are specific to your Oracle or MS SQL Server installation. Database Host Port displays the default port for the database type you selected. You can edit this port.
For more information about configurations, see Using the Primavera Administrator Application on page 15.
9 On the The installer has detected an existing . . . dialog box, choose the appropriate action. The configuration stores server-side settings for the server.
If your site includes P6 Web Access, you can share a new Integration API configuration with P6 Web Access. However, an existing configuration for P6 Web Access cannot be shared with the Integration API because it will not provide support for new Integration API configuration settings.
If there is no existing configuration, the The installer has detected an existing . . . dialog box does not appear and the installation process automatically creates a default configuration named Primavera Configuration. You can edit the settings for this configuration through the Primavera Administrator Application.
After installation, you can use the Database Configuration Setup wizard to choose or create a different configuration, if necessary.
10 When the message displays to confirm that the database configuration has completed successfully, click OK. Then, click Finish to close the Setup wizard. You will now have the following shortcuts appended to the Primavera Integration API entry in your Start menu:

Demo applications Documentation (Java API Documentation, License, Programmers Reference, Release Notes, and Readme) Configuring the database connection Running the Administrator application Starting and stopping the application server (Remote mode installation only) Uninstall Primavera Integration P6 API
Deploying the Integration API for Remote Mode

If you selected Supported J2EE compatible application or Web servers when installing the Integration API, you need to then deploy the API into the appropriate application or web server that supports JDK/ JRE 1.5.x.
Refer to your application server documentation for detailed deployment instructions.
Deploying into JBoss 4.0.5 on Windows Do the following to deploy the Integration API into JBoss on Windows: When deploying into JBoss, note the following: 1 Go to the <JBOSS INSTALL LOCATION>\server folder. 2 Select the folder named default and create a copy of it. 3 Rename the copied folder to primaveraAPI. 4 Copy the PrimaveraAPI.war file from the Integration API home folder to the following JBoss folder.
<JBOSS INSTALL LOCATION>\server\primaveraAPI\deploy\
5 For international support, edit the following file:

<JBOSS INSTALL LOCATION>\server\primaveraAPI\deploy\jbosswebtomcat55.sar\server.xml In the Connector setting, add the parameter URIEncoding="UTF-8". For example:  <Connector port="8080" URIEncoding="UTF-8" address="${jboss.bind.address}" maxThreads="250" strategy="ms" maxHttpHeaderSize="8192" emptySessionPath="true" enableLookups="false" redirectPort="8443" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true"/> When you are using the SSL-connector, add this parameter to its settings as well.
6 In the run.bat file in the bin folder, insert the following line before the :RESTART line: set JAVA_OPTS="-Dprimavera.bootstrap.home=<Integration API home>" %JAVA_OPTS% Change <Integration API home> to the appropriate location/ 7 Create a bat file named startPrimaverAPIinJboss.bat that contains the following: @echo off set JBOSS_HOME=C:\jboss-4.0.5.GA call %JBOSS_HOME%\bin\run.bat -c primaveraAPI This bat file is necessary for starting the JBoss application server.
Deploying into Weblogic 10

Note: We recommend that the WebLogic application server should be set to run in "non-production" mode (i.e. Development Mode). To run in non-production mode, the WebLogic Startup Parameter "StartMode=" must be left blank. After performing the steps below to complete the Integration API deployment, set the WebLogic Startup Parameter "StartMode=" to true and reboot the WebLogic application server. However, if you want to keep the WebLogic application server in production mode, you need to manually deploy the PrimaveraAPI.war file.
Do the following to deploy the Integration API into Weblogic: 1 Run the WebLogic Configuration Wizard to create a server domain for the Integration API application. On the Configure Server Start Mode and JDK window, you MUST select Development Mode in the WebLogic Domain Startup Mode left hand pane. 2 Copy the PrimaveraAPI.war file from the Integration API home folder to the following WebLogic folder for auto-deployment.
<bea_home>\user_projects\domains\<integration API domain>\autodeploy
3 Edit the file startweblogic.sh (Unix) or startweblogic.cmd (Windows) in the <bea_home>\user_projects\domains\<integration API domain>\bin\ folder as follows: Add the Integration API bootstrap variable to the Java options. Before editing, make a backup copy of the file in case you need to undo any changes. Windows example:
set JAVA_OPTIONS=-Dprimavera.bootstrap.home="<integration API home folder>"
Unix example:
JAVA_OPTIONS="-Dprimavera.bootstrap.home=<Integration API home>${SAVE_JAVA_OPTIONS}"
10
Deploying into Websphere 6.1 Do the following to deploy the Integration API into Websphere: 1 Start the Websphere Application Server. 2 Launch the WebSphere Application Server Administrative Console. 3 In the left-hand navigation pane, expand Servers and click Application Servers. 4 On the Application Servers screen, click the server name link. 5 On the Configuration tab, under Server Infrastructure, expand Java and Process Management. 6 Click Process Definition. 7 Under Additional Properties, click Java Virtual Machine. 8 Under Generic JVM arguments, type:
-Dprimavera.bootstrap.home=c:\apihome
(where 'c:\apihome' is the installation directory). 9 Click OK. Click the Save link that appears within the message reporting changes. 10 In the left-hand navigation pane, expand Applications and click Install New Application. 11 Specify the path to the war file in the apihome folder. For example:
c:\apihome\applications\primaveraapi.war
12 For the Context Root, type apiprimavera, then click Next. 13 In the Step 1 section "Select Installation Options", click Next. 14 In the Step 2 section "Map Modules to Servers", mark the Primavera Integration API checkbox, and click Next. 15 In the Step 3 section "Map Virtual Host for Web Modules", mark the Primavera Integration API checkbox, and click Next. 16 On the Step 4 screen (Summary), click Finish. Note that the application war file is now deploying and this process may take several minutes. 17 To save the master Websphere configuration, click Save. This process may also take several minutes.
11
18 On the Administrative Console Main screen, in the left-hand navigation, expand Applications and click Enterprise Applications. 19 Locate PrimaveraAPI.war and check its application status. If it is not a green arrow, click the Start button above the Select column. 20 If necessary, restart the Websphere application server.
12
Changing Database Configuration Settings

The Integration API Database Configuration wizard lets you create a new configuration or switch to a different configuration than the one specified during the Integration API installation. The database you connect to during the installation stores one or more Integration API configurations. Each configuration specifies a set of configurable parameters that determine how the Integration API operates. The first time you install the Integration API, and if no configuration exists in the database, you must create a new configuration. For subsequent installs, you can choose an existing configuration or create a new one. After installation, you can use the Database Configuration wizard to select a different Integration API configuration or create a new one.
After selecting a different Integration API configuration or creating a new configuration, you must stop and restart the server for the changes to take effect.
Starting the Database Configuration wizard
On Windows, from the Start menu, choose Programs, Primavera Integration API 6.2, Database Configuration. On Solaris/Linux, change to the PrimaveraAPI directory under the application server install directory and run the dbconfig.sh script.
13
Enabling Access
Before users can log in to the API, they must be granted access via a named license in the Project Management module (select Admin, Users; click the Licensing tab; mark the box under Named User for Integration API).
14
Java Security Manager

The Java security manager enables programmers to establish a custom security policy for their Java applications.
The Java security manager is not supported for IBM WebSphere Application Server v 6.1.
Unless it is specifically enabled when the API server is started, the security manager is disabled. To enable/disable the security manager, edit the API servers startup script with a text editor and uncomment/ comment the appropriate command (see below). For Windows platforms, edit startAppServer.cmd. For Solaris/ Linux, edit startAppServer.sh. WebLogic 10
Windows: SET ENABLE_JAVA_SECURITY_MANAGER=-Djava.security.manager Solaris/Linux: ENABLE_JAVA_SECURITY_MANAGER=-Djava.security.manager The API server may use different policy files for different application/web servers.
15
Using the Primavera Administrator Application

As the system administrator, you can use the Primavera Administrator Application to review, modify, add, and delete server configurations. Integration API server configurations are stored in the database specified during installation. These configurations contain all of the settings used to run the Integration API server.
Only experienced administrators should use the Administrator Application to modify configuration settings.
16
Starting the Primavera Administrator Application

After launching the Administrator Application, you will be prompted for a database level password for the privuser account. Starting the Administrator Application
On Windows, from the Start menu, choose Programs, Primavera Integration API 6.2, Primavera Administrator. On Solaris/Linux, change to the PrimaveraAPI directory under the application server install directory and run the admin.sh script.
17
Reviewing and Modifying Integration API Configurations

The Primavera Administrator Application presents configuration settings in a tabbed dialog box. Tree view and Table view display the current configurations and settings. Log displays a history of configuration changes, additions, or deletions for the current session.
You cannot edit the Factory Default configuration settings. You can only modify custom configurations.
To display brief setting descriptions in Tree or Table view, mark the Show tool tips checkbox. Then, position the mouse over a setting to read the popup description.
Click to display a hierarchical view of the configuration data.
To return a setting to its default value, select it, then right-click and choose Revert to default value. To change a setting value, triple-click on the setting name, then type a new value. On Windows, you can also press F2 to change to Edit mode.
18
Click to display configuration settings in a table format.
To change a setting value, select the setting, click in the Value column, then type a new value.
To sort the table, click a column heading. Sorting can help you distinguish similar settings contained in multiple configurations.
Add Integration API configurations To create a new configuration, you can duplicate an existing configuration.
To duplicate a configuration, select the configuration name in Tree View, then right-click and choose Duplicate. Enter a name for the configuration, then click OK. Edit the settings as needed. To create a new configuration based on factory default settings, right-click on Factory Defaults in Tree View and choose Duplicate.
Add database instances to a configuration The Integration API enables you to access data from different project manager databases. When you configure the Integration API to support multiple database instances, you can choose the instance you want at login. To add a new database instance to an Integration API configuration, you duplicate an existing instance.
To duplicate a database instance, select the icon representing the instance, then right-click and choose Duplicate. Enter a unique name for the new instance and edit other settings as needed.
19
Delete Integration API configurations and database instances To delete a configuration or database instance, select it, then right-click and choose Delete. You cannot delete the Factory Defaults configuration. You can delete any custom configuration, but not all of them. There must always be at least one custom configuration. You can delete any database instance associated with a configuration, but not all of them. Each configuration must have at least one database instance.
For more information, see Database.Instance.Driver and Database.Instance.URL in the Integration API Configuration Settings on page 21.
Database driver configurations The following table lists the database drivers the Integration API supports for each application server/database configuration. Use the Database.Instance.Driver configuration setting to specify the database driver you are using. Application Server
WebLogic WebLogic JBoss JBoss WebSphere WebSphere
Database Type
Oracle SQL Server, SQL Server Express Oracle SQL Server, SQL Server Express Oracle SQL Server, SQL Server Express
Database Driver
Oracle Thin Client SQL Server 2005 JDBC Oracle Thin Client SQL Server 2005 JDBC Oracle Thin Client SQL Server 2005 JDBC
Default
Y Y Y Y Y Y
20
Configure Integration API Authentication The Integration API uses a single configuration setting to support authentication.
Authentication.Mode
Because one Integration API server instance may control more than one database, in addition to specifying an authentication mode for a database through the Authentication Configuration wizard, you use the Authentication.Mode configuration setting to specify the overall mode you want to use for the Integration API server. For LDAP authentication with secure communication (SSL) between the Integration API server and the LDAP server, two additional configuration settings are required. For more information about each of these settings, refer to the [Authentication Settings] on page 22.
An Integration API configuration might include database instances that are not set to the same authentication mode as the Integration API server. If a user connects and requests a database that is set to a different authentication mode than the Integration API server, an error message displays. The user must select a database that matches the authentication mode set for the Integration API server.
21
Integration API Configuration Settings

You can review and modify configuration settings in the Primavera Administrator Application Tree View or Table View. Configuration settings are stored in the Integration API database specified during installation.
Only experienced administrators should use the Primavera Administrator Application to modify configuration settings.
Localization settings are not applicable for the Integration API.
You can specify durations (time-related values) in several ways:
As a simple number, which is treated as milliseconds. For example, 240000 would be equivalent to 4 minutes (240000/ 60000).
In the form <n>d<n>h<n>m<n>s, where d is days, h is hours, m is minutes, and s is seconds. All parts are optional. For example, you can enter: 1d2h30m20s 4m 1h30s
[Localization Settings] Setting Name and Description

Localization/System Language Language for server string constants Localization/System Country Country for server string constants
Default
en US
Valid Ranges/Values

22
[Authentication Settings] Setting Name and Description

Authentication/Mode The method used for client authentication. Authentication/Web Single Sign-On/User Name Header Key The name of the http header you specified in SiteMinder. The value you specify must match the property of a SiteMinder response you have created under the policy domain/realm within which the Web server for P6 Web Access resides. The value of this response should be smuser=uid, where smuser is configurable and uid matches the LDAP server attribute that maps to the Primavera database USER_Name field. /Primavera Authentication/Web Single Sign-On/Context Path Override The path used to pass web requests from the SiteMinder Web server to the server of P6 Web Access. Authentication/Web Single Sign-On/Server and Port Override The fully qualified domain name and port for the Web server that SiteMinder is controlling.
Default
NATIVE smuser
Valid Ranges/Values
Native, LDAP, WebSSO
http:// servername.domain.co m:82
Authentication/LDAP/SSL Certificate Store The full path to the keystore that holds the SSL certificate for the LDAP server. Authentication/LDAP/SSL Store Password The password for the keystore that holds the SSL certificate.
23
[Database Settings] Setting Name and Description

Database/Instance/Name The name of this database instance. Database/Instance/Description A description of this database instance. Database/Instance/Schema The schema that will be defined for the database. Database/Instance/URL The database URL used to establish a connection to the database. Oracle example: jdbc:oracle:thin:@xx.xxx.xxx.xx:yyyy:zzzz SQL example: jdbc:sqlserver://xxxx:yyyy;database=zzzz; x = IP address or hostname y = database listen port z = database name Database/Instance/Public Group ID The public group ID used to establish a connection to the database. Database/Instance/User Name The name used to establish a connection to the database. 1
Default
PMDB
Valid Ranges/Values
up to 32 characters up to 128 characters
pubuser
All, None, Failed Attempts, Successful Attempts 0-100000
Database/Instance/Password pubuser The password used to establish a connection to the database. Database/Instance/User Security/Log Login Attempts Specifies whether or not login attempts to P6 Web Access are tracked in the Web Access logs. Database/Instance/User Security/Login Lockout Count The number of times a user can attempt to login before the account is locked. A setting of 0 allows an unlimited number of attempts. The count resets after each successful login. All
24
[Database Settings] Setting Name and Description Default Valid Ranges/Values

0-24d
Database/Instance/User Security/Login Lockout 1h Duration The length of time that a user is blocked from logging into P6 Web Access, starting from the point at which the Logging Lockout Count was exceeded. This setting will be overridden if a users session is manually reset by an Admin Super user. For more information, see the Primavera P6 Administrators Guide. Database/Instance/User Security/Allow Multiple User Yes Sessions Specifies whether a single user can be simultaneously logged into Web Access. A setting of Yes will allow a single user to login multiple times on any machine. A setting of No restricts a user to logging in only once on any machine. A setting of Single Machine allows a user to log in multiple times on the same machine, as long as the application server is configured properly to determine the IP address of the machine making the request. For example, if the application server is behind a proxy server, this setting will default to Yes instead of Single Machine. Database/Instance/Connection Pool [aaa]/Resize Rate 4m The timeout period after which the system will adjust the number of database connections to be equal to the maximum number of database connections concurrently used during the last period. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested.
Yes, No, Single Machine
4m - 12h
25

10s - 1h
Database/Instance/Connection Pool [aaa]/ 1m Maintenance Frequency The run frequency of the maintenance that ensures leases have not exceeded the maximum duration. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Connection Pool [aaa]/ 30s Lease Request Wait Timeout The amount of time a request for a database connection will wait. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Connection Pool [aaa]/ 50 Maximum Connections The maximum number of connections the server will have to the database. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested.
5s - 2h
5 - 15000
26
Database/Instance/Connection Pool [aaa]/Fetch Size 120 A hint to the database driver for how many rows to fetch at a time. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Connection Pool [aaa]/Trace SQL false Trace all SQL sent to the database. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Connection Pool [aaa]/ 3 Renewable Free Limit The minimum number of connections that should be available for leases to be renewed. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested.
true/false
3-5
27

true/false
Database/Instance/Connection Pool [aaa]/ PMR - false Renewable Leases PML - false If false, each connection can be leased only for the PMT - true MaxLeaseDuration period. If true, connection leases are renewed if database statements are completed within the MaxLeaseDuration time period. When true, the code can hold onto the connection as long as it needs, provided SQL statements are completed within the MaxLeaseDuration period. When true, the connection is revoked if no SQL statements are issued within the MaxLeaseDuration period or if one statement takes longer to execute than that period. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Connection Pool [aaa]/ PMR - 2m PML - 10m Maximum Lease Duration The maximum amount of time a database connection can be PMT - 10m leased before it is revoked. [PMR] Used for the standard connection pool, which is the most frequently used connection pool in the Business Rule Engine. [PML] Used for the long running connection pool, which is used in the Business Rule Engine when scheduling long running jobs. [PMT] Used for the transactional connection pool, which is used in the Business Rule Engine when a client transaction is requested. Database/Instance/Group Server/Protocol Protocol for GroupServer Database/Instance/Group Server/Server GroupServer host machine name Database/Instance/Group Server/Port GroupServer host listen port socket servername 9002
PMR - 5s - 4h PML - 5s - 6h PMT - 5s - 6h
http, https, socket
28

Database/Instance/Group Server/URL GroupServer servlet URL. Database/Instance/Methodology Management/Name Name of this database instance. Database/Instance/Methodology Management/ Description Description of this database instance. Database/Instance/Methodology Management/URL Database URL used to establish a connection to the database. Oracle example: jdbc:oracle:thin:@xx.xxx.xxx.xx:yyyy:zzzz SQL example: jdbc:sqlserver://xxxx:yyyy;database=zzzz; x = IP address or hostname y = database listen port z = database name Database/Instance/Methodology Management/User Name The name used to establish a connection to the database.
Default
http:// servername
Valid Ranges/Values

Database/Instance/Methodology Management/Password The password used to establish a connection to the database. Database/Instance/Methodology Management/ 1 Public Group ID The Group ID used to establish a connection to the database. Database/Instance/Methodology Management/ MMDB Database Alias The DB Alias name used by the Project Architect job service to create a project plan from a methodology. Database/Instance/Methodology Management/ 4m Connection Pool [MMR]/Resize Rate The timeout period after which the system will adjust the number of database connections to be equal to the maximum number of database connections concurrently used during the last period.
4m - 12h
29

Database/Instance/Methodology Management/ Connection Pool [MMR]/Maintenance Frequency The run frequency of the maintenance that ensures leases have not exceeded the maximum duration.
Default
1m
Valid Ranges/Values
10s - 1h
Database/Instance/Methodology Management/ 30s Connection Pool [MMR]/Lease Request Wait Timeout The amount of time a request for a database connection will wait. Database/Instance/Methodology Management/ 50 Connection Pool [MMR]/Maximum Connections The maximum number of connections the server will have to the database. Database/Instance/Methodology Management/ 120 Connection Pool [MMR]/Fetch Size A hint to the database driver for how many rows to fetch at a time. Database/Instance/Methodology Management/ Connection Pool [MMR]/Trace SQL Trace all SQL sent to the database. Database/Instance/Methodology Management/ Connection Pool [MMR]/Renewable Free Limit The minimum number of connections that should be available for leases to be renewed. false
5s - 2h
5 - 15000
true/false
3-5
Database/Instance/Methodology Management/ false Connection Pool [MMR]/Renewable Leases If false, each connection can be leased only for the MaxLeaseDuration period. If true, connection leases are renewed if database statements are completed within the MaxLeaseDuration time period. When true, the code can hold onto the connection as long as it needs, provided SQL statements are completed within the MaxLeaseDuration period. When true, the connection is revoked if no SQL statements are issued within the MaxLeaseDuration period or if one statement takes longer to execute than that period. Database/Instance/Methodology Management/ 2m Connection Pool [MMR]/Maximum Lease Duration The maximum amount of time a database connection can be leased before it is revoked.
true/false
5s - 4h
30

Database/Instance/Content Repository/URL Database URL used to establish a connection to the database. Oracle example: embedded://jdbc:oracle:thin:@xx.xxx.xxx.xx:yyyy:zzzz SQL example: embedded://jdbc:sqlserver://xxxx:yyyy;database=zzzz; x = IP address or hostname y = database listen port z = database name Database/Instance/Content Repository/Database User Name The name used to establish a connection to the database. By default, this is admuser for Oracle and sa for SQL. Database/Instance/Content Repository/Database Password The password used to establish a connection to the database. By default, this is admuser for Oracle and sa for SQL. Database/Instance/Content Repository/Repository Home Location where content repository files will be stored. Specify a location, or type a name and a folder will be created for you in the Bootstrap home directory. Database/Instance/Content Repository/Admin User Name Application admin user name for the content repository.
Default
Valid Ranges/Values
Database/Instance/Content Repository/Admin Password Application admin password for the content repository. Database/Instance/Content Repository/Enable Connection Pooling Provides a pool of shared database connections to the content repository. Utilizes the c3po connection pool. Database/Instance/Content Repository/Maximum Connections The maximum number of connections that the repository connection pool will have to the database. true
true/false
25
2-5000
31

Database/Instance/Workflow Repository/URL Database URL used to establish a connection to the database. Oracle example: jdbc:oracle:thin:@xx.xxx.xxx.xx:yyyy:zzzz SQL example: jdbc:sqlserver://xxxx:yyyy;database=zzzz; x = IP address or hostname y = database listen port z = database name Database/Instance/Workflow Repository/User Name The name used to establish a connection to the database. By default, this is admuser for Oracle and sa for SQL. Database/Instance/Workflow Repository/Password The password used to establish a connection to the database. By default, this is admuser for Oracle and sa for SQL. Database/Instance/Workflow Repository/Enable Connection Pooling Provides a pool of shared database connections to the workflow system. Utilizes the c3po connection pool. Database/Instance/Workflow Repository/Maximum Connections The maximum number of connections that the workflow repository connection pool will have to the database. true
Default
Valid Ranges/Values
true/false
25
1-5000
Database/Instance/Workflow Repository/Timeout 1m The number of seconds a connection can remain pooled, but unused, before being discarded. If a value of zero is entered, idle connections will never expire. Database/Instance/Workflow Repository/Connection Test Period The time, in seconds, in which all idle connections will be tested. If a value of zero is entered, no connections will be tested. 5m
5s-1h
5s-1d
32

Database/Instance/Session Settings/Setting 1-5 Alter session commands used to establish cursor sharing, rule-based mode, SQL trace, and more. Invalid settings in these fields are ignored. Database/Instance/Cost Based Optimization Settings/ Enable Enable Cost Based Optimization if true. Database/Instance/Cost Based Optimization Settings/ Dump Matching SQL Set to true to dump the SQL where a match is found in the QUERYLIB table for a given SQL statement. Set to false to dump the SQL where a match is not found in the QUERYLIB table for a given SQL statement.
Default
Valid Ranges/Values
alter session set _ = _
false
true/false
false
true/false
[Thread Pool Settings] Setting Name and Description

Thread Pool/Number of Threads The number of server threads. Thread Pool/Maximum Task Duration The maximum duration a thread can be used for one task. Thread Pool/Maximum Long Running Task Duration The maximum duration a thread can be used for a long running task. Thread Pool/Maintenance Frequency The frequency at which threads are checked for excess time durations.
Default
25 3m 5m
Valid Ranges/Values
2-300 10s - 24d 10s - 24d
45s
15s - 24d
33
[Log Settings] Setting Name and Description

Log/Console Logger/Severity Level Log severity level for the Console Logger. The ranges are inclusive. For example, choose debug to log all messages; choose warning to log both warning and error level messages. Log/Console Logger/Enabled Enable the Console Logger Log/File Logger/Archive Size The minimum size (in Kb) a log file must be before it is archived. Log/File Logger/Severity Level Log severity level for the HTML Logger. The ranges are inclusive. For example, choose debug to log all messages; choose warning to log both warning and error level messages. Log/File Logger/Number of Archive Files 6 Maximum number of log files to be used. The default files are named WebAccessLog0.html through WebAccessLog5.html. Log/File Logger/HTML Log as HTML. true 2 - 2073600000 false 1024 true/false 1024 - 2073600000
Default
error
Valid Ranges/Values
debug, info, warning, error
error
debug, info, warning, error
true/false
34
[Log Settings] Setting Name and Description

Log/File Logger/Enabled Enable the HTML Logger. Log files are created in a folder named WebAccessLogs, located as follows: JBoss on Windows: <webaccesshome>\WebAccessLogs JBoss on Red Hat Enterprise Linux: /mount_point/<webaccesshome>/AppServer/ WebAccessLogs WebLogic on Windows: <webaccesshome>\WebAccessLogs WebLogic on Solaris: /mount_point/<webaccesshome>/WebAccessLogs WebSphere on Windows: <webaccesshome>\WebAccessLogs WebSphere on Red Hat Enterprise Linux: /mount_point/WebSphere/AppServer/WebAccessLogs Log/Email Logger/SMTP Host SMTP server that will send the email message. Log/Email Logger/From Email Address Set to the email address from which you would like log messages sent.
Default
true
Valid Ranges/Values
true/false
Log/Email Logger/To Email Address Set to the email address to which you would like log messages sent. Log/Email Logger/Email subject The default Email subject. Log/Email Logger/Enabled Enable the Email logger. Log/Asynchronous Log messages asynchronously for better performance. P6 Web Access error false true
true/false true/false
35
[Application Settings] Setting Name and Description

Application/Prototype User Prototype user login used to create and store default Dashboards and Global Preference settings for new P6 Web Access users. Application/Ignore Daylight Savings Time Set to false to account for daylight savings time. Application/Timesheet URL URL for invoking timesheet program Application/Timesheet Codebase URL for the timesheet application Web site Application/Internet Explorer Java Plugin URL URL for Internet Explorer users to download Java Plug-in (JRE). Application/FireFox Java Plugin URL URL for Firefox users to download Java Plug-in (JRE). Application/Internet Explorer Java Plugin Version JRE version used by applets in Internet Explorer Application/FireFox Java Plugin Version JRE version used by applets in Firefox
Default
Valid Ranges/Values
true
true/false
/action/ launchTimesheetSeemles sly server/GroupServer Defaults to the plug-in version 1.6.0_07 that is installed during setup. Defaults to the plug-in version 1.6.0_07 that is installed during setup.
100 - 2000
Application/Maximum Transactions for Excel Import 2000 The maximum number of transactions (activities or resources) that can be imported at once from a .xls or .csv file Application/Maximum Excel Import File Size The maximum size of the .xls or .csv file uploaded during an import attempt (KB) 1048
64 - 4096
Application/Allow Auto-Summarize Option true Set to true to allow automatic summarization to be available in resource staffing user preferences. Application/Database Dropdown Key Keyword to use for enabling database selection control in the login page. Pass this as a URL parameter db=keyword. Set this to an empty string if you do not want to require the keyword.
true/false
36
[Application Settings] Setting Name and Description Default Valid Ranges/Values
Application/Logout URL Directs P6 Web Access to a specific URL when the user exits with the Logout/Close icon in the banner of P6 Web Access. Any valid URL can be used. If no URL is specified, P6 Web Access directs the user to the launch page of P6 Web Access. Application/Compress Applet Communication Set to true to compress communication between applets and the server. true
true/false
Application/Compress HTML Content true Set to true to compress HTML-related content generated by P6 Web Access, including .html, .js, and css files, and Ajax content. Application/Maximum Projects in Portfolio The maximum number of projects returned when creating a portfolio with a filter. Application/Maximum Loaded Resource Planning Projects The maximum number of projects that can be open in the Resource Planning spreadsheet. Application/Maximum Portlets per Dashboard The maximum number of portlets that can be displayed in a dashboard on the Dashboards Home page. Application/Maximum Projects per Portfolio View The maximum number of projects that can be displayed in a portfolio view on the Portfolio Analysis tab and in Portfolio View portlets on dashboards. 1000
true/false
1 - 100000
100
1 - 1000
12
1 - 50
5000
1 - 20000
Application/Maximum Activities per Activity View 2000 The maximum number of activities that can be displayed in the Activities tab of the Projects section. If greater than 5000, the Maximum memory allocated to Java Applets setting (below) must be 128 or greater. If a supported JRE prior to version 1.6.0_10 is being used, the maximum number of activities displayed will be 5000. Also, Primavera recommends that the maximum value be set to 5000 (or lower) if users need to display Earned Value or Baselinerelated information. Otherwise, database timeouts may occur.
1 - 15000
37

64-1024
Application/Maximum memory allocated to Java Applets 64 The maximum amount of memory, in megabytes, that can be used by Java Applets. If the Maximum Activities per Activity View setting (above) is greater than 5000, the memory allocation must be set to 128 or greater. This setting is only valid when using JRE version 1.6.0_10 (or later). Application/Maximum MRU List Items The maximum number of items that can be displayed in a Most Recently Used (MRU) list. Application/Maximum Project Activity Codes The maximum number of projects that can be selected and displayed in the Projects tab of the Activity Codes section. Application/Maximum Activity Code Values The maximum number of activity code values that can be created or selected per Activity Code. 5
1 - 10
350
1-350
100000
1-1m
Application/Custom Portlet URL Encryption Key Encryption key for custom portlet user password. Assigning a key causes the password that is passed as part of the URL for a custom portlet to be encrypted. If you do not assign a value, the password is not encrypted. The value can be any alphanumeric character or string of characters. This encryption uses the Sun/Blowfish algorithm. Application/Transaction Monitor Execution Interval The frequency at which the transaction monitor job runs, which ensures transactions have not bee orphaned. 10m
1s - 24d20h31m23s647
Application/Enable Cross Site Scripting Filter false Enable or disable the cross site scripting filter. It is not necessary to restart the server after changing the value of this setting. Application/Notifications/Enable Issue Notifications Enable or disable automated notifications when Issues are added or modified. false
true/false
true/false
Application/Notifications/Enable Invitation Notifications false Enable or disable automated notifications when Invitations are added.
true/false
38

true/false
Application/Notifications/Enable Initiation Notifications false Enable or disable automated notifications when Invitations are pending. Application/Notifications/Override Notification Email false from User Set to true to always use the systems From email address. Set to false to use the email address of the user who causes notifications to be sent, if their email address is configured. Application/Notifications/Notification from Email User The email address from which Notifications will be sent when either NotificationsFromEmailOverride is true or the users email address is not configured
true/false
[Services Settings] Setting Name and Description Default Valid Ranges/Values

10s - 10m
Services/License Service/Recalculate Rate 5m The rate at which the database is checked for changes in total license counts. Services/License Service/Update Rate The rate at which a Business Rule Engine synchronizes with the database for license counts. Services/License Service/Expiration Check Rate The rate at which licenses are checked to see if they should expire. Services/Timestamp Service/Refresh Rate The rate at which the database is queried to determine if a table change notification is necessary. 30s
100 - 1m
2m
500 - 15m
1m
15s - 1h
Services/Registry Service/Refresh Rate 1m30s The rate at which the database is updated with the status of the Business Rule Engine. Services/Registry Service/Stale Period The duration of inactivity that indicates an inoperable Business Rule Engine. 4m
15s - 1h
1m - 10m
39
[Services Settings] Setting Name and Description

Services/Registry Service/Port The TCP/IP port on which requests to revive dead Business Rule Engines will be received. Services/Next Key Service/Refresh Rate The rate at which nextkey cache is refreshed. Services/Next Key Service/Maximum Cached Keys Maximum nextkeys to cache per table Services/Performance/Use Enterprise Summary Use enterprise level summary data for resources and roles. This setting specifies whether you want to use EPS level records or Project level records to draw Resource Manager histograms. If true, performance is better because only one record (EPS record) is used for the histogram. If false, a much larger number of records (Project records) is used to draw the histogram chart, so performance is slower. However, it is important to note that histogram data is more accurate when the setting is false, using Project records. Services/Performance/Maximum Summary Node Count 1000 The threshold for displaying summarized data in views such as Resource Usage and Resource Analysis. If the number of child elements contained in a node exceeds this number, no data is displayed. Services/Web Scheduler/Enabled true If true, scheduling for jobs from P6 Web Access is performed using the Web Scheduler. If false, scheduling is performed using the Job Service Scheduler. Services/Web Scheduler/Scheduling Interval Amount of time the Web Scheduler will wait before scheduling the next available job. Services/Web Scheduler/Concurrent Schedulers The number of processes (active schedulers) used for scheduling on this server. A value of 0 (zero) indicates that scheduling will not be performed on this server. Services/Web Scheduler/Active Scheduler Mode If true, jobs are processed continuously until all jobs are scheduled. If false, each job is processed according to the Scheduling Interval. 5m 1-50000
Default
9192
Valid Ranges/Values
1024 - 65535
1m 10 false
15s - 1h 1 - 100 true/false
true/false
1s - 24d20h31m23s647
0-20
true
true/false
40
[Services Settings] Setting Name and Description Default Valid Ranges/Values

1h - 24d20h31m23s647
Services/Web Scheduler/ASAP Cleanup Rate 1d Amount of time at which completed WebASAP scheduler jobs are removed from the database. Services/Store Period Performance/Enabled Service for storing period performance. If true, ThisPeriod values are stored in the specified financial period. true
true/false
Services/Store Period Performance/Execution Interval 5m Amount of time the service will wait before checking for any period performance jobs. Services/Store Period Performance/Concurrent Tasks The number of processes used for the PeriodPerformance service on this server. A value of 0 (zero) indicates that the service is not available on this server. Services/Sync Actual This Period/Enabled Service for synchronizing actuals and ActualThisPeriod values. If true, recalculates actual units and costs for ThisPeriod. 2
1s - 24d20h31m23s647
0 - 20
true
true/false
Services/Sync Actual This Period/Execution Interval 5m Amount of time the service will wait before checking for any SyncActualThisPeriod jobs. Services/Sync Actual This Period/Concurrent Tasks The number of processes used for the SyncActualThisPeriod service on this server. A value of 0 (zero) indicates that the service is not available on this server. 2
1s - 24d20h31m23s647
0 - 20
41

Services/Project Hierarchy Cache/Cache Policy The cache policy to use. The cache policy determines how much data is in the cache and which data is removed to reclaim memory. The allowable values are: FIFO (First In First Out-projects are cleared from the cache in the same order they were added to memory) LRU (Least Recently Used projects are cleared from the cache before more recently used ones) JVMM (Java Virtual Machine Managed-uses soft references to cached elements; memory used by soft references is reclaimed by the JVM as required) PRR (Projects are selected at random to be cleared from cache) PRFIFO (Periodic Refresh First In First Out-same as FIFO, except policy is enforced based on MaintenanceFrequency) PRLRU (Periodic Refresh Least Recently Used-same as LRU, except policy is enforced based on MaintenanceFrequency) PRCC (Periodic Refresh Clear Cache-ignores CacheLimit to flush the entire cache, based on MaitenanceFrequency) Services/Project Hierarchy Cache/Cache Limit The maximum number of projects stored in memory. 5000 1000 - 30000 1m - 24d
Default
PRR
Valid Ranges/Values
FIFO, LRU, JVMM, PRR, PRFIFO, PRLRU, PRCC
Services/Project Hierarchy Cache/Maintenance Frequency 5h The frequency for applying the specified cache policy. Application of the cache policy might result in memory used by the cache to be reclaimed. Services/Collaboration Synchronization Service/ 1h Synchronization Interval The interval at which the collaboration synchronization service will run. The synchronization service deletes documents and workflows for projects that have been deleted. Services/Asynchronous Jobs/Purge Interval The frequency at which long running job records will be removed from the database. 1h
1m - 24d20h31m23s647
0 - 24d20h31m23s647
Services/Asynchronous Jobs/Grace Time 1d The minimum age of long running job records removed during purge.
0 - 24d20h31m23s647
42

Services/Mail Service/Email Notification Server Hostname or IP address of the email notification server for Timesheet Approval. Services/Mail Service/SMTP Port The tcp/ip port of the outgoing SMTP server. Services/Mail Service/Send Interval The frequency at which queued mail messages are sent. Services/Mail Service/Maximum Queue Length The maximum size of the mail message queue Services/Mail Service/Authorized User Name The name of the account to use to send mail from this mail server.
Default
Valid Ranges/Values
25 1m 250
1 - 65535 0 - 24d20h31m23s647 0 - 2147483647
Services/Mail Service/Authorized User Password The password of the account used to send mail from this mail server.
[Performance Monitor Settings] Setting Name and Description

Performance Monitor/Enabled Performance monitor packets are sent when true. Performance Monitor/Monitor Host The destination IP or machine name for the performance monitor packets Performance Monitor/Monitor Port The destination port for the performance monitor packets Performance Monitor/Update Interval The rate at which the performance monitor packets are sent.
Default
false localhost
Valid Ranges/Values
true/false
6990 1s
1024 - 65535 250 - 1m
43
[Tracer Settings] Setting Name and Description

Tracer/Enabled If true, debugging messages are sent to Tracer application. Tracer/Server Name Hostname or IP address of destination for sending tracer information. Tracer/Port Port to use for Tracer socket connection Tracer/Use Background Send Thread If true, use background thread for sending TCP messages to tracer.
Default
false localhost
Valid Ranges/Values
true/false
9210 true
1024-65535 true/false
[Integration API Server Settings] Setting Name and Description

Integration API server/RMI/Registry Port The port for the RMI Registry. This value is usually set to at least 1024. Integration API server/RMI/Enable The setting that enables the RMI server. Integration API server/RMI/Enable Compression The setting that enables compression service mode. Integration API server/RMI/Enable SSL The setting that enables SSL service mode. Integration API server/RMI/Enable Standard Service The setting that enables Standard service mode. Integration API server/RMI/Enable HTTP Service The setting that enables HTTP tunneling mode. Integration API server/RMI/Enable HTTPS Service The setting that enables secure HTTP (SSL) tunneling mode.
Default
9099
Valid Ranges/Values
1024 - 65535
true true true true false false
true/false true/false true/false true/false true/false true/false
44
[Integration API Server Settings] Setting Name and Description Default Valid Ranges/Values
0 - 65535
Integration API server/RMI/Compression Service Port 0 The port to use for Compression service mode. A setting of 0 indicates that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port. Integration API Server/RMI/SSL Service Port 0 The port to use for SSL service mode. A setting of 0 indicates that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port. Integration API Server/RMI/Standard Service Port 0 The port to use for Standard service mode. A setting of 0 indicates that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port. Integration API Server/RMI/HTTP Service Port The port to use for HTTP tunneling mode. A setting of 0 indicates that any available port will be used. 0
0 - 65535
0 - 65535
0 - 65535
Integration API Server/RMI/HTTPS Service Port 0 The port to use for secure HTTP tunneling mode. A setting of 0 indicates that any available port will be used. Integration API Server/Session Timeout 120 The amount of time after which an idle client connection will be terminated.
0 - 65535
1 - 24d
45
Configuring Authentication Modes

In this chapter:
Authentication Modes Implementing Non-Native Authentication Choosing an Authentication Scheme Running the Authentication Configuration Wizard Configuring Integration API Authentication Logon/Logout Changes to Support Authentication Modes
This chapter describes the authentication modes available and explains how to configure the Primavera Integration API to operate using a non-native authentication scheme.
46
Authentication Modes
The Primavera Integration API provides support for the following authentication modes to validate user logons:
Native Native mode is the original Primavera authentication scheme and is the default for all applications. When a user attempts to log on to a Primavera application, native mode confirms the users identity in the project manager or methodology manager database. LDAP (Lightweight Directory Access Protocol) LDAP mode is available for the Primavera Project Management client module, P6 Web Access, and the API. In this mode, when a user attempts to log on to a Primavera application, the users identity is confirmed in a directory server database.
47
Implementing Non-Native Authentication

By default, all Primavera applications are installed using native authentication. Native authentication is handled directly through the Primavera application with the Primavera database acting as the authority. To implement non-native authentication for Primavera applications
uninstall current versions of Primavera applications, if you are upgrading install the new version of Primavera client applications and additional components required for your implementation run the Authentication Configuration wizard to choose an authentication scheme for the project manager database (PMDB) and, if applicable, methodology manager database (MMDB) configure administrative settings for the Integration API
The Borland Database Engine and the database client software must be installed on the machine used to run the LDAP Configuration Utility.
This guide describes the procedures for choosing an authentication scheme and configuring new administrative settings for the Integration API. For detailed procedures on installing and uninstalling Primavera client applications and server components and upgrading the methodology manager database, refer to the Primavera P6 Administrators Guide.
48
Choosing an Authentication Scheme

To specify the authentication scheme you want to use for Primavera applications, you use the Primavera Authentication Configuration wizard. Although you specify authentication modes for client/server applications and Web applications separately, you must use a consistent authentication scheme within the Primavera suite. For example, client/ server and Web applications must both be configured for either LDAP authentication or native authentication. For Custom mode, which is available only for client/server applications, you can choose LDAP for Web applications. Authentication mode is database-driven, so the configuration utility enables you to first specify a database connection setting, then choose authentication modes for the applications that access that database. For LDAP authentication, the configuration utility also enables you to specify LDAP servers, map LDAP attributes to Primavera database fields, and provision users.
49
Running the Authentication Configuration Wizard

Use the Authentication Configuration wizard to

Select an authentication mode and configure LDAP servers Provision LDAP user information to a Primavera database
To select an authentication mode and configure LDAP servers 1 From the \Client_Applications\Install\Database\ldap_config folder of the P6 physical media or download, double-click LDAPCfgWiz.exe. 2 Select the database alias you want to configure for authentication, then type the database username and password.
50
3 Choose to configure an authentication mode.
The Import option is active only if the database has previously been configured for LDAP mode.
51
4 Choose an authentication mode for the client-server and Web applications. If you choose Native, the Finish button becomes active so you can exit the wizard. For other modes, continue through the wizard to configure additional information as described in the following steps.
5 To add a new LDAP server, click New. If previously configured LDAP servers are listed, you can modify the information or remove server entries.
52
6 On the General tab, specify the LDAP directory server host name or IP address, listening port, and Base Directory Node. For Base Directory Node, specify the location in the directory information tree (DIT) that is the location from which to start the search for module users during login. Base Directory Node is also the location where the provisioning function begins the search for directory server users. To use SSL protocol for communication with the LDAP server, mark the Enable SSL checkbox. To use referrals, mark the Chase Referrals checkbox.
53
If the LDAP server does not allow anonymous searches, click the Login tab. Type the user name and password of an LDAP server user who has search access for the Base Directory Node you specified on the General tab.
When you are finished configuring the LDAP server, click OK or, to validate connection with the LDAP server, click Test and click OK after a successful connection message.
54
USER_NAME is a required field that must be mapped and can not be deleted. Up to four fields can be mapped between the LDAP store and the project management/methodology management database.
7 Select an LDAP server. Then, in the LDAP attribute column, specify the term/field in the LDAP store that corresponds to the Primavera project management/methodology management database USER_NAME field. Optionally, specify the LDAP term/field for e-mail address, actual name, and office phone number. To add fields, click Add. To remove a field, select it and click Remove.
If you are unsure of the correct LDAP terms, check with your LDAP directory server administrator.
8 To provision LDAP user information to the Primavera database, click Next. You can search the LDAP directory server or import an LDIF file to provision users. To exit the wizard, click Finish. 9 Click Search and Import Users.
55
When you provision users from the LDAP directory, changed records are updated in the Primavera database and new users are added. However, users that have been deleted from the LDAP directory are not automatically removed from the Primavera database. You will need to manually delete these users.
10 To import from an LDIF file, click Load LDIF, then navigate to the file you want to import and click OK. To import from an LDAP server, you can run an existing search or define a new search. If one or more previously defined searches exist, the name of the most recently run search is displayed next to the Search Name dropdown list. To initiate the current search, click Run Search. Results display in the Available Users section. To specify a new search, click Define Criteria.
56
Displays the name of the current search.
Starts the search based on the filter selected in the Search Name drop-down list.
To set the number of search results listed at one time, type a number or click the arrow buttons. To advance through the list, click Go.
Click to save information for the selected users to the Primavera database.
Click to remove the current search results or currently selected users.
After running a search, select the Available users you want to add to the Primavera database, then click the right arrow button. To remove a user from the Selected users list, click the left arrow button. Click the double arrows to add or remove all listed users.
For the selected users, click to compare records between the Primavera db and LDAP store. Status is indicated by background color. White indicates a match, blue indicates that the db record differs from the record in the LDAP store, and red indicates that the user record does not exist in the database.
When you click Define Criteria, the Select/Define Searches dialog box displays so you can add, modify, and delete searches. To add a search, click Add. Type a unique name for the search. In the Search criteria field, specify the LDAP search filter you want to use. When finished specifying criteria, click Save and Close.
57
Search filter syntax should adhere to the rules outlined in RFC 2254.
To modify a search name or criteria, edit the existing information, then click Save and Close. To delete a search, select it. Click Remove, then Close.
After provisioning users, you will need to set up Primavera user accounts for the imported users by assigning security profiles and licenses through the Primavera Project Management Module.
11 When finished importing user information, in the Import LDAP Users dialog box, click Close. To exit the Authentication Configuration wizard, click Finish.
58
Provisioning LDAP user information to the Primavera database

When you provision users, changed records are updated in the Primavera database and new users are added. However, users that have been deleted from the LDAP directory or LDIF file are not automatically removed from the Primavera database. You will need to manually delete these users.
1 From the \Client_Applications\Install\Database\ldap_config folder of the P6 physical media or download, double-click on the file LDAPCfgWiz.exe. 2 Select the database alias you want to provision LDAP information for, then type the database user name and password.
3 Choose to import user information.
59
The Import option is active only if the database has previously been configured for either LDAP.
4 Follow steps 9 - 11 (beginning on page 54), which describe how to provision users.
60
Configuring Integration API Authentication

Because one Integration API server instance may control more than one database, in addition to specifying an authentication mode for a database through the Authentication Configuration wizard, you use an administrative configuration setting to specify the overall mode you want to use for the Integration API server. The Primavera Integration API uses a single Primavera configuration setting, Authentication.Mode, to support authentication selection. For LDAP authentication with secure communication (SSL) between the Integration API server and the LDAP server, two additional configuration settings are required. Use the Primavera Administration Application to specify these configuration settings. For more information about the Administrator Application and these configuration settings, see Using the Primavera Administrator Application on page 15.
An Integration API configuration might include database instances that are not set to the same authentication mode as the Integration API server. If a user connects and requests a database that is set to a different authentication mode than the Integration API server, an error message displays. The user must select a database that matches the authentication mode set for the Integration API server.
61
Logon/Logout Changes to Support Authentication Modes

In Native mode
Primavera modules present a login dialog that prompts for a user name and password. In Native mode, the use of passwords may be optional, depending on the password policy chosen in Administrative Preferences in the Project Management module.
In LDAP mode
All Primavera applications require a logon password. Additionally, because passwords are stored and authenticated against an LDAP directory, changing a users password within a Primavera application has no effect (i.e., the password is ignored).
In Custom mode
Client/server applications require a logon password. Custom mode is not supported by the Primavera Integration API.
63
Index
A
administrator application 15 adding Integration API configurations 18 reviewing and modifying configurations 17 application servers supported 3 authentication login/logout changes 61 custom mode 61 LDAP mode 61 native mode 61 Authentication modes select using LDAP Configuration utility 49 authentication modes 46 configuring 45 authentication scheme choosing 48 deploying 7 installing 1, 46 overview 2 Integration API configurations add database instances 18 adding 18 database driver configurations 19 deleting 19 duplicate 18
J
Java JDK 3 Java Runtime Environment 3 Java security manager 14
L
LDAP 49 provisioning 58 LDAP authentication configure servers 49 provision user information 54, 58 running LDAP utility 49
C
configuration settings 21 Customer support vii
D
database managing access to multiple instances 19 Database Configuration wizard starting 12 database requirements 3
N
non-native authentication 47
O
operating systems supported 3
F
Factory Default configuration 17
P
Project Manager database 3 Provision LDAP user information 54, 58
I
installation 1 Integration API authentication 20, 60
64
Index
R
Running Authentication Configuration Wizard 49
S
system requirements 3
T
Technical support vii

API Setup

Diunggah oleh

Informasi Dokumen

Deskripsi Asli:

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

API Setup

Diunggah oleh

Hak Cipta:

Format Tersedia

Primavera P6 Integration API

Installing the Integration API.............................................................1

Configuring Authentication Modes ..................................................45

Primavera Integration API

Using this Administrators Guide

Primavera Integration API

Where to Get Support

Time Zone Hours

Bala Cynwyd, ET Pennsylvania, USA London, England, UK GMT

All Primavera products are backed by comprehensive support and training.

Installing the Integration API

Primavera P6 Integration API

What is the Integration API?

Primavera P6 Integration API

Installing the Integration API

Project Management Database

Primavera P6 Integration API

Integration API Installation Process

Installing the Integration API

Primavera P6 Integration API

Primavera P6 Integration API

Installing the Integration API

Deploying the Integration API for Remote Mode

5 For international support, edit the following file:

Primavera P6 Integration API

Primavera P6 Integration API

Installing the Integration API

Deploying into Weblogic 10

Primavera P6 Integration API

Primavera P6 Integration API

Installing the Integration API

Primavera P6 Integration API

Changing Database Configuration Settings

Starting the Database Configuration wizard

Primavera P6 Integration API

Installing the Integration API

Primavera P6 Integration API

Java Security Manager

Primavera P6 Integration API

Installing the Integration API

Using the Primavera Administrator Application

Primavera P6 Integration API

Starting the Primavera Administrator Application

Primavera P6 Integration API

Installing the Integration API

Reviewing and Modifying Integration API Configurations

Primavera P6 Integration API

Click to display configuration settings in a table format.

Primavera P6 Integration API

Installing the Integration API

Primavera P6 Integration API

Primavera P6 Integration API

Installing the Integration API

Integration API Configuration Settings

Localization settings are not applicable for the Integration API.

You can specify durations (time-related values) in several ways:

[Localization Settings] Setting Name and Description

Primavera P6 Integration API

[Authentication Settings] Setting Name and Description

http:// servername.domain.co m:82

Primavera P6 Integration API

Installing the Integration API