How to setup connector for P6

Modified on Fri, 22 Aug at 3:05 PM

TABLE OF CONTENTS


Introduction

This article will guide you through creating a connector for P6 and show you how to use different authentication methods. 


 

Prerequisites

Before setting up the connector, make sure you have the following:

  • Setup Admin access to the IDE web application.

  • Desktop client and/or Autonomous component should be installed in your tenant.

  • Required authentication details (provided by Tenant Admin).
     

How to Create the Connector

  1. Log in to the IDE web app and go to Setup > Connectors.

  2. Click + New Connector.

  3. Fill out the fields in the modal:

    • Title: Provide a clear and descriptive name.

    • Host System: Select "Primavera P6"

    • Execution Component: Choose between Desktop Client or Autonomous Component.

      • Once you select the host system and execution component, the form will update with required fields based on your selection. The following fields will always be requested:

        • Authentication Type (differs based on execution component).

        • URL (to WebService/REST API - must be unique across Connectors)

        • Message Security (Use Encryption checkbox)

        • <Additional Configurations for P6> (see chapter below)

  4. Click Create after filling in all required fields


Note: Each connector must have a unique combination of URL (to WebService/REST API).


Execution Components and Authentication Types

Desktop Client or Autonomous Component and UserNameTokenProfile

These inputs are required 


Desktop Client and Federated Authentication (SAML 2.0) 

This option is used for SSO-enabled (Single SignOn) setups.
NO OTHER FIELDS NEED TO BE FILLED OUT HERE!

 


 Additional Configurations for P6:

There are some additional settings you can do for P6 and they are shown with the red numbers and described below:



Description for additional Fields

1Use encryptionThis setting is default unchecked, the setting should reflect what’s configured on the P6 server. Refer to your tenant admin for this setting.
2Activity Retrieval Batch Size
Optional. Number of activities to retrieve per batch. The information icon gives this guideline: If your schedule has more than 50k activities, we highly recommend specifying a batch size. Use batch size like 10000.
3Activity Write Batch Size
Number of activities to create/modify per batch. The default recommended setting is 500.
4Include project level activity codes
Control if you need to retrieve Project specific Activity Codes. Default is false for a good reason: As each project will be allowed to have their own userfields (instead of the global set), turning this on will restrict reusability of configs from all schedules to one per schedule!
If this is turned on the codeset id column will have values and if turned off then it would be blank.
5Manage Custom Request Headers
This allows custom headers to be configured by adding Key-Value pairs in case this should be needed. The list of Key-Value pairs is edited when pressing the button.
NOTE: Currently only Safran had a use case for this feature
.



Parameters for setting up Message Security Encryption

See red number (1) in previous screenshot.

If the executing component is "Desktop" then you will see this form:


Otherwise, you will see this form:


Test & Persist

After creating the connector:

  • For Desktop Client execution:

    • Open the IDE Desktop Client

    • Navigate to the Connectors tab

    • Click Test to verify connection

    • Click Persist to fetch schedules and host fields from P6

  • For Autonomous Component execution:

    • Test is done periodically via a background job, but it can be also done using desktop client.

    • Alternatively: Go to Setup > Connectors in the web app, and open the newly created connector and click Persist to force retrieval of schedules and host fields from P6. After persisting, reload the page after a few minutes to verify the updated connector status. 

Checkout this article to find out more about test & persist

"

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