Using the Project Server Connection Manager

The Project Server Connection Manager is an SSIS connection manager component that can be used to establish connections with Microsoft Project Server.

To add a Project Server connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu.

new connection

You will be prompted the "Add SSIS Connection Manager" window. Select the "ProjectServer" item to add the new Project Server Connection Manager.

Add Project Server connection

The Project Server Connection Manager contains the following three pages, which configure how you want to connect to Project Server:

  • General
  • Advanced Settings
  • More Info

General Page

The General page on the Project Server Connection Manager allows you to specify general settings for the connection.

Project Server Connection Manager

Server Information
Authentication Type

The Authentication Type option allows you to specify the deployment type of your Project Server and the authentication it uses. There are three options available:

  • Active Directory (On-Premises)
  • Federation (Claim-based Authentication)
  • Online Federation (Office 365, Project Server Online)
  • Azure AD OAuth Authorization Code (Office 365, Project Server Online) (Since v26.1)
Service URL

Using the Service URL option, you can provide an alternative Project Server web service URL, which you may have set up in a way that's different from the default.

Authorization Server (URL)

Using the Authorization Server (URL) option, you can provide an alternative region-specific base Azure AD authorization server endpoint.

Home Realm URI

This option applies to the Federation and Online Federation authentication types, and it may only be required for certain federated environments. It’s important to note that the Home Realm URI option is case-sensitive. In the case that this option is required, it should typically be in the following format.

Note that the Home Realm URI option is case-sensitive.
Authentication
Use Integrated Authentication

This checkbox specifies whether you want to use Integration Authentication or provide separate login credentials. This option is only available when using Active Directory (On-Premises) Authentication Type.

User Name

The User Name option allows you to specify the user account that you want to use to connect to Project Server. Depending on how the SharePoint connection is used, the user account needs to have proper privileges in your Project Server system.

Password

The Password option allows you to specify the password for the above user account in order to log in to Project Server.

Note: The Password is not included in the Project Server connection manager's ConnectionString property by default. This is done by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be Password=myPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Domain

The Domain option allows you to specify the domain (e.g., Active Directory) of the above user account.

Generate Token File... (Only available for Azure AD OAuth authentication type) (Since v26.1) 

Click on this button to open up the OAuth token generation window.

Project Server Connection Manager Azure AD OAuth

OAuth Configuration & Sign in
Project Server OAuth token generation
App Info
Tenant ID

The Tenant ID allows you to specify a valid tenant ID detail.

Client ID

The Client ID option allows you to specify the GUID value that identifies a client application in Microsoft Application Registration Portal. Note that you need to register your application via this portal in order to generate your Client ID.

Client Secret

The Client Secret option allows you to specify the client secret that you have requested from Microsoft Application Registration Portal

Scope

The Scope option allows you to specify the permissions required to be assigned to the token.

Redirect URI

The Redirect URI option allows you to specify the Redirect URL to complete the authentication process.

Sign In & Authorize
Use Default Browser to Sign In

When this option is checked, the Sign In and Authorize button will open your default web browser in order to complete the authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire authentication process inside the toolkit.

Sign In and Authorize

This button allows you to log in to the service endpoint and authorize your app to generate a token.

Password

This option allows you to assign a new password for the token file which will be created.

Save To Token File

This option allows you to specify the location where the token file will be saved.

Path to Token File

This option allows you to specify the path to the token file on the file system. Now, you can work with the SAS URL as well, for the token file path.

Token File Password

This option allows you to specify the password of the selected token file.

Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

Test Connection

After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.

Advanced Settings Page

The Advanced Settings page on the Project Server Connection Manager allows you to specify some advanced and optional settings for the connection.

Project Server Connection Manager - Advanced Settings

Proxy Server Settings
Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server settings. There are three options available.

  • No Proxy
  • Auto-detect (Using system-configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option, you can provide a proxy server to connect to Project Server.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Server Certificate Errors
Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure, such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

More Info Page

The More Info page shows some basic information about the toolkit. On this page, you can find the version information of the toolkit.

Project Server Connection Manager