CCoonnttrraacctt MMaannaaggeemmeenntt WWeebb SSeerrvviicceess AAddmmiinniissttrraattoorr''ss GGuuiiddee
1133..11
AAuugguusstt 22001133
2
Oracle Primavera Contract Management Web Services Administrator's Guide
Copyright © 2011, 2013, Oracle and/or its affiliates. All rights reserved.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names
may be trademarks of their respective owners.
This software and related documentation are provided under a license agreement
containing restrictions on use and disclosure and are protected by intellectual property
laws. Except as expressly permitted in your license agreement or allowed by law, you
may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,
exhibit, perform, publish or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not
warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or
anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system,
integrated software, any programs installed on the hardware, and/or documentation,
delivered to U.S. Government end users are “commercial computer software" pursuant
to the applicable Federal Acquisition Regulation and agency-specific supplemental
regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed
on the hardware, and/or documentation, shall be subject to license terms and license
restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information
management applications. It is not developed or intended for use in any inherently
dangerous applications, including applications that may create a risk of personal injury. If
you use this software or hardware in dangerous applications, then you shall be
responsible to take all appropriate failsafe, backup, redundancy, and other measures to
ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any
damages caused by use of this software or hardware in dangerous applications.
This software or hardware and documentation may provide access to or information on
content, products and services from third-parties. Oracle Corporation and its affiliates
are not responsible for and expressly disclaim all warranties of any kind with respect to
third-party content, products, and services. Oracle Corporation and its affiliates will not
be responsible for any loss, costs, or damages incurred due to your access to or use of
third-party content, products, or services.
Legal Notices
3
Contents
Legal Notices ........................................................................................................................ 2
Preface .................................................................................................................................. 5
Using this Administrator’s Guide ........................................................................................ 5
Contract Management (v13.1) Media Pack ........................................................................ 6
Contract Management Documentation for v13.1 ................................................................ 6
Contacting Customer Support ............................................................................................ 7
Prerequisites ........................................................................................................................ 9
Before you install Contract Management Web Services 13.1 ............................................. 9
Create a Domain for Contract Management Web Services ............................................. 10
Installing Contract Management Web Services ............................................................... 13
Prerequisites for Installing Contract Management Web Services 13.1 ............................. 13
Install Contract Management Web Services 13.1 ............................................................. 14
Configuring the WebLogic Application Server for Contract Management Web Services 13.1 .............................................................................................................. 15
Configure the WebLogic Application Server for Contract Management Web Services on Windows .............................................................................................. 15
Set the Application Server Memory Parameters on Windows .......................................... 16
Configuring the WebLogic Domain for Contract Management Web Services ............... 19
Configuring an Oracle Database Data Source ................................................................. 19
Configure JDBC Properties for an Oracle Database Data Source ............................... 19
Configuring the MicroSoft SQL Server Database Data Source ........................................ 21
Configure JDBC Properties for a Microsoft SQL Server Database Data Source .......... 21
Deploying Contract Management Web Services to a WebLogic Application Server ............................................................................................ 25
Deploying the WebLogic Domain for Contract Management Web Services ..................... 25
Deploy Contract Management Web Services .............................................................. 25 Create an Endorsed Folder ......................................................................................... 26
Configuring Contract Management for a WebLogic Cluster ........................................... 27
Clustering: Configuring the Environment in Windows ....................................................... 27
Clustering: Start the WebLogic Domains on Windows ..................................................... 28
Clustering: Configure the Data Sources ........................................................................... 29
Clustering: Configure JDBC Properties for an Oracle Database Data Source ............. 29 Clustering: Configure JDBC Properties for a Microsoft SQL Server Database Data Source ................................................................................................................ 31
Clustering: Deploy Contract Management Web Services ................................................. 33
Clustering: Considerations for Using Contract Management Web Services in a Clustered Environment .............................................................................................. 34
Contract Management Web Services Administrator's Guide
4
Deploying Contract Management Web Services to a JBoss Application Server ............... 35
Deploying Contract Management Web Services to a JBoss Application Server .......... 35
Configuring Contract Management Web Services ........................................................... 39
Starting the Contract Management Administration Application on Windows ..................... 39
Viewing and Modifying Contract Management Administration Application Settings .......... 39
Contract Management Web Services 13. 1 Settings ........................................................ 39
Using LDAP with Contract Management Web Services on Windows ............................... 44
5
Contract Management is contract-control software designed to help you manage your
projects more easily. From submittals to change orders, all the facts about contracts and
project documentation are at your fingertips. Contract Management Web Services is
an integration technology that extends Contract Management business objects and
functionality. Based on open standards including SOAP, XML and WSDL, Contract
Management Web Services enables developers to leverage standard interfaces to
create integrated software solutions that interoperate with a wide variety of enterprise
software applications running on a diversity of hardware and operating system platforms
This manual describes how to install and configure Contract Management Web Services.
In This Section
Using this Administrator’s Guide ................................................................................ 5
Contract Management (v13.1) Media Pack .......................................................... 6
Contract Management Documentation for v13.1 ................................................ 6
Contacting Customer Support ................................................................................. 7
Using this Administrator’s Guide
This guide describes the steps required to install Contract Management Web Services
and how to configure it to use Native or LDAP authentication. It is organized as follows:
Installing and Configuring Contract Management Web Services: Describes how to install
Contract Management Web Services and explains how to use the Contract
Management Administration Application to review, modify, add, and delete Contract
Management Web Services server configurations.
Configuring Authentication Modes: Describes the authentication modes available in this
release and explains how to configure Contract Management Web Services to operate
using Native or LDAP authentication.
Additional Contract Management Web Services documentation:
The following Contract Management Web Services user documentation is available:
The Primavera Contract Management Web Services Programmer’s Guide.
The Primavera Contract Management Web Services Reference Manual.
Preface
Contract Management Web Services Administrator's Guide
6
Contract Management (v13.1) Media Pack
This media pack includes the Quick Install Guide, along with the Contract
Management Application zip file. This zip file includes:
All files necessary to install Primavera Contract Management.
All manuals and technical documents related to the installation, administration, and
use of Primavera Contract Management.
The Primavera Contract Management Media Pack is delivered on the Oracle E-Delivery
Web site.
Contract Management Documentation for v13.1
Contract Management documentation consists of the following:
Contract Management Installation and Configuration Guide for Oracle
Explains how to install and configure Contract Management for Oracle and to convert
data from previous versions of Contract Management. The network or database
administrator responsible for the initial installation of Contract Management, ongoing
maintenance of the system and database, and general troubleshooting should read this
manual.
Contract Management Installation and Configuration Guide for Microsoft SQL Server
Explains how to install and configure Contract Management for Microsoft SQL Server and
to convert data from previous versions of Contract Management. The network or
database administrator responsible for the initial installation of Contract Management,
ongoing maintenance of the system and database, and general troubleshooting should
read this manual.
Contract Management Online Help
This is an integrated comprehensive online help system that supplements the printed
documentation. The help system is available while using the software for quick access to
information about fields, commands, and dialog boxes. Help also includes step-by-step
procedures for performing functions, and supplies answers to common questions. The
Table of Contents provides a starting point for many major topics. You can also use
Help’s powerful Search and Index features to find topics related to any text you enter.
Click How To for a list of all procedures contained in Help.
Contract Management User’s Guide
Explains how to manage and monitor paperwork from initial contracts through the last
change order. All individuals who use Contract Management should read this guide,
even if they are already familiar with previous versions of Contract Management.
Other Documentation
Preface
7
The Contract Management physical media or download location contains additional
information in the folder, \documentation.
Tested_Configurations.xls Lists the configurations that have been tested and verified
to work with Contract Management 13.1. The network administrator/database
administrator and Contract Management administrator should read this document.
The Oracle Primavera Contract Management P6 Web Services Configuration Guide
provides information on setting up Contract Management Web Services.
The Oracle Primavera Contract Management Web Services Reference Manual
provides information on the services and operations supported by Contract
Management Web Services.
The Oracle Primavera Contract Management Web Services Programmer's Guide
provides information on how to use Contract Management Web Services.
Note: Several areas of Contract Management can be customized,
such as the Control Center, document names, and document field
labels. The examples throughout this manual and in Help use the
default settings shipped with Contract Management.
Contacting Customer Support
For instructions on how to submit a service request for technical support for your
products, go to:
http://support.oracle.com
This page provides the latest information for contacting support and the support
renewals process.
Note: Contract Management databases contain calculations
called stored procedures. Although a Contract
Management database administrator has the ability to modify
these procedures, Oracle Primavera does not recommend
changing them. Modifying these procedures voids your Oracle
Primavera Customer Support agreement.
9
This chapter describes how to complete the required prerequisites before installing the
current version of Contract Management Web Services.
In This Section
Before you install Contract Management Web Services 13.1 ............................. 9
Before you install Contract Management Web Services 13.1
Prerequisites
Contract Management Web Services has the following system requirements for
installation:
Base Contract Management installation: Before you can install and deploy Contract
Management Web Services, you must first ensure that the following steps have been
performed on the base Contract Management installation (Oracle and SQLServer are
supported):
Contract Management 13.1 is installed and configured against the database you
intend to use.
Contract Management 13.1 is deployed on a WebLogic or JBoss domain.
Refer to the following guides for further information these items:
Contract Management 13.1 Installation and Configuration Guide for Oracle
Contract Management 13.1 Installation and Configuration Guide for Microsoft SQL
Server
Java Runtime Environment Requirements
Before installing Contract Management Web Services, you need to install a tested
and supported JDK. See the Tested_Configurations.xls document for the supported
versions.
The EAR file should be deployed in a supported application server running a
supported JDK.
Supported Operating Systems
Contract Management Web Services is fully supported on Windows.
Application Servers
Contract Management Web Services requires one of the following supported
application servers:
Prerequisites
Contract Management Web Services Administrator's Guide
10
Oracle WebLogic 11g
JBoss
See the Tested_Configurations.xls document for a list of the supported application server
versions.
Follow the instructions in this section to configure WebLogic 11g R1 for Contract
Management Web Services.
Note: The following procedure assumes that a supported
WebLogic 11g application server has been installed on the server
on which you are deploying Contract Management Web Services.
Create a Domain for Contract Management Web Services
Do the following to create a new domain specific to Contract Management Web
Services.
1) Go to Start, All Programs, Oracle WebLogic, WebLogic Server 11gR1, Tools, and click
Configuration Wizard to run the WebLogic Configuration Wizard.
2) In the Welcome window, select Create a new WebLogic domain and click Next.
3) In the Select Domain Source window, click Next to accept the default selections.
4) On the Specify Domain Name and Location page, enter the Domain Name and
Location and click Next.
5) In the Configure Administrator Username and Password window, enter the user name
and password information and click Next.
6) In the Configure Server Start Mode and JDK window, select Production Mode in the
left pane.
7) Select a JDK. Select or browse to an appropriate available JDK in the right pane.
a. Make a note of the JDK that you select in this step as you well need this information
in subsequent procedures.
b. Click Next.
8) In the Select Optional Configuration window, click Next.
Note: If you need to customize the domain name or listen port
information, select Administration Server and click Next to
customize these details.
Create a Domain for Contract Management Web Services
Create a Domain for Contract Management Web Services
11
9) In the Configuration Summary window, review the configuration and click Create.
10) In the Creating Domain window, select Start Admin Server and click Done.
11) When prompted, enter the user name and password that you entered in step 5.
13
Before beginning this installation, you must install and configure:
Contract Management. Refer to Installing and Configuring Primavera Contract
Management 14.0 for Oracle and the Installing and Configuring Primavera Contract
Management 14.0 for Microsoft SQL Server guides detailed information.
Java 1.6.X. on the server on which you are installing Contract Management Web
Services.
A WebLogic 11g domain for Contract Management Web Services. Refer to
Configuring the WebLogic Domain for Contract Management Web Services (on page
19) for details on this step.
Download the wsdl4j-1.6.2.jar.
Then follow the instructions in this section to install Contract Management Web Services.
In This Section
Prerequisites for Installing Contract Management Web Services 13.1 .............. 13
Install Contract Management Web Services 13.1 ............................................... 14
Prerequisites for Installing Contract Management Web Services 13.1
Before beginning this installation, you must install and configure:
Contract Management. Refer to Contract Management 13.1 Installation and
Configuration Guide for Oracle and the Contract Management 13.1 Installation
and Configuration Guide for Microsoft SQL Server guides detailed information.
Java 1.6.X. on the server on which you are installing Contract Management Web
Services.
A WebLogic 11g or JBoss domain for Contract Management Web Services.
The wsdl4j-1.6.2.jar file. This is a third party file. At the time of this writing, this file
was available at
http://mirrors.ibiblio.org/pub/mirrors/maven2/wsdl4j/wsdl4j/1.6.2/. To download
the jar:
a. Go to http://mirrors.ibiblio.org/pub/mirrors/maven2/wsdl4j/wsdl4j/1.6.2/.
b. Select the wsdl4j-1.6.2.jar.
c. Save the file to your machine.
d. Note the location where you save the jar file.
Follow the instructions in this section to install Contract Management Web Services.
Installing Contract Management Web Services
Contract Management Web Services Administrator's Guide
14
Install Contract Management Web Services 13.1
Before running the Contract Management installer, ensure that you
are logged in as a user that can write to the
<Weblogic_Domain_Home> folder. If necessary, adjust the
permissions to this folder to allow write access. This is especially
important if the WebLogic was installed by a different user than the
current user.
1) From the Contract Management Web Services physical media or download location,
run setup.exe. The Oracle Universal Installer dialog box will open.
2) On the Welcome page, click Next.
3) On the Specify Home Details page, enter a name and path for the installation and
click Next. To accept the default name and path, click Next.
You can install over an existing Contract Management Web Services directory from a
previous installation or install in a new directory. If the directory you specify does not
exist, the installer will create it during the installation process.
4) On the Information page, click Next if you have installed and configured all of the
listed items. If you have not yet installed and configured all of the items, click
Cancel to end the installation for Contract Management Web Services and install the
necessary components before resuming.
5) On the Java Home Location page, browse to the installation location for Java and
click Next.
6) On the Specify the wsdl4j-1.6.2 Directory page, specify the path to the wsdl4j-16.2 jar
file on the local machine.
7) On the Select Application Server type page, select one of the following options, and
click Next:
JBoss
WebLogic
8) On the Choose <Application Server> Domain Home page, browse to the location of
the domain for Contract Management Web Services. For example,
C:\Oracle\Middleware\user_projects\domains\cmws.
9) On the Summary page, check the summary. Click Install if the summary is accurate.
10) On the End of Installation page, click Exit.
Note: Do not change the location of the htmlTemplates folder in
the Contract Management Web Services home directory. If you
have made any customizations to the templates in Contract
Management home directory, copy the changed files to the
htmlTemplates folder in Contract Management Web Services
home directory.
Configuring the WebLogic Application Server for Contract Management Web Services 13.1
15
Follow the instructions in this section to configure WebLogic 11g for Contract
Management Web Services on the server on which you plan to install Contract
Management Web Services. For the full list of tested configurations, see the
Tested_Configurations.xls document in the Documentation folder of the Contract
Management physical media or download.
Prerequisites
Before configuring the Weblogic application server, complete the following steps on the
server on which you plan to install Contract Management Web Services:
1) Install WebLogic on the server. See the Tested_Configurations.xls document for the
supported versions.
2) Install a tested and supported JDK. See the Tested_Configurations.xls document for
the supported versions.
Configure the WebLogic Application Server for Contract Management Web Services on Windows
Do the following to configure the WebLogic server for Contract Management Web
Services:
1) On the server where you installed WebLogic, in the
<Contract_Management_Web_Services_Domain_Home>\bin directory, open the
startWebLogic.cmd file in a text editor (such as Notepad).
2) Update the SAVE_CLASSPATH variable as follows:
Windows Operating System with an Oracle Database
Enter a line similar to the following (all one line):
set
SAVE_CLASSPATH=%DOMAIN_HOME%\lib\mail.jar;%DOMAIN_HOME%\lib\pbjdbc12120.jar;%D
OMAIN_HOME%\lib\ojdbc6.jar;%CLASSPATH%;.
Windows Operating System with a Microsoft SQL Server Database
Enter a line similar to the following (all one line):
Configuring the WebLogic Application Server for Contract Management Web Services 13.1
Contract Management Web Services Administrator's Guide
16
set
SAVE_CLASSPATH=%CLASSPATH%;%DOMAIN_HOME%\lib\mail.jar;%DOMAIN_HOME%\lib\pbjdbc
12120.jar;%DOMAIN_HOME%\lib\sqljdbc.jar;.
Note: The preceding is case-sensitive, and should be all on the
same line. Because of the format restrictions of this document, it
may be displayed on multiple lines.
3) Update the JAVA_OPTIONS variable as follows:
Enter a line similar to the following (all one line):
set JAVA_OPTIONS=%SAVE_JAVA_OPTIONS%
-Djavax.xml.soap.MessageFactory=com.sun.xml.messaging.saaj.soap.ver1_1.SOAPMes
sageFactory1_1Impl
-Djavax.xml.soap.SOAPConnectionFactory=weblogic.wsee.saaj.SOAPConnectionFactor
yImpl -Dcmws.install.home=<CM_WS_HOME>
Notes:
The preceding is case-sensitive, and should be all on the same
line. Because of the format restrictions of this document, it may
be displayed on multiple lines.
Replace <CM_WS_HOME> in the preceding line with the
location in which Contract Management Web Services is
installed. For example c:/CMWebServices_1.
4) Save the changes you made to the startWebLogic.cmd file
Set the Application Server Memory Parameters on Windows
Oracle recommends setting the following memory parmeters for the typical Contract
Management Web Services environment.
1) Determine which JDK you are using for your Contract Management Web Services
domain.
2) Locate and open the following file:
<Contract_Management_Web_Services_Domain_Home>\bin\setDomainEnv.cmd
3) If you are using Sun JDK, make the following edits to the setDomainEnv.cmd file:
a. Search for the following line:
set MEM_ARGS_32BIT=%WLS_MEM_ARGS_32BIT%
b. Replace the line above with the following lines:
@REM set MEM_ARGS_32BIT=%WLS_MEM_ARGS_32BIT%
set MEM_ARGS_32BIT=-XX:NewSize=256m -XX:MaxNewSize=256m -XX:SurvivorRatio=8
-Xms1024m -Xmx1024m
c. Search for the following line
Configuring the WebLogic Application Server for Contract Management Web Services 13.1
17
set MEM_MAX_PERM_SIZE_32BIT=-XX:MaxPermSize=128m
d. Replace the line above with following lines:
@REM set MEM_MAX_PERM_SIZE_32BIT=-XX:MaxPermSize=128m
set MEM_MAX_PERM_SIZE_32BIT=-XX:MaxPermSize=256m
4) If you are using JRockit, make the following edits to the setDomainEnv.cmd file:
a. Search for the following line:
set MEM_ARGS_32BIT=%WLS_MEM_ARGS_32BIT%
b. Replace the line above with the following lines:
@REM set MEM_ARGS_32BIT=%WLS_MEM_ARGS_32BIT%
set MEM_ARGS_32BIT=-Xms1024m -Xmx1024m
5) Save the changes to the setDomainEnv.cmd file.
6) Restart the WebLogic domain.
19
In This Section
Configuring an Oracle Database Data Source ................................................... 19
Configuring the MicroSoft SQL Server Database Data Source .......................... 21
Configuring an Oracle Database Data Source
This section describes how to set up the data source on your WebLogic domain for
Contract Management Web Services when the Contract Management database is an
Oracle database.
Complete all the following procedures for each database:
Once for the GROUP database.
Once for the ADMIN database, also referred to as EXPADMIN.
Note: In this section, CMPROJ is used as the group database name.
It is provided only as an example of a possible GROUP database
name.
Configure JDBC Properties for an Oracle Database Data Source
Complete the following steps in the JDBC Data Source Properties dialog box.
Note: Data Source names are case sensitive, and must match the
data source.
1) Login to WebLogic Admin console.
2) If you have not already done so, in the Change Center of the Administration Console,
click Lock & Edit.
3) In the Domain Structure tree, select Data Sources under Services-JDBC.
4) On the Summary of Data Sources page, click New.
5) Set the Name field (depending on which data source your are setting up). For
example, these might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
Configuring the WebLogic Domain for Contract Management Web Services
Contract Management Web Services Administrator's Guide
20
Note: JNDI field names are case sensitive, and must match the
name you used for JNDI.
6) Set the JNDI Name field to jdbc/<database_name>. For example, <database_name>
might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
7) Set the Database Type field to Oracle and click Next.
8) Set the Database Driver field:
If using Oracle 10g, select Oracle's Driver (Thin) Versions:9.0.1, 9.2.0, 10 and click
Next.
If using Oracle 11g, select Oracle's Driver (Thin) for Instance Connections:
Versions:9.0.1, 9.2.0, 10, 11 and click Next.
Set Transaction Options
Do the following in the Transaction Options screen:
1) In the Transaction Options screen:
To set transaction options for a single project group:
If you are configuring the Admin or P6 EPPM database, clear the Supports Global
Transactions option, and click Next.
If you are configuring a project database:
1. Select the Supports Global Transactions option.
2. Click the One-Phase Commit radio button.
3. Click Next. The Connection Properties dialog box displays.
To set transaction options for multiple project groups:
1. Select the Supports Global Transactions option.
2. Select Emulate Two-Phase Commit.
Set the Connection Properties
Do the following in the Connection Properties screen:
1) Set the Database Name field to the SID of the Oracle database, for example ORCL.
2) Set the Host Name field to <database_hostname>, where <database_hostname> is
the name or IP address of the host on which each database is installed.
3) Set the Port field to <database_port>, where <database_port> is the port number of
the host on which each database is installed.
4) Set the Database User Name field. These were determined when you created the
databases. For example, these might be:
expadmin for the EXPADMIN database.
cmproj for the CMPROJ database.
Configuring the WebLogic Domain for Contract Management Web Services
21
5) Set the Password field. These were determined when you created the databases. For
example, these might be:
expadmin for the ADMIN database.
cmproj for the CMPROJ database.
6) Confirm the Password.
7) Click Next.
Test the Database Connection
Do the following in the Test Database Connection screen:
1) Click Test Configuration to verify that connection is successful.
2) Click Next.
Select Targets
Do the following in the Select Targets screen:
1) Select <server_name>, where <server_name> is the target server for WebLogic.
2) Click Finish.
Activate Changes
After all of the data sources are set, activate the changes:
In the left hand Change Center pane, click Activate Changes at the top of the
pane.
Configuring the MicroSoft SQL Server Database Data Source
This section describes how to set up the data source on your WebLogic domain for
Contract Management Web Services when the Contract Management database is a
Microsoft SQL database.
Configure JDBC Properties for a Microsoft SQL Server Database Data Source
Complete the following steps in the JDBC Data Source Properties dialog box for each
database:
Once for the GROUP database.
Once for the ADMIN database, also referred to as EXPADMIN.
Notes:
In this section, CMPROJ is used as the group database name. It
is provided only as an example of a possible GROUP database
name.
Contract Management Web Services Administrator's Guide
22
Data Source names are case sensitive, and must match the
data source.
1) Login to WebLogic Admin console.
2) If you have not already done so, in the Change Center of the Administration Console,
click Lock & Edit.
3) In the Domain Structure tree, select Data Sources under Services-JDBC.
4) On the Summary of Data Sources page, click New.
5) Set the Name field (depending on which data source your are setting up). For
example, these might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
Note: JNDI field names are case sensitive, and must match the
name you used for JNDI.
6) Set the JNDI Name field to jdbc/<database_name>. For example, <database_name>
might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
7) Set the Database Type field to MS SQL Server and click Next.
8) Set the Database Driver field to:
Microsoft's MS SQL Server Driver (Type 4) Versions: 2005 and later.
9) Click Next.
Set Transaction Options
1) In the Transaction Options screen:
To set transaction options for a single project group:
If you are configuring the Admin or P6 EPPM database, clear the Supports Global
Transactions option, and click Next.
If you are configuring a project database:
1. Select the Supports Global Transactions option.
2. Click the One-Phase Commit radio button.
3. Click Next. The Connection Properties dialog box displays.
To set transaction options for multiple project groups:
1. Select the Supports Global Transactions option.
2. Select Emulate Two-Phase Commit.
Set the Connection Properties
Do the following in the Connection Properties screen:
1) Set the Database Name field to one of the following:
Configuring the WebLogic Domain for Contract Management Web Services
23
The Database name for the Contract Management ADMIN database. This is
EXPADMIN.
The Database name for the Contract Management GROUP database. This is
CMPROJ.
2) Set the Host Name field to <database_hostname>, where <database_hostname> is
the host on which Microsoft SQL Server is installed. If the SQL instance is not a default
instance, set the Host Name field to <database_hostname>\<instance_name>.
3) Set the Port field to <database_port>, where <database_port> is the port number of
the host on which Microsoft SQL Server is installed.
4) Set the Database User Name field. These were determined when you created the
databases. For example, these might be:
exp for the EXPADMIN database.
exp for the CMPROJ database.
5) Set the Password field. These were determined when you created the databases. For
example, these might be:
sql for the ADMIN database.
sql for the CMPROJ database.
6) Confirm the Password.
7) Click Next.
Test the Database Connection
Do the following in the Test Database Connection screen:
1) Click Test Configuration to verify that connection is successful.
2) Click Next.
Select Targets
Do the following in the Connection Properties screen:
1) Select <server_name>, where <server_name> is the target server for WebLogic.
2) Click Finish.
Activate Changes
After all of the data sources are set, activate the changes:
In the left hand Change Center pane, click Activate Changes at the top of the
pane.
25
In This Section
Deploying the WebLogic Domain for Contract Management Web Services 25
Deploying the WebLogic Domain for Contract Management Web Services
Deploy Contract Management Web Services
Note: You cannot perform the steps in this procedure until after you
have installed Contract Management Web Services.
1) In the WebLogic Server Administration Console, click Lock & Edit.
2) Click Deployments from the left hand pane.
3) Click Install on the Deployments dialog box.
4) In the Install Application Assistant section of the right hand pane, perform the
following steps:
a. In the Location section, specify the path to the cmws.ear file from the
<CM_WS_INSTALL_HOME> folder (For example,
c:\CMWebServices_1\server\cmws.ear) and click Next.
b. In the Choose targeting style section, click Install this deployment as an
application, and click Next.
c. In the Optional Settings section at the top of the pane, click Finish.
5) In the Settings for server section of the right hand pane, click Save
6) On the WebLogic Administration Console window, the Summary of Deployments
displays in the right hand pane. In the left hand Change Center pane, click Activate
Changes at the top of the pane.
7) Click Deployments from the left hand pane.
8) In the Summary of Deployments section of the right hand pane, select the cmws
deployment option, click Start under Deployments, and choose Servicing all requests
from the drop-down list.
9) In the Start Application Assistant in the right hand pane, click Yes to confirm that you
want to start the deployment.
Deploying Contract Management Web Services to a WebLogic Application Server
Contract Management Web Services Administrator's Guide
26
Create an Endorsed Folder
Follow the steps below to create an endorsed folder:
1) Locate the folder that contains the JDK you used when you created the WebLogic
domain for Contract Management Web Services. This folder is known as
<JDK_HOME>.
If it does not already exist, create the following endorsed folder:
<JDK_HOME>/jre/lib/endorsed.
2) In the <CM_WS_INSTALL_HOME>/endorsed folder, locate the saaj-impl.jar file
3) Copy the saaj-impl.jar file to the endorsed folder in <JDK_HOME>.
4) Restart the WebLogic domain.
27
In This Section
Clustering: Configuring the Environment in Windows .......................................... 27
Clustering: Start the WebLogic Domains on Windows ........................................ 28
Clustering: Configure the Data Sources ................................................................ 29
Clustering: Deploy Contract Management Web Services ................................. 33
Clustering: Considerations for Using Contract Management Web Services in a
Clustered Environment ............................................................................................. 34
Deploying Contract Management Web Services to a JBoss Application Server35
Clustering: Configuring the Environment in Windows
Overview
A WebLogic Server cluster consists of multiple WebLogic Server server instances running
simultaneously and working together to provide increased scalability and reliability. A
cluster appears to clients to be a single WebLogic Server instance. A cluster is part of a
particular WebLogic Server domain, which is an interrelated set of WebLogic Server
resources that are managed as a unit
Using Contract Management Web Services in a clustered WebLogic environment
requires that you first create a WebLogic cluster for Contract Management Web Services
that contains an admin domain on an admin server and a set of managed domains on
managed servers. Refer to the WebLogic documentation for information on creating a
WebLogic cluster that includes an admin server and set of managed servers and
domains. Then use the following procedures to configure and use the WebLogic cluster
for Contract Management Web Services.
Configure the Admin and Managed Servers for Contract Management Web Services
1) Make the changes that are specified in Configure the WebLogic Application Server
for Contract Management Web Services on Windows (on page 15) to the
startWebLogic.cmd file on all servers in the cluster, including the admin server.
2) Install Contract Management Web Services on the admin server.
3) On each of the managed servers, perform the following activities:
a. Copy all of the files in the <domain_home>\lib folder on the admin server to the
<domain_home>\lib folder of the managed server machines.
b. Copy the <domain_home>\com folder on the admin server to
<domain_home>\com folder of the managed server machines.
Configuring Contract Management for a WebLogic Cluster
Contract Management Web Services Administrator's Guide
28
4) Create an endorsed folder on the admin server and on all managed servers.
a. Copy the saaj-impl.jar file from the <CM_WS_INSTALL_HOME>/endorsed folder on
the Admin server to the <JDK_HOME>/jre/lib/endorsed folder on the Admin server
b. Copy the saaj-impl.jar file from the <CM_WS_INSTALL_HOME>/endorsed folder on
the Admin server to the <JDK_HOME>/jre/lib/endorsed folder on each of the
managed servers.
5) If you have made any changes to default templates in the htmlTemplates folder,
copy the changed files into the Contract Management Web Services into the
htmlTemplates folder.
Adjust the Java Home variable on all Managed Servers
If a managed domain is created with a pack and unpack of the admin domain, the
SUN_JAVA_HOME and BEA_JAVA_HOME variables can revert to default values. Follow
this procedure to check and correct these variables:
1) Open the setDomainEnv.cmd \ .sh file in a text editor on all managed servers.
2) Search for following strings and ensure that these variables are set to the correct
path.
Sun JDK
set SUN_JAVA_HOME=
JRocket JDK
set BEA_JAVA_HOME=
Clustering: Start the WebLogic Domains on Windows
1) On the admin server, navigate to the
<Contract_Management_Web_Services_Domain_Home>/bin folder and execute the
following command:
startWebLogic.cmd
2) On each of the managed servers, navigate to the
<Contract_Management_Web_Services_Domain_Home>/bin folder and execute the
following command:
startManagedWebLogic.cmd <managed_server_name>
http://<admin_server_address>:<admin_domain_port>
For example:
Admin server is configured as adminserver.us.oracle.com
Managed servers are configured as follows:
managedserver1.us.oracle.com with friendly name managed1
managedserver2.us.oracle.com with friendly name managed2
Configuring Contract Management for a WebLogic Cluster
29
To start managed servers with this configuration:
a. On managedserver1.us.oracle.com, execute the following command:
startManagedWebLogic.cmd managed1 http://adminserver.us.oracle.com:7001
b. On managedserver2.us.oracle.com, execute the following command:
startManagedWebLogic.cmd managed2 http://adminserver.us.oracle.com:7001
Clustering: Configure the Data Sources
Clustering: Configure JDBC Properties for an Oracle Database Data Source
Complete the following steps in the JDBC Data Source Properties dialog box.
Note: Data Source names are case sensitive, and must match the
data source.
1) Login to WebLogic Admin console.
2) If you have not already done so, in the Change Center of the Administration Console,
click Lock & Edit.
3) In the Domain Structure tree, select Data Sources under Services-JDBC.
4) On the Summary of Data Sources page, click New.
5) Set the Name field (depending on which data source your are setting up). For
example, these might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
Note: JNDI field names are case sensitive, and must match the
name you used for JNDI.
6) Set the JNDI Name field to jdbc/<database_name>. For example, <database_name>
might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
7) Set the Database Type field to Oracle and click Next.
8) Set the Database Driver field:
If using Oracle 10g, select Oracle's Driver (Thin) Versions:9.0.1, 9.2.0, 10 and click
Next.
If using Oracle 11g, select Oracle's Driver (Thin) for Instance Connections:
Versions:9.0.1, 9.2.0, 10, 11 and click Next.
Contract Management Web Services Administrator's Guide
30
Set Transaction Options
1) In the Transaction Options screen:
To set transaction options for a single project group:
If you are configuring the Admin or P6 EPPM database, clear the Supports Global
Transactions option, and click Next.
If you are configuring a project database:
1. Select the Supports Global Transactions option.
2. Click the One-Phase Commit radio button.
3. Click Next. The Connection Properties dialog box displays.
To set transaction options for multiple project groups:
1. Select the Supports Global Transactions option.
2. Select Emulate Two-Phase Commit.
Set the Connection Properties
Do the following in the Connection Properties screen:
1) Set the Database Name field to the SID of the Oracle database, for example ORCL.
2) Set the Host Name field to <database_hostname>, where <database_hostname> is
the name or IP address of the host on which each database is installed.
3) Set the Port field to <database_port>, where <database_port> is the port number of
the host on which each database is installed.
4) Set the Database User Name field. These were determined when you created the
databases. For example, these might be:
expadmin for the EXPADMIN database.
cmproj for GROUP databases (for example, CMDEMO or CMPROJ).
5) Set the Password field. These were determined when you created the databases. For
example, these might be:
expadmin for the ADMIN database.
cmproj for GROUP databases (for example, CMDEMO or CMPROJ).
6) Confirm the Password.
7) Click Next.
Test the Database Connection
Do the following in the Test Database Connection screen:
1) Click Test Configuration to verify that connection is successful.
2) Click Next.
Configuring Contract Management for a WebLogic Cluster
31
Select Targets
Do the following in the Select Targets screen:
1) Select the <cluster_name>, where <cluster_name> is the target cluster for WebLogic.
Note: When selecting target servers for datasources, the target
should be "All servers in the cluster."
2) Click Finish.
Activate Changes
After all of the data sources are set, activate the changes:
In the left hand Change Center pane, click Activate Changes at the top of the
pane.
Clustering: Configure JDBC Properties for a Microsoft SQL Server Database Data Source
Complete the following steps in the JDBC Data Source Properties dialog box for each
database:
Once for the GROUP database.
Once for the ADMIN database, also referred to as EXPADMIN.
Notes:
In this section, CMPROJ is used as the group database name. It
is provided only as an example of a possible GROUP database
name.
Data Source names are case sensitive, and must match the
data source.
1) Login to WebLogic Admin console.
2) If you have not already done so, in the Change Center of the Administration Console,
click Lock & Edit.
3) In the Domain Structure tree, select Data Sources under Services-JDBC.
4) On the Summary of Data Sources page, click New.
5) Set the Name field (depending on which data source your are setting up). For
example, these might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
Note: JNDI field names are case sensitive, and must match the
name you used for JNDI.
Contract Management Web Services Administrator's Guide
32
6) Set the JNDI Name field to jdbc/<database_name>. For example, <database_name>
might be:
CMPROJ for the CMPROJ database
EXPADMIN for the EXPADMIN database
7) Set the Database Type field to MS SQL Server and click Next.
8) Set the Database Driver field to:
Microsoft's MS SQL Server Driver (Type 4) Versions: 2005 and later.
9) Click Next.
Set Transaction Options
1) In the Transaction Options screen:
To set transaction options for a single project group:
If you are configuring the Admin or P6 EPPM database, clear the Supports Global
Transactions option, and click Next.
If you are configuring a project database:
1. Select the Supports Global Transactions option.
2. Click the One-Phase Commit radio button.
3. Click Next. The Connection Properties dialog box displays.
To set transaction options for multiple project groups:
1. Select the Supports Global Transactions option.
2. Select Emulate Two-Phase Commit.
Set the Connection Properties
Do the following in the Connection Properties screen:
1) Set the Database Name field to one of the following:
The Database name for the Contract Management ADMIN database. This is
EXPADMIN.
The Database name for the Contract Management GROUP database. This is
CMPROJ.
2) Set the Host Name field to <database_hostname>, where <database_hostname> is
the host on which Microsoft SQL Server is installed. If the SQL instance is not a default
instance, set the Host Name field to <database_hostname>\<instance_name>.
3) Set the Port field to <database_port>, where <database_port> is the port number of
the host on which Microsoft SQL Server is installed.
4) Set the Database User Name field. These were determined when you created the
databases. For example, these might be:
exp for the EXPADMIN database.
exp for the CMPROJ database.
Configuring Contract Management for a WebLogic Cluster
33
5) Set the Password field. These were determined when you created the databases. For
example, these might be:
sql for the ADMIN database.
sql for the CMPROJ database.
6) Confirm the Password.
7) Click Next.
Test the Database Connection
Do the following in the Test Database Connection screen:
1) Click Test Configuration to verify that connection is successful.
2) Click Next.
Select Targets
Do the following in the Select Targets screen:
1) Select the <cluster_name>, where <cluster_name> is the target cluster for WebLogic.
Note: When selecting target servers for datasources, the target
should be "All servers in the cluster."
2) Click Finish.
After all of the data sources are set, activate the changes:
In the left hand Change Center pane, click Activate Changes at the top of the
pane.
Clustering: Deploy Contract Management Web Services
Note: You cannot perform the steps in this procedure until after you have installed
Contract Management Web Services.
1) In the WebLogic Server Administration Console, click Lock & Edit.
2) Click Deployments from the left hand pane.
3) Click Install on the Deployments dialog box.
4) In the Install Application Assistant section of the right hand pane, perform the
following steps:
a. In the Location section, specify the path to the cmws.ear file from the
<CM_WS_INSTALL_HOME> folder (For example,
c:\CMWebServices_1\server\cmws.ear) and click Next.
b. In the Choose targeting style section, click Install this deployment as an
application, and click Next.
c. In the Select deployment targets section, select the <cluster_name>, where
<cluster_name> is the target cluster for WebLogic.
Contract Management Web Services Administrator's Guide
34
d. Click Finish.
Note: When selecting target servers for Contract Management
Web Services and for datasources, the target should be "All servers
in the cluster."
5) In the Settings for server section of the right hand pane, click Save
6) On the WebLogic Administration Console window, the Summary of Deployments
displays in the right hand pane. In the left hand Change Center pane, click Activate
Changes at the top of the pane.
7) Click Deployments from the left hand pane.
8) In the Summary of Deployments section of the right hand pane, select the cmws
deployment option, click Start under Deployments, and choose Servicing all requests
from the drop-down list.
9) In the Start Application Assistant in the right hand pane, click Yes to confirm that you
want to start the deployment.
The deployment will be pushed from Admin server to all managed servers.
Clustering: Considerations for Using Contract Management Web Services in a Clustered Environment
Configuring the Load Balancing
Refer to WebLogic documentation for information on how to configure the load
balancer.
Recommendations
In a clustered environment, Oracle Primavera recommends that the following operations
only be performed when no users (except the user performing these operations) are
logged into Contract Management:
Project Delete
Modifying, adding, or deleting custom fields
Modifying, adding, or deleting cost code definitions
35
Deploying Contract Management Web Services to a JBoss Application Server
In This Section
Deploying Contract Management Web Services to a JBoss Application Server35
Deploying Contract Management Web Services to a JBoss Application Server
Prerequisites:
A supported version of JBoss is installed on the server on which you are deploying
Contract Management Web Services.
Contract Management 13.1 is installed and deployed into the JBoss domain.
Follow the instructions in this section to create a domain in JBoss for Contract
Management Web Services, install Contract Management Web Services on the server,
and deploy Contract Management Web Services on JBoss.
1) Create a Contract Management Web Services domain in JBoss by making a copy of
the default folder in the <JBOSS_HOME>\server folder and naming the copied folder
with an appropriate name for Contract Management Web Services.
2) Install Contract Management Web Services
Before running the Contract Management Web Services installer,
ensure that you are logged in as a user that can write to the
<JBOSS_HOME>\server\CMWS_DOMAIN_HOME> folder. If
necessary, adjust the permissions to this folder to allow write
access. This is especially important if the JBoss Application Server
was installed by a different user than the current user.
a. From the Contract Management Web Services physical media or download
location, run setup.exe. The Oracle Universal Installer dialog box will open.
b. On the Welcome page, click Next.
c. On the Specify Home Details page, enter a name and path for the installation and
click Next. To accept the default name and path, click Next.
d. You can install over an existing Contract Management Web Services directory
from a previous installation or install in a new directory. If the directory you specify
does not exist, the installer will create it during the installation process.
e. On the Information page, click Next if you have installed and configured all of the
listed items. If you have not yet installed and configured all of the items, click
Cancel to end the installation for Contract Management Web Services and install
the necessary components before resuming.
f. On the Java Home Location page, browse to the installation location for Java and
click Next.
Contract Management Web Services Administrator's Guide
36
g. On the Specify the wsdl4j-1.6.2 Directory page, specify the path to the wsdl4j-16.2
jar file.
h. On the Select Application Server Type page, select JBoss and click Next.
i. On the Choose <Application Server> Domain Home page, browse to the location
of the domain for Contract Management Web Services. For example,
C:\jboss-5.0.1.GA\server\cmws.
j. On the Summary page, check the summary. Click Install if the summary is
accurate.
k. On the End of Installation page, click Exit.
Note: Do not change the location of the htmlTemplates folder in
the Contract Management Web Services home directory. If you
have made any customizations to the templates in Contract
Management home directory, copy the changed files to the
htmlTemplates folder in Contract Management Web Services
home directory.
3) Modify JAVA_OPTS in <JBOSS_HOME>\bin\run.bat
set JAVA_OPTS=%JAVA_OPTS% -Xms256m -Xmx1024m -XX:PermSize=128m
-XX:MaxPermSize=128m
Note: If Contract Management Web Services is on the same
machine as Contract Management, JAVA_OPTS should be
already modified on the Contract Management deployment.
4) Copy the expedition-ds.xml file from the
<JBOSS_HOME>\server\<CM_DOMAIN_HOME>\deploy folder to the
<JBOSS_HOME>\server\<CMWS_DOMAIN_HOME>\deploy folder.
5) Update the
<JBOSS_HOME>\server\<CMWS_DOMAIN_HOME>\deploy\jbossweb.sar\server.xml
file.
a. Replace the HTTP connector section with the following lines:
<!-- A HTTP/1.1 Connector on port 8080 -->
<Connector protocol="HTTP/1.1" port="8080" maxThreads="250" strategy="ms"
maxHttpHeaderSize="8192" emptySessionPath="true" enableLookups="false"
compression="on" address="*" acceptCount="100" connectionTimeout="20000"
redirectPort="8443" disableUploadTimeout="true" URIEncoding="UTF-8"/>
Note: If Oracle XE is deployed on the same machine as CMWS
change port from 8080 to 8090.
b. Add the autoDeploy, deployOnStartup and deployXML attributes and values to
the Host tag:
Configuring Contract Management for a WebLogic Cluster
37
<Host name="localhost" autoDeploy="false" deployOnStartup="false"
deployXML="false" >
6) Update the
<JBOSS_HOME>\server\<CMWS_DOMAIN_HOME>\conf\jbosjta-properties.xml file.
a. Search for the following line:
<properties depends="arjuna" name="jta">
b. After this line, add the following line:
<property name="com.arjuna.ats.jta.allowMultipleLastResources" value="true"/>
7) Follow the steps below to comment out the <application-policy name="other">
element in the login-config.xml file:
a. Open the
<JBOSS_HOME>\server\<CMWS_DOMAIN_HOME>\conf\login-config.xml file in a
text editor.
b. Search for the following line:
<application-policy name="other">
c. Comment this line out. For example:
<!--
<application-policy name="other">
-->
d. Scroll down to the following lines
<authentication>
<login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule"
flag="required"/>
</authentication>
</application-policy>
e. Comment these lines out. For example:
<!--
<authentication>
<login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule"
flag="required"/>
</authentication>
</application-policy>
-->
8) Delete the ROOT.war folder from the
<JBOSS_HOME>\server\<CMWS_DOMAIN_HOME>\deploy folder.
9) Create the runcmws.bat file.
a. Navigate to the <JBOSS_HOME>\bin folder.
b. Create a runcmws.bat file with the following commands:
Contract Management Web Services Administrator's Guide
38
set JAVA_HOME=C:\jdk1.6.0_14
set JBOSS_HOME=C:\jboss-5.0.1.GA
set
JBOSS_CLASSPATH=%JBOSS_HOME%\server\cmws\lib\pbjdbc12120.jar;%JBOSS_HOME%\serv
er\cmws\lib\ojdbc6.jar;%JBOSS_HOME%\server\cmws\lib\resource_strings.jar;%JBOS
S_HOME%\server\cmws\lib\sqljdbc.jar;
cd %JBOSS_HOME%\bin
run -c <CMWS_DOMAIN> -Djboss.service.binding.set=ports-01
Note: Substitute the appropriate values for JAVA_HOME,
JBOSS_HOME and CMWS_DOMAIN when you create the
runcmws.bat file.
The -Djboss.service.binding.set=ports-01 property will cause
Contract Management Web Services to run on port 8180. To
change this port number, increment the last digit. For example to
run on port 8280, set this property to
-Djboss.service.binding.set=ports-02.
10) Run runcmws.bat to start Contract Management Web Services.
39
In This Section
Starting the Contract Management Administration Application on Windows 39
Viewing and Modifying Contract Management Administration Application
Settings ....................................................................................................................... 39
Contract Management Web Services 13. 1 Settings ........................................... 39
Using LDAP with Contract Management Web Services on Windows ............... 44
Starting the Contract Management Administration Application on Windows
Start the Contract Management Administration Application
1) Change to the <CM_WS_INSTALL_HOME>\utility\CMAdminConfig folder (For
example, c:\CMWebServices_1\utility\CMAdminConfig).
2) Run the admincm.cmd file. Enter your admin username and password on the
Contract Management Administration Application Login page and click Login.
Viewing and Modifying Contract Management Administration Application Settings
Run Contract Management Administration Application to change database,
authentication configuration settings, or general preferences.
Contract Management Web Services 13. 1 Settings
Use the information below to make the appropriate Contract Management
Administration Application settings pertaining to Web Services.
Refer to Contract Management Installation and Configuration Guide for Oracle and the
Contract Management Installation and Configuration Guide for Microsoft SQL Server
guides for information on the Contract Management settings.
1) Expand the tree to the Web Services folder by selecting Contract
Management Settings > Web Services.
2) Select the Security folder.
3) To modify the options in the Authentication and Message Protection folders,
triple-click the option and enter an appropriate value.
Configuring Contract Management Web Services
Contract Management Web Services Administrator's Guide
40
Setting Name and Description Default Valid Ranges/Values
Web
Services/Security/Authentication/Mode
The method clients use for authentication.
Username
Token Profile
Username Token
Profile, SAML
Token Profile,
Cookies
Web
Services/Security/Authentication/Username
Token Profile/Nonce/Require Nonce
Set to true to enable nonce.
true true/false
Web
Services/Security/Authentication/Username
Token Profile/Nonce/Nonce Cache
Timeout
Specify a value, in the format 1d1h1m1s, for
the Nonce cache timeout. The value
specified indicates how long the nonce
remains cached before it is expunged.
10m 5m-24d
Web
Services/Security/Authentication/Username
Token Profile/Created/Require Created
Set to true to enable the Username token
timestamp.
true true/false
Web
Services/Security/Authentication/Username
Token Profile/Created/Timeout
Specify a value, the format 1d1h1m1s, for
the timestamp (Created) timeout. You can
specify a minimum of 300 seconds. If you do
not specify a value, the default is 600
seconds.
10m 5m-24d
Web
Services/Security/Authentication/SAML
Token Profile/SAML Version
The SAML version of the token.
1.1 1.1
Configuring Contract Management Web Services
41
Setting Name and Description Default Valid Ranges/Values
Web
Services/Security/Authentication/SAML
Token Profile/Require Signed SAML Token
Specify whether SAML tokens must be
signed or unsigned.
true true/false
Web
Services/Security/Authentication/SAML
Token Profile/SAML 1.1 Tokens/Issuer
Set the valid issuer for the SAML token.
Separate multiple valid issuers with a space.
http://your.saml
.issuer.com
—
Web
Services/Security/Authentication/SAML
Token Profile/SAML 1.1 Tokens/IssueInstant
Timeout
Specify a value, in the format 1d1h1m1s, for
the IssueInstant timeout. The value specified
indicates the maximum time allowed
between the time the token is issued and
the time the token is received by the web
service.
5m 5m-24d
Web
Services/Security/Authentication/SAML
Token Profile/SAML 1.1
Tokens/AuthenticationInstant Timeout
Specify a value, in the format 1d1h1m1s, for
the AuthenticationIssueInstant timeout. The
value specified indicates the maximum
time allowed between the time the user is
authenticated and the time the token is
received by the web service.
5m 5m-24d
Web
Services/Security/Authentication/SAML
Token Profile/Signed SAML tokens/KeyStore
Type
Keystore type.
JKS JKS
Contract Management Web Services Administrator's Guide
42
Setting Name and Description Default Valid Ranges/Values
Web
Services/Security/Authentication/SAML
Token Profile/Signed SAML tokens/File
Location
Absolute path to the key store file. This file
must exist on the local filesystem.
c:\keystore\key
store.jks
—
Web
Services/Security/Authentication/SAML
Token Profile/Signed SAML tokens/Keystore
Password
Keystore password.
— —
Web
Services/Security/Authentication/SAML
Token Profile/Signed SAML
tokens/Certificate Alias
Alias for the client certificate containing the
public key.
alias —
Web Services/Security/Message
Protection/Require Timestamp
If set to true, incoming SOAP messages must
contain the WS-Security Timestamp
element.
true true/false
Web Services/Security/Message
Protection/Require Digital Signatures for
Incoming Messages
Set to true to require that incoming SOAP
messages are signed and conform to Web
Service Security 1.1 standards. If set to false,
incoming SOAP messages must not be
signed.
true true/false
Configuring Contract Management Web Services
43
Setting Name and Description Default Valid Ranges/Values
Web Services/Security/Message
Protection/Require Encryption for Incoming
Messages
Set to true to require incoming SOAP
messages are encrypted and conform to
Web Service Security 1.1 standards. When
this setting is true, at least one element in
each P6 Web Services request message
must be encrypted. If set to false, incoming
SOAP messages must not be encrypted.
true true/false
Web Services/Security/Message
Protection/KeyStore Type
Specify the KeyStore Type.
JKS JKS
Web Services/Security/Message
Protection/File Location
Absolute path to key store file. This file must
exist on the local filesystem.
c:\keystore\key
store.jks
Web Services/Security/Message
Protection/KeyStore Password
Password for the KeyStore.
— —
Web Services/Security/Message
Protection/Private Key Alias
Alias for the private key in KeyStore.
alias
Web Services/Security/Message
Protection/Private Key Password
Password for the private key.
— —
Contract Management Web Services Administrator's Guide
44
Setting Name and Description Default Valid Ranges/Values
Web Services/Security/Message
Protection/Encrypt Response
Encrypt outgoing messages. This setting can
be used only when encryption is enabled
for incoming messages.
Note: When the Encrypt Response setting
and the Require Encryption for Incoming
Messages setting are both set to true, the
server encrypts everything inside of the
body element of the Web Services response
messages.
true
Web Services/Apache Jackrabbit
Repository Home. This setting holds the path
on the server where the repository
workspace is kept.
Note: If Contract Management Web
Services is running on the same server as
Contract Management, the value that you
enter as the Repository Home setting must
be different than the value of the Content
Repository/Apache Jackrabbit/Repository
Home setting that is used by Contract
Management.
Using LDAP with Contract Management Web Services on Windows
When using Web SSO (Single Sign On), Contract Management Web Services uses the
same settings as LDAP.
To use SSO with LDAP, edit the startWebLogic.cmd file. Add the following parameter,
separated by a single space, immediately following the -Dcmws.install.home parameter:
-Dcmws.ldap.sslkeystore=/path/to/your/keystore.jks
To disable SSL with LDAP, this parameter needs to be removed from the
startweblogic.cmd \ sh file along with the corresponding settings in the Contract
Management Administration Application relating to the SSL password.