Setting up connectors

Creating a Primavera P6 XER file connector

Modified on Tue, 17 Nov at 12:02 AM

TABLE OF CONTENTS

  1. Introduction
  2. At a glance
  3. What to ask your IT administrator for
  4. Open the connector wizard
  5. Step 1: General
  6. Step 2: Components
  7. Step 3: Storage and sign-in: Web Storage · SharePoint · Local File
  8. Step 4: Complete, test and persist
  9. How files are added, and file rules: Web Storage · SharePoint and Local File
  10. Messages and what to do
  11. Questions and answers
  12. Related articles

Introduction

This article shows you, step by step, how to create a Primavera P6 XER File connector. This connector lets SchedEx exchange Primavera P6 schedules as XER files (.xer), the file format P6 uses to export and import projects.

An XER connector sends and receives:

  • Sending: you export a project from P6 as a .xer file, and SchedEx sends its data to a partner.
  • Receiving: SchedEx writes a partner's schedule into a new .xer file, which you import into P6.

This article is about creating the connector. How to send and receive the files day to day is described in Primavera P6 XER file transfers.

Who can do this: a user with the Tenant Setup role in SchedEx.

You do not need to be technical. You only need to decide where the files are kept. If they are kept in SharePoint, section 2 lists what to ask your IT department for.

XER file or a live P6 connection? Use an XER connector if you work in P6 Professional (a program on your PC), or if you cannot connect SchedEx to your P6 directly. If you use P6 EPPM (P6 in a web browser), a live connector is usually better. See Primavera P6 connectors: overview. Not sure where to keep the files? Read Choosing where your schedule files are stored.


1. At a glance

Creating the connector takes about five minutes.

  1. Decide where the .xer files will be kept (section 6).
  2. Ask your IT department for the SharePoint values, if you choose SharePoint (section 2).
  3. Fill in the four-step wizard in SchedEx (sections 3 to 6).
  4. Test the connector, and create its schedules (section 7).

Which storage type? Pick one, then jump straight to its parts of this article. The other storage types' sections can be skipped.

Storage type In plain words Set it up in the wizard How files are added After saving
Web Storage (files) People upload the files on the SchedEx Files page, and download received ones there. No IT setup. The default, and the right choice for most organizations. Option A Web Storage (files) Create the schedules
SharePoint SchedEx reads and writes the files in a SharePoint folder. Needs IT setup. Option B. IT setup: Connecting SchedEx to SharePoint SharePoint and Local File Test and persist
Local File SchedEx reads and writes the files in a folder on the PC or server that runs the transfer. Option C SharePoint and Local File Test and persist

The full comparison is in Choosing where your schedule files are stored.

Checklist before you open the wizard:

  • I know which storage type to use.
  • I know whether transfers run on a person's PC (Desktop Client), on a server (Autonomous Component), or both.
  • Web storage only: my organization has no XER web storage connector for that component yet. (Only one is allowed.)
  • SharePoint only: I have the folder's SharePoint address, the Client ID and the Tenant ID from IT.
  • Local File only: I have the folder path.
  • I have a sample .xer file exported from P6, with every user-defined field and activity code I want to map.

2. What to ask your IT administrator for

With Web Storage (files) you need nothing from IT. Skip to section 3.

With SharePoint or Local File, ask your IT department or SharePoint administrator for the items below. Tell them whether SchedEx will work from users' PCs (Desktop Client), from a server (Autonomous Component), or both, and whether SchedEx will only read files (send) or also write them (receive).

Ask for Why SchedEx needs it Where it goes
Only if SharePoint: the address of the SharePoint folder for the .xer files. So SchedEx knows where to read and write. Step 3: SharePoint URL
Only if SharePoint: the Application (client) ID of the Microsoft Entra ID app registered for SchedEx. SchedEx signs in to SharePoint through this app. Step 3: Microsoft Entra ID Client ID (For SharePoint)
Only if SharePoint: your organization's Tenant ID in Microsoft Entra ID. Tells Microsoft which organization to sign in to. Step 3: Microsoft Entra Tenant Id (For SharePoint)
Only if SharePoint: access for the app to the SharePoint site: read access to send, write access to receive. Share Configure-SharePoint-Access with them. Without it, SchedEx cannot see the folder. Set up in Microsoft Entra ID and SharePoint by IT
Only if SharePoint and the Autonomous Component: the app's certificate installed on the Autonomous Component's server. The Autonomous Component signs in with the certificate, without a person. Set up on the server by IT
Only if SharePoint and the Desktop Client: access to the SharePoint folder for each person who runs transfers. In the Desktop Client, SchedEx works in SharePoint as the signed-in person. Set up in SharePoint by IT
Only if Local File: the folder path, and read access (plus write access to receive) for users' PCs or for the Autonomous Component's server. SchedEx works in the folder from the computer that runs the transfer. Step 3: File System Root Folder Path

No password is stored: with SharePoint, SchedEx signs in with a Microsoft account, and with Web Storage or Local File no sign-in is needed, so this connector stores no password or secret. Read how SchedEx protects the credentials of other connectors in Checking your connectors.


3. Open the connector wizard

  1. Select Setup in the top menu.
  2. On the Connector List card, select New Connector.

The Setup page with the New Connector button on the Connector List card The Setup page. New Connector is on the Connector List card.

The New Connector wizard opens on the right. It has four steps: General, Components, Authentication and Complete. Every field has an ⓘ icon. Point at it to see a short help text. Next stays grey until every required field on the step is filled in.


4. Step 1: General

Field What to enter
Connector Name (required) A name that tells your colleagues what this is, for example P6 XER - Web storage. The name is shown everywhere the connector is used, such as in Configs and Exchange Agreements.
Host System (required) Select Primavera P6 XER File. Scroll down the list of host systems to find it.
Import from existing (optional) Copies the settings of a connector you already have, so that you only change what is different.

Step 1 of the wizard with the Primavera P6 XER File card selected Step 1, scrolled down: the Primavera P6 XER File card selected.

Select Next.


5. Step 2: Components

An execution component is the SchedEx program that runs the transfer and reads or writes the files.

Option What it means Choose it when
Desktop Client The SchedEx desktop program on a user's PC. Someone must be signed in to start a transfer. People start transfers by hand.
Autonomous Component A SchedEx service that runs on a server, without a person. Transfers must run automatically on a schedule.

You can select both. The connector then gets one sign-in profile for each component. With SharePoint, you fill in both in the next step. The storage type, the SharePoint address and the folder path are the same for both.

Step 2 with both components selected Step 2 with both components selected.

Select Next.


6. Step 3: Storage and sign-in

The step is called Authentication. At the top, under Authentication profiles, you see one tab for each component you selected in Step 2. Then choose the Storage Type. The fields below it change to match your choice.

Storage Type You enter Desktop Client Autonomous Component
Web Storage (files) Nothing Yes Yes
SharePoint Authentication Method, SharePoint URL, Client ID and Tenant ID Yes, with Microsoft sign-in Yes, with a certificate
Local File File System Root Folder Path Yes Yes

Option A: Web Storage (files)

Select Web Storage (files). This is selected by default. There is nothing else to fill in, and the Authentication Method list is hidden.

Step 3 with Web Storage (files) selected Web Storage (files): no further fields.

Only one XER web storage connector per component. If your organization already has one for this component, Web Storage (files) is greyed out and SharePoint is selected instead. Point at the button to see why: A Web Storage connector already exists for Desktop Client (…). Only one Web Storage connector per type and execution component is allowed. Use the existing connector: one web storage connector can hold many schedules, one for each .xer file.

Done with this storage type? Skip the other options and go to Step 4: Complete, test and persist.

Option B: SharePoint

Before you start: your IT department must have set up SharePoint access for SchedEx. What they need to do, which addresses work and how SchedEx signs in are explained in Connecting SchedEx to SharePoint. This section only covers the fields in this wizard.

Select SharePoint. Then fill in the fields below. If you selected both components, fill in the Authentication Method, Client ID and Tenant ID on each tab.

Step 3 with SharePoint selected on the Desktop Client tab SharePoint on the Desktop Client tab.

Field What it means Example
Authentication Method (required) How SchedEx signs in to SharePoint. The list only offers the method that works for the tab you are on. See below.
SharePoint URL (required) The address of the SharePoint folder for the .xer files. A site address uses that site's default document library. To use another library or folder, open it in SharePoint and copy the address from the browser address bar. The folder must already exist. https://contoso.sharepoint.com/sites/projects/XER
Microsoft Entra ID Client ID (For SharePoint) (required) The Application (client) ID of the app that SchedEx uses for SharePoint. Found in the Azure portal under App registrations → your app. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Microsoft Entra Tenant Id (For SharePoint) (required) Your organization's Tenant ID. Found in the Azure portal under Microsoft Entra ID → Overview. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Authentication methods:

Method Tab What happens
Microsoft Entra ID (Interactive) Desktop Client The first time the connector runs, a browser window opens. The user signs in with their Microsoft work account. SchedEx then works in SharePoint as that user.
Microsoft Entra ID App Certificate (SharePoint) Autonomous Component The Autonomous Component signs in on its own, with the certificate that IT installed on its server. No person is needed.

When you save, SchedEx checks the SharePoint address. If it ends in what looks like a file name, for example .../XER/PROJ-1042.xer, it asks Is that a file or a folder?. SchedEx always works in a folder. Select Use this folder to save the folder's address, or Keep what I entered if the name really is a folder.

Done with this storage type? Skip the other options and go to Step 4: Complete, test and persist.

Option C: Local File

Select Local File. Then fill in one field.

Step 3 with Local File selected Local File: the folder path.

Field What it means Example
File System Root Folder Path (required) The folder for the .xer files. Use a full path. The folder is used on the PC or server that runs the transfer, so the path must work there. You can use %USERPROFILE% for a folder that OneDrive keeps in sync on each PC. \\fileserver\Schedules\XER

Select Create Connector when all required fields are filled in. This connector type has no Settings step.


7. Step 4: Complete, test and persist

The last step confirms that the connector is saved. Select View Connector to open it, or Close.

What happens next depends on the storage type.

Web Storage (files): create the schedules

A web storage connector does not search for files, so there is no Persist. Instead, create one schedule for each P6 project you will exchange:

  1. Open the connector, open its menu and select New XER File. (You can also do this on Files

    Schedules & Templates.)

  2. Select a sample .xer file exported from P6. SchedEx registers a new schedule under the file's name, together with its fields. PROJ-1042.xer becomes the schedule PROJ-1042.
  3. When it finishes you see XER file uploaded. Schedule "…" created with … host fields.

The sample file decides which fields you can map. SchedEx reads the user-defined fields and activity codes from it, not the activities. Use a file that carries every field you want to map. To refresh the fields later, use Update File on that schedule.

You can also run Test in the Desktop Client. For web storage it only confirms the setting, and shows Web storage configured.

The Next Steps list on the Complete step may still mention Persist. For a web storage connector, use New XER File instead.

SharePoint or Local File: test and persist

Both run from the SchedEx desktop client, on a PC that can reach the folder:

  1. Test the connector. In the desktop client, open Connectors and select Test on the connector's row. With SharePoint, a Microsoft sign-in window may open.
    • Connected means the folder and the sign-in work.
    • Test Failed: followed by a message means something is wrong. See section 9.
  2. Persist the connector. Select Persist on the same row. SchedEx reads every .xer file in the folder and creates one schedule for each, named after the file. It also reads each file's user-defined fields and activity codes, so that you can map them in Configs. A file that cannot be read is skipped. When it finishes you see Host System data stored successfully!

Persist again whenever you add a new .xer file to the folder, or its fields change.

If transfers run on the Autonomous Component

A test in the desktop client runs from your PC. It proves that your PC can reach the folder, not that the Autonomous Component's server can. To check the server:

  • Persist from the server (SharePoint and Local File only). In the SchedEx web app, open Setup > Connectors, open the connector and select Persist Within 3 Minutes. The Autonomous Component picks up the request and reads the folder itself.
  • Ask a Tenant Admin to check the dashboard. In Clients > Autonomous Component > Dashboard, the Connectors panel shows each connector's health and its latest persist. The connector should be Healthy. If it is Unhealthy, point at the error icon to see why. See Reading the Autonomous Component Dashboard.

Check the connector later

In the web app, Setup > Connectors shows every connector's Status and Last Health Check. A connector that has not been checked for more than 7 days is marked as such: run Test again to refresh it.

More about testing and persisting: Testing and Persisting a Connector.


8. How files are added, and file rules

Web Storage (files)

The day-to-day flow is described in full in Primavera P6 XER file transfers. In short:

  • Sending: export the project from P6 as a .xer file. Open Files > Upload Files and drop the file on the tab. The next Data Transfer sends it.
  • The file name must match the schedule. The name before .xer must be exactly the schedule's name. Upper and lower case do not matter; everything else must match.
  • Receiving: after a transfer, download the produced .xer file from Files > Receiver Files, and import it into P6.
  • One file per schedule. A new upload replaces the previous file for every Exchange Agreement that sends from that schedule.

SharePoint and Local File

  • Sending: export the project from P6 as a .xer file and save it into the folder. The file name is the schedule: PROJ-1042.xer becomes the schedule PROJ-1042. Persist again after you add a new file.
  • Replacing a file: save the new export under the same name. The next transfer reads it.
  • Receiving: SchedEx writes a new .xer file into the same folder, named after the schedule. Import it into P6.
  • Use separate folders for sending and receiving. A received file is saved under the schedule's name, so it could replace a file with the same name that you placed there to send.
  • Only the folder itself. SchedEx does not look in subfolders.

Every storage type

Rule Detail
Format Primavera P6 XER files with the .xer extension, exported from P6. The file must start with P6's header line (ERMHDR). Do not rename other files to .xer or edit the top of the file.
Version SchedEx targets the current P6 XER format (version 25.0). Very old files may be refused. Export again from a current P6.
One project per file SchedEx reads one P6 project from each .xer file. If a file holds several projects, only the first is read.
Size (web storage) Up to 100 MB per file.
Direction Send and receive.

9. Messages and what to do

While you fill in the wizard or save

Message What it means What to do
A Web Storage connector already exists for … Only one Web Storage connector per type and execution component is allowed. Tooltip on the greyed-out Web Storage (files) button. Use the existing XER web storage connector, or choose SharePoint or Local File.
SharePoint URL is required The SharePoint URL is empty. Paste the folder's address.
Enter a complete address starting with https:// The address is not complete, or starts with http://. Copy the address again from the browser's address bar.
OneDrive addresses are not supported. Use a SharePoint document library or folder. You pasted a OneDrive address. Use a SharePoint library address.
That address is not on SharePoint Online… The address does not end in .sharepoint.com. Use your organization's SharePoint Online address.
Sharing links cannot be used. Open the folder in SharePoint and copy the address from the browser address bar. You pasted a sharing link. Open the folder and copy the address bar instead.
SharePoint Client ID is required / SharePoint Tenant ID is required One of the two IDs is empty on one of the tabs. Fill in both, on each tab.
File system root folder path is required when using local file path File System Root Folder Path is empty. Enter the folder path.
Is that a file or a folder? The SharePoint address seems to end in a file name. Select Use this folder, or Keep what I entered if it really is a folder.
A connector with this URL or path already exists. Please update the URL or path and try saving again. Another XER connector already uses this SharePoint address or folder. Use the existing connector, or a different folder.

When you test, persist, upload or transfer

Message What it means What to do
Web storage configured. The web storage connector is set up correctly. Nothing. Create schedules with New XER File.
We couldn't find the selected directory. Please verify that it exists and is accessible. Local File: the path does not exist on this PC or server. Check the path, and that the network drive is connected.
We couldn't read from the selected directory because the app doesn't have permission… Local File: no read permission. Ask IT to give access to the user or the Autonomous Component's account.
You or this application do not have access to … SharePoint refused access to the user or to the app. Ask IT to check the app's site access and the user's permissions.
The configured folder '…' does not exist in this document library… The folder was renamed, moved or deleted. Open the folder in SharePoint and copy its address again.
Success. The saved SharePoint address ends with the file name '…'… The test worked, but the saved address names a file. SchedEx used the folder. Edit the connector and save the folder's address to remove the warning.
Only .xer files are supported for XER source uploads. Web storage: the file is not a .xer file. Export the project from P6 as an XER file.
Invalid XER file. File content is empty. The file is empty. Export again from P6, and check that the export finished.
Invalid XER file. Missing ERMHDR header marker. The file is not a real P6 export. Export again from P6. Do not rename other files to .xer.
A message that the uploaded file does not match the schedule selected for the Exchange Agreement Web storage: the file name does not match the schedule of the Exchange Agreement. Rename the file to the schedule's name plus .xer.

10. Questions and answers

Do I need P6 EPPM? No. An XER connector works with any P6 that can export and import XER files, including P6 Professional. SchedEx never connects to P6 itself.

Can one connector handle several P6 projects? Yes. Each .xer file is its own schedule. With web storage, add one schedule per file with New XER File. With SharePoint or Local File, put the files in the folder and Persist.

Why is there no Persist button for my web storage connector? With web storage, schedules are created from the files you upload with New XER File. There is no folder to read.

I received a file. How do I get it into P6? Download it (web storage) or open the folder (SharePoint, Local File), then import the .xer file into P6. What to expect is described in Primavera P6 XER file transfers.

Can I change the storage type later? Yes. Edit the connector and choose another storage type. Then test again, and create the schedules again (Persist, or New XER File for web storage). Check your Configs and Exchange Agreements afterwards.


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