Connect to Paylocity Data as a SQL Server Linked Server

SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect Cloud, linked servers provides instant access to Paylocity data from your SQL Server database. This article demonstrates how to connect to Paylocity using Connect Cloud and query Paylocity data in SQL Server Management Studio (SSMS).

CData Connect Cloud provides a pure SQL Server interface for Paylocity, allowing you to query data from Paylocity without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Paylocity, leveraging server-side processing to return the requested Paylocity data quickly.

Configure Paylocity Connectivity for SQL Server

Connectivity to Paylocity from SQL Linked Servers is made possible through CData Connect Cloud. To work with Paylocity data from SQL Linked Servers, we start by creating and configuring a Paylocity connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "Paylocity" from the Add Connection panel
3. Enter the necessary authentication properties to connect to Paylocity.

   Set the following to establish a connection to Paylocity:

   • RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.

     This property is required for executing Insert and Update statements, and it is not required if the feature is disabled.

   • UseSandbox: Set to true if you are using sandbox account.
   • CustomFieldsCategory: Set this to the Customfields category. This is required when IncludeCustomFields is set to true. The default value for this property is PayrollAndHR.
   • Key: The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. It is the key used to encrypt the content.

     Paylocity will decrypt the AES key using RSA decryption.
     It is an optional property if the IV value not provided, The driver will generate a key internally.

   • IV: The AES IV (base 64 encoded) used when encrypting the content. It is an optional property if the Key value not provided, The driver will generate an IV internally.

   Connect Using OAuth Authentication

   You must use OAuth to authenticate with Paylocity. OAuth requires the authenticating user to interact with Paylocity using the browser. For more information, refer to the OAuth section in the Help documentation.

   The Pay Entry API

   The Pay Entry API is completely separate from the rest of the Paylocity API. It uses a separate Client ID and Secret, and must be explicitly requested from Paylocity for access to be granted for an account. The Pay Entry API allows you to automatically submit payroll information for individual employees, and little else. Due to the extremely limited nature of what is offered by the Pay Entry API, we have elected not to give it a separate schema, but it may be enabled via the UsePayEntryAPI connection property.

   Please be aware that when setting UsePayEntryAPI to true, you may only use the CreatePayEntryImportBatch & MergePayEntryImportBatchgtable stored procedures, the InputTimeEntry table, and the OAuth stored procedures. Attempts to use other features of the product will result in an error. You must also store your OAuthAccessToken separately, which often means setting a different OAuthSettingsLocation when using this connection property.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to Paylocity from SQL Server using Connect Cloud

To establish a connection from SQL Server Linked Server to the CData Connect Cloud Virtual SQL Server API, follow these steps.

1. Open Microsoft SQL Server Management Studio.
2. In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.
3. The New Linked Server dialogue opens. On the General page, enter the following information:
   • Enter a name for the server in the Linked server field.
   • Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
   • In the Data source field, enter tds.cdata.com,14333
   • In the Catalog field, enter enter the Connection Name of the CData Connect Cloud data source you want to connect to (for example, Paylocity1).
4. Select the Security page. At the bottom, select the radio button labeled Be made using this security context and enter the following information:
   • Remote login - enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, test@cdata.com.
   • With password - enter the PAT you generated on the Settings page.
5. Click OK to create the server.
Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.

Execute Queries

You can now execute queries to the Paylocity linked server from any tool that can connect to SQL Server. An example SQL query would be: SELECT * FROM [CDATA CONNECT CLOUD].[Paylocity1].[Paylocity].[Employee] We have successfully created a linked server that allows us to query Paylocity data.

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect Cloud today!