Setting up connectors

Primavera P6 connectors: overview

Modified on Mon, 16 Nov at 8:41 PM

TABLE OF CONTENTS

  1. Introduction
  2. Which P6 do you have?
  3. Web Service or REST API?
  4. Where SchedEx connects from
  5. The P6 user account
  6. Permissions the P6 user needs
  7. Before the first download
  8. Glossary
  9. Related articles

Introduction

SchedEx can exchange schedules directly with Oracle Primavera P6 EPPM. To do that, you create a connector: the SchedEx object that knows how to reach your P6.

This overview helps you get ready. It explains which P6 connector to choose, and which P6 user account and permissions SchedEx needs. The step-by-step instructions are in two separate articles, one for each connector type:


1. Which P6 do you have?

Oracle sells Primavera P6 in two main editions:

Edition What it is How SchedEx connects
P6 EPPM (Enterprise Project Portfolio Management) The shared server or cloud edition. People open it in a web browser. A Primavera P6 Web Service or Primavera P6 REST API connector.
P6 Professional A desktop program installed on one PC. Export an XER file and use a Primavera P6 XER File connector instead.

Both live connectors need P6 EPPM. The Web Services and the REST API are parts of P6 EPPM that your organization must have installed and switched on. Your P6 administrator knows whether you have them.

Tip: If people in your organization open P6 in a web browser, you most likely use P6 EPPM. If they open a program on their own PC, you most likely use P6 Professional.


2. Web Service or REST API?

Both connector types move the same data: projects, activities, relationships, resources, resource assignments, calendars, WBS, activity codes and user-defined fields. The difference is how SchedEx talks to P6 and how it signs in.

Primavera P6 Web Service Primavera P6 REST API
P6 interface The original interface The newer interface
Sign-in with user name and password UserNameTokenProfile Basic Authentication or OAuth Token API
Sign-in without a password Federated Authentication (single sign-on, desktop client only) OAuth 2.0 (Microsoft sign-in, desktop client only)
Automatic transfers (Autonomous Component) Yes, with UserNameTokenProfile Yes, with Basic Authentication or OAuth Token API
Message encryption Available, if your P6 server requires it Not used
Database Instance setting Yes No
Setup A little more, especially with message encryption Simpler

Which should I choose?

  • Use the one your P6 administrator has switched on.
  • If both are available, choose the REST API. It is Oracle's newer interface and is simpler to set up.
  • Choose the Web Service if your P6 server requires message encryption, or if you want to sign in with your organization's single sign-on in the desktop client.
  • If transfers must run automatically, without a person at a PC, you need the Autonomous Component. Both connector types support it with a user name and password.

Then follow the article for your choice:


3. Where SchedEx connects from

SchedEx does not connect to P6 from the SchedEx cloud. It connects directly from the SchedEx program that runs the transfer:

SchedEx program Where it runs What that means for P6
Desktop Client On a user's PC. Someone must be signed in. P6 must be reachable from that PC, for example over the company network or VPN.
Autonomous Component On a server, without a person. Used for automatic transfers. P6 must be reachable from that server.

SchedEx uses the computer's normal network and proxy settings. There is no separate proxy setting in SchedEx.


4. The P6 user account

SchedEx signs in to P6 as a normal P6 user. It can only see and change what that user is allowed to see and change.

  • Use a dedicated service account for SchedEx (for example svc_schedex) instead of a person's own account. A service account keeps working when someone changes job.
  • Ask for a password that does not expire, or note when it does. When the password changes, edit the connector in SchedEx and enter the new one. Nothing needs to change on users' PCs: SchedEx gives the sign-in details to the desktop client and the Autonomous Component each time they run.
  • Limit what the user can see to the projects SchedEx exchanges. This is safer, and it makes persist faster, because persist reads every project the user can see.

5. Permissions the P6 user needs

If a permission is missing, the connection test can pass but a transfer fails later. Show this section to your P6 administrator. The exact permission names in P6 vary a little between versions, but your administrator will know which security profile matches.

Every P6 connector

  • Module access to the P6 interface you use: P6 EPPM Web Services for a Web Service connector, or the P6 REST API for a REST API connector.
  • Access to the projects that SchedEx exchanges, given through the OBS and a project security profile (see the Glossary).

If the connector only sends data (upload)

When SchedEx sends a schedule to a partner, it only reads from P6. The user needs permission to view:

  • the projects,
  • activities, relationships and resource assignments,
  • WBS, activity codes, project codes and user-defined fields,
  • resources and calendars.

If the connector also receives data (download)

When SchedEx writes a partner's schedule into your P6 project, it creates, changes and deletes data in that project. The user's project security profile must allow it to:

In P6 What SchedEx does
Project details and project user-defined field values Changes them
Activities Adds, changes and deletes them
Relationships (links between activities) Adds, changes and deletes them
Resource assignments Adds, changes and deletes them
WBS Adds and changes WBS elements
Activity codes Adds project activity code types and codes, and assigns codes to activities
Activity user-defined field values Adds and changes them
Calendars Adds and changes calendars

Two extra global permissions are needed only when the matching options are switched on for the Exchange Agreement:

  • Add and edit resources, if SchedEx may add new resources to P6.
  • Add and edit global calendars, if SchedEx may add calendars to the global calendar list.

6. Before the first download

SchedEx does not create these in P6. They must exist before the first time SchedEx writes into P6:

  • The P6 project. Create it in P6 first. Otherwise the transfer fails with The project with ID … could not be found or read from the service.
  • User-defined fields. Every P6 user-defined field that is mapped in the Config must already be defined in P6.

7. Glossary

Term Meaning
Autonomous Component A SchedEx service that runs on a server and performs transfers automatically, without a person.
Azure Key Vault A secure storage service in Microsoft Azure for certificates, passwords and keys.
Base URL The web address SchedEx uses to reach P6.
Certificate A digital key used to encrypt and protect information.
Connector The SchedEx object that knows how to reach one planning system.
Desktop Client The SchedEx program that runs on a user's PC.
EPS Enterprise Project Structure. How P6 organizes projects in a hierarchy.
Federated Authentication Signing in through your organization's identity provider (single sign-on) instead of a P6 password.
HTTPS The standard secure connection used on the web. The address starts with https://.
Message encryption An extra layer of protection for the Web Service connector, where each message to P6 is encrypted with P6's certificate. Only some P6 servers require it.
Microsoft Entra ID Microsoft's sign-in service for work accounts (formerly Azure Active Directory).
Module access The P6 setting that decides which parts of P6 a user may use, for example Web Services or the REST API.
OBS Organizational Breakdown Structure. P6 uses it to decide which users can see which projects.
P6 EPPM Primavera P6 Enterprise Project Portfolio Management. The server or cloud edition of P6.
Persist Reading the list of projects and their field setup from P6 into SchedEx, so they can be used in Configs.
Project security profile A set of P6 permissions that decides what a user may do inside a project.
Service account A user account made for a system, such as SchedEx, rather than for a person.
User-defined field (UDF) A custom field your organization has added in P6.
WBS Work Breakdown Structure. How activities are grouped inside a P6 project.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article