Setup a REST ADP Connection Manager

The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with ADP REST service to help facilitate ADP data integration.

See ADP REST Source Component for how to retrieve data from ADP & ADP REST Destination Component for how to write to ADP.

To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "REST (KingswaySoft)" item to add a new REST Connection Manager.

New SSIS Connection

Add SSIS REST Connection Manager

The REST Connection Manager contains 2 pages of configuration.

  • General
  • Advanced

General page

The General page allows you to specify connection properties and login credentials for ADP REST service:

SSIS REST ADP Connection Manager

Service Name

The REST service that will be connected to. 

Environment

The Environment that the component will connect to, either Production or Staging.  Other ADP Server settings will be automatically set to appropriate default value when the environment is set, but these values can be changed.

Token Server URL

The Token Server URL to use when getting ADP authentication tokens.

Use Authorization Header

Use Authorization Header determines if an authorization header should be sent when getting an ADP API token.

API Base URL

The API Base URL to use when making API requests. 

API Throttle Rate

The API Throttle Rate will limit the number of requests that can be sent per second.

ADP Authentication
Client ID

The Client ID that will be used to generate authorization tokens.  ADP Client ID, Client Secret and Certificate with appropriate scope are required and can be obtained from ADP by contacting your ADP representative as described in the following documents:
https://developers.adp.com/articles/guides/build-app-core-library-Nodejs
https://developers.adp.com/articles/guides/auth-process-data-connector-apps

Client Secret

The Client Secret that will be used to generate authorization tokens.

Certificate Location

The location of the certificate used to generate authorization tokens.  This can be either the file system, or the Windows Certificate Store. Certificates should be of the PFX type.

Certificate Subject

The Certificate Subject for certificates in the Windows Certificate Store.

Path to Certificate

The Path to Certificate for certificates stored on the file system.

Certificate Password

The Certificate Password which is used to access the certificate.

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced page

REST Connection Manager - Advanced

Proxy Mode

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

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

Using Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

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

Username (Proxy Server Authentication)

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

Password (Proxy Server Authentication)

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.

Timeout

The number of seconds requests should wait before timing out.

Retry on Intermittent Errors

The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.