Web Services
Administrator’s Guide
Version 7.0
Copyright © 2008, 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, redun-
dancy 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.
Table of Contents
Preface.................................................................................................. 5
Using this Administrator’s Guide ......................................................................... 6
Media Packs .......................................................................................................... 7
Where to Get Support ........................................................................................... 9
Installing and Configuring P6 Web Services.................................. 11
What is P6 Web Services? .................................................................................. 12
System Requirements.......................................................................................... 13
Installing P6 Web Services ................................................................................. 15
Enabling WS-Policy............................................................................................ 20
Using UsernameToken Profile with .NET.......................................................... 22
Deploying P6 Web Services ............................................................................... 23
Changing Database Configuration Settings ........................................................ 29
Enabling Access to P6 Web Services ................................................................. 30
Using the Primavera Administrator Application ................................................ 31
Starting the Primavera Administrator Application ............................................. 32
Reviewing and Modifying P6 Web Services Configurations ............................. 33
Setting up Event Notification.............................................................................. 37
P6 Web Services Configuration Settings ............................................................ 38
Configuring Authentication Modes................................................. 69
Authentication Modes ......................................................................................... 70
Implementing Non-Native Authentication ......................................................... 71
Choosing an Authentication Scheme .................................................................. 72
Running the Authentication Configuration Wizard ............................................ 73
Configuring P6 Web Services Authentication .................................................... 84
Login/Logout Changes to Support Authentication Modes ................................. 85
Index................................................................................................... 87
5
Preface
P6 Web Services enables organizations to
In this preface: integrate P6 functionality into other web-
based applications using the following web
Using this Administrator’s Guide
services standards: XML (Extensible
Media Packs
Markup Language), SOAP (Simple Object
Where to Get Support
Access Protocol), and WSDL (Web Services
Description Language).
6 Preface
Media Packs
Media packs include all files necessary to install Primavera P6 client
applications, all manuals and technical documents related to the
installation, administration, and use of Primavera P6 components, and
the Quick Install Guide.
http://www.oracle.com/primavera/support.html
This page provides the latest information for contacting Oracle Global
Customer Support and the support renewals process.
System Requirements
P6 Web Services has the following system requirements for installation:
.NET Requirements
■ To use the .NET client code, you must have Microsoft .NET
Framework version 3.0 or later.
Application Servers
P6 Web Services requires one of the following supported application
servers:
■ JBoss 5.0.1
■ Oracle WebLogic 10g R3
■ IBM WebSphere 7.0
Before you start the installation, make sure you set the
JAVA_HOME and CXF_HOME environment variables. For
information on setting the CXF_HOME environment variable,
refer to “Apache CXF Requirements” on page 13.
cd <Operating System>\Disk1\install
6 Click Next.
For the full list of tested 7 On the Information dialog box, review the text and click Next.
configurations for P6 Web
Services, go to the 8 On the Java Home Directory dialog box, type or browse to the
\Documentation\ location where Java is installed. the setup wizard automatically
<language>\Tested detects the JDK/JRE on your local machine. To specify a different
Configurations folder of the location, enter the path, or click Browse to select it.
P6 physical media or
9 On the Choose Apache CXF Home Directory, the setup
download.
automatically detects the location of your Apache CXF installation,
if you specified the CXF_HOME environment variable. If you did
not specify this environment variable, type the location of Apache
CXF 2.2.2 on your local machine, or click Browse to select it.
10 On the Authentication and Session Management dialog box,
select one of the following:
• Use UsernameToken Profile for authentication
• Use UsernameToken Profile with nonce for additional security
• Use HTTP cookies for session management
You can later change the 12 On the Setup and Configuration of the Primavera Database
database type through the dialog box, select the database type (Oracle or SQL).
P6 Web Services
Database Configuration
Setup.
Enabling WS-Policy
P6 Web Services uses an external attachment file to support WS-Policy.
Since the reference to the external file is commented out in the default
P6 Web Services installation, WS-Policy for P6 Web Services is
disabled by default. However, you can enable WS-Policy by
uncommenting the reference to the external file before deploying P6
Web Services to the server.
3 Remove the lines beginning with <!-- and --> to uncomment the
external file reference.
Update the p6ws.war file with the new cxf.xml file and
policies.xml files
1 Make sure that you are in the same directory as the p6ws.war file.
2 Use the following commands to update the p6ws.war file:
jar uf p6ws.war WEB-INF/classes/cxf.xml
jar uf p6ws.war WEB-INF/classes/policies.xml
1 copy the p6ws.war file from the \<P6 Web Services home>\server
folder to the following JBoss folder:
<JBOSS INSTALL LOCATION>\server\default\deploy\
2 In order for incoming client connections to remotely access the
JBoss service, the JBoss services must be configured to bind to a
network interface (i.e. the IP address of the network card for the
server on which JBoss is installed). Determine to which interface(s)
JBoss services should bind in order to enable remote access to the
JBoss Application server. For security purposes, the default
installation of JBoss currently binds its services to the local host
(127.0.0.1) interface, which does not allow remote connections to
the JBoss services. Refer to the JBoss Application Server
Installation And Getting Started Guide, available at www.jobss.org,
for information on enabling and securing remote access to the
appropriate interface(s).
3 As appropriate for your specific deployment, include the -b option
in the run command to bind the JBoss services to the interface(s)
determined in the previous step. For example:
call %JBOSS_HOME%\bin\run.bat -b ###.###.###.###
On Linux:
JAVA_OPTIONS="${ SAVE_JAVA_OPTIONS} -
Djavax.xml.soap.MessageFactory=com.sun.xml.messaging.saaj.soap.ver
1_1.SOAPMessageFactory1_1Impl -
Djavax.xml.soap.SOAPConnectionFactory=weblogic.wsee.saaj.SOAPCon
nectionFactoryImpl"
10 In the Step 3 section Map Virtual Host for Web Modules, mark
the cxf checkbox, and click Next.
11 In the Step 4 section Map context roots for Web module, for the
Context Root, type /p6ws then click Next.
12 In the Step 5 screen Summary, click Finish. Note that the
application war file is now deploying and this process may take
several minutes.
13 To save the master WebSphere configuration, click Save. This
process may also take several minutes.
14 On the Administrative Console Main screen, in the left-hand
navigation, expand Application Types under Applications and
click WebSphere enterprise applications.
15 Mark the checkbox next to p6ws_ war.
16 Click Start.
The database you connect to during the installation stores one or more
P6 Web Services configurations. Each configuration specifies a set of
configurable parameters that determine how P6 Web Services operates.
The first time you install P6 Web Services, 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 P6 Web Services configuration or create a new one.
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.
For more information, see Database driver configurations The following table lists the
Database.Instance.Driver
and
database drivers P6 Web Services supports for each application server/
Database.Instance.URL in database configuration. Use the Database.Instance.Driver
the “P6 Web Services
Configuration Settings” on
configuration setting to specify the database driver you are using.
page 38.
Application
Database Type Database Driver Default
Server
■ Authentication.Mode
Because one P6 Web Services 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 P6 Web Services server. For LDAP
authentication with secure communication (SSL) between the P6 Web
Services server and the LDAP server, two additional configuration
settings are required.
5 Restart the application server, and the change will immediately take
effect.
Before you begin: Add the JMS vendor jar files to the application
classpath. Refer to the Oracle Primavera Support Knowledgebase for
additional information and examples.
[Localization Settings]
Localization/System Language en —
Language for server string constants
Localization/System Country US —
Country for server string constants
[Authentication Settings]
[Database Settings]
Database/Instance/Name — up to 32 characters
The name of this database instance.
Database/Instance/Schema PMDB —
The schema that will be defined for the database.
Database/Instance/URL — —
The database URL used to establish a connection to the P6
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 1 —
The public group ID used to establish a connection to the
database.
Database/Instance/Password pubuser —
The password used to establish a connection to the database.
Database/Instance/Timesheet URL — —
URL for invoking the P6 Progress Reporter module.
To verify that the URL entered for this setting is valid, right-
click over the setting, then select ‘Test Connection.’
Example format:
http://<server name>:<listen port>/pr/
[Database Settings]
[Database Settings]
[Database Settings]
[Database Settings]
Database/Instance/Methodology Management/Name — —
Name of this database instance.
Database/Instance/Methodology Management/ — —
Description
Description of this database instance.
[Database Settings]
Database/Instance/Methodology Management/URL — —
Database URL used to establish a connection to the P6
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.
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 Settings]
Database/Instance/Methodology Management/ 2m 5s - 4h
Connection Pool [MMR]/Maximum Lease Duration
The maximum amount of time a database connection can be
leased before it is revoked.
[Database Settings]
Database/Instance/Content Repository/Apache — —
JackRabbit/URL
The URL used to establish a connection to the JackRabbit
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/Apache — —
JackRabbit/Database User Name
The name used to establish a connection to the JackRabbit
database. By default, this is admuser for Oracle and sa for
SQL Server.
Database/Instance/Content Repository/Apache — —
JackRabbit/Database Password
The password used to establish a connection to the
JackRabbit database. By default, this is admuser for Oracle
and sa for SQL Server.
Database/Instance/Content Repository/Apache — —
JackRabbit/Repository Home
Location where content repository files are stored on the
JackRabbit server. Specify a location, or type a name and a
folder will be created for you in the Bootstrap home
directory.
Database/Instance/Content Repository/Apache — —
JackRabbit/Admin User Name
Application name for the content repository.
Database/Instance/Content Repository/Apache — —
JackRabbit/Admin Password
Application superuser password for the content repository.
[Database Settings]
Database/Instance/Content Repository/Apache — —
JackRabbit/Autovue/VueServlet URL
The URL of the server hosting the AutoVue VueServlet.
Example:
\\Contribution Folders\Production\OraclePrimavera\
[Database Settings]
Example format:
http://<vuelinkpath>/csiApplet.jsp
Database/Instance/Content Repository/SharePoint/Login — —
Name
A SharePoint user name with administrative privileges, this
setting is required.
[Database Settings]
Database/Instance/Content Repository/SharePoint/ — —
Password
The password for the SharePoint login name.
Database/Instance/Content Repository/SharePoint/Host — —
Name
The machine name or IP address of the SharePoint server.
Database/Instance/Content Repository/SharePoint/ — —
Domain
The domain in which the SharePoint server resides.
Database/Instance/Content Repository/SharePoint/ — —
Document Library URL
The URL of the P6 document library on SharePoint. The
URL includes the machine name (or IP address) of the
content repository server and the path to the content
repository library.
Example format:
http://<host>/<library path>
Database/Instance/Content Repository/SharePoint/Web — —
Service URL
The URL of the Web Service used to connect P6 to
SharePoint. The URL includes the machine name (or IP
address) of the content repository server, port number of the
server, and web service name.
Example format:
http://<host>:<port>/<virtual_dir>
[Database Settings]
Database/Instance/Content Repository/SharePoint/ — —
External Document Library URL
The URL of an external document library. This is only
required if you need to connect to a non-P6 document
library.
Example format:
http://<host>:<port>/<virtual_dir>
Database/Instance/Content Repository/SharePoint/ — —
Autovue/VueLink URL
The URL of the of the server hosting AutoVue VueLink.
Example format:
http://<vuelinkpath>/vue.aspx
Database/Instance/Workflow Repository/URL — —
Database URL used to establish a connection to the
Workflow Repository 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/Password — —
The password used to establish a connection to the database.
By default, this is admuser for Oracle and sa for SQL.
[Database Settings]
Database/Instance/Eventing/Interval 5m 1s-10m
The length of time that the Event Notification System uses to
determine how often it sends events to the message queue.
Specifying a smaller time increases the frequency with
which the Event Notification System reports event
occurrences to the message queue.
[Database Settings]
Database/Instance/Eventing/Connection Factory — —
The JNDI name of the JMS Connection Factory.
Database/Instance/Eventing/Destination Name — —
The JNDI name of the queue or topic to which to publish
events.
Database/Instance/Eventing/Configuration — —
Options for which Business Object changes and Special
Operation processes trigger event notifications. Right-click
to select the node, then choose Configure to select the
desired options. For detailed information about these
options, refer to the P6 Web Services Reference Manual.
Note: The “Timesheet” business object only has update
notification functionality.
[Database Settings]
Database/Instance/AIA/URL — —
The URL of the Oracle database instance running AQ
functionality.
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/AIA/Username — —
The database user name of the AQ queue owner.
Database/Instance/AIA/Password — —
The password for the database user name of the AQ queue
owner.
Database/Instance/AIA/System Id P6-001 —
The system identification code that AIA will use to identify
P6.
Database/Instance/AIA/Target System Id — —
The external system identification code that AIA will use to
identify a supported Oracle ERP application.
Examples:
JDE-001 for JDEdwards
EBS-001 for E-Business Suite
[Log Settings]
[Log Settings]
JBoss on Windows:
<webaccesshome>\WebAccessLogs
JBoss on Red Hat Enterprise Linux:
/mount_point/<webaccesshome>/AppServer/
WebAccessLogs
WebLogic on Windows:
<webaccesshome>\WebAccessLogs
WebSphere on Windows:
<webaccesshome>\WebAccessLogs
WebSphere on Red Hat Enterprise Linux:
/mount_point/WebSphere/AppServer/WebAccessLogs
Directory Services/Lookup — —
The lookup used when testing the directory connection for
eventing.
[Application Settings]
Application/Prototype User — —
Prototype user login used to create and store default
Dashboards and Global Preference settings for new P6 Web
Access users.
[Application Settings]
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 Settings]
This setting is only valid when using JRE version 1.6.0_10 (or
later).
[Application Settings]
[Application Settings]
[Services Settings]
[Services Settings]
[Services Settings]
[Services Settings]
[Services Settings]
[Tracer Settings]
Authentication Modes
P6 Web Services supports the following authentication modes to
validate user logons:
■ Native
Native mode is the original P6 authentication scheme and is the
default for all applications. When a user attempts to log on to a P6
application, native mode confirms the user’s identity in the project
management or methodology management database.
■ LDAP (Lightweight Directory Access Protocol)
LDAP mode is available for the P6 Project Management client
module, P6 Web Access, the API, and P6 Web Services. In this
mode, when a user attempts to log on to a P6 application, the user’s
identity is confirmed in a directory server database.
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.
SSL protocol is recommended for secure communication to the
LDAP server. To use SSL protocol for communication with the
LDAP server, mark the Enable SSL checkbox.
Referrals chasing allows authentication to extend to another
domain.To use referrals, mark the Chase Referrals checkbox.
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.
USER_NAME is a required 7 Select an LDAP server. Then, in the LDAP attribute column,
field that must be mapped specify the term/field in the LDAP store that corresponds to the P6
and can not be deleted. Up project management/methodology management database
to four fields can be USER_NAME field.
mapped between the
LDAP store and the project Optionally, specify the LDAP term/field for e-mail address, actual
management/methodology name, and office phone number. To add fields, click Add. To
management database. remove a field, select it and click Remove.
If you are unsure of the correct LDAP terms, check with your
LDAP directory server administrator.
Click to
remove the
current
search
results or
currently
selected
users.
After running a search, select the Available For the selected users, click to compare
users you want to add to the P6 database, records between the P6 db and LDAP
then click the right arrow button. To remove a store. Status is indicated by background
user from the Selected users list, click the left color. White indicates a match, blue
arrow button. Click the double arrows to add or indicates that the db record differs from
remove all listed users. the record in the LDAP store, and red
indicates that the user record does not
exist in the database.
After provisioning users, 11 When finished importing user information, in the Import LDAP
you will need to set up P6 Users dialog box, click Close. To exit the Authentication
user accounts for the Configuration wizard, click Finish.
imported users by
assigning security profiles
and module access
through the P6 Project
Management Module.
In LDAP mode
■ All P6 applications require a logon password.
Additionally, because passwords are stored and authenticated
against an LDAP directory, the capability for users to change
passwords within a P6 module is disabled.
In Custom mode
■ Client/server applications require a logon password. Custom mode
is not supported by P6 Web Services.
Index
A starting wizard 29
Administrator application Database driver configurations 35
adding P6 Web Services configurations 34 Database instances
modify configurations 33 adding 34
starting 32 deleting 35
using 31 managing access to multiple 35
Application servers Database requirements 14
configuring HTTP(s) 20, 22, 23 Deploying P6 Web Services 20, 22, 23
deploying into 20, 22, 23 into JBoss on Windows 23
supported 14 into WebSphere 27
Authentication
configuration settings 84 F
Authentication modes Factory Default configuration 33
choosing 72
configuring 69
login/logout changes 85 H
overview 70 HTTP(s) 23
select using LDAP Configuration utility 73
I
B IBM WebSphere
BEA WebLogic deploying into 27
supported version 14 supported version 14
Installation 11
requirements 13
C
Configuration settings 38
Configurations 33 J
adding 34 Java JDK 13
adding database instances 34 Java Runtime Environment 13
deleting 35 JBoss
duplicating 34 deploying into 23
Configure authentication modes 69 supported version 14
Configure database settings 29
L
D LDAP
Database configuration provisioning 82
change settings 29 LDAP authentication
88 Index
configure servers 73
description 70
login procedure 85
provision user information 78, 82
running LDAP utility 73
N
Native authentication 70
login procedure 85
Non-native authentication, implementing 71
O
Operating systems, supported 14
P
P6 Web Services
authentication 36
authentication, configure settings 84
configuration settings 38
configurations, adding 34
configurations, adding database instances 34
configurations, deleting 35
configurations, duplicating 34
database driver configurations 35
deploying 20, 22, 23
enabling access to 30
installing 11, 15–19
modify configurations 33
overview 12
system requirements 13
Project Management database, supported version 14
Provision LDAP user information 78, 82
R
Running Authentication Configuration Wizard 73
S
SOAP (Simple Object Access Protocol) 12
Supported operating systems 14
System requirements 13
W
WSDL (Web Services Description Language) 12
X
XML (Extensible Markup Language) 12