Use the CData ODBC Driver for Paylocity from SharePoint Excel Services

The CData ODBC Driver for Paylocity can be accessed using the built-in data access tools in Excel. This article demonstrates how to use the CData ODBC Driver for Paylocity to connect to Paylocity data from Excel spreadsheets in on-premises editions of SharePoint.

Connect to Paylocity as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Configure Excel Services

Once the ODBC DSN is configured, you can configure Excel Services to use the DSN to connect. To do this, you will need to set up the OLE DB provider as a trusted data source. You will also want to decide if you want to use a Secure Store Service to enable single sign-on functionality with the ODBC driver. If you prefer, you can use the Excel Services Unattended account and skip to step 3 below.

1. First, set up a secure store application to use single sign-on. In SharePoint Central Administration, go to Application Management -> Manage Service Applications. Select your secure store service application or create a new one. Click Manage on the Edit menu to begin editing the application.
2. Create a new target application. You will be able to set the list of users who have access to this application. After the application is created, you will need to set the credentials on the application so that you can use this later for single sign-on.
3. Navigate to Application Management -> Manage Service Applications in SharePoint Central Administration. Select the Excel Services application used by your organization or create one if it does not already exist. Click Manage. If you create a new app, check the option to add the service application's proxy to the farm's default proxy list.
4. Click on Trusted Data Providers and add a new trusted provider. Set 'MSDASQL.1' for the Provider ID and leave the type as 'OLE DB'. Click OK to add this new provider to the list of trusted providers. 👁 The OLE DB provider configured as a trusted provider.
   

Connect to and Import Paylocity Data in Excel

After you have enabled and secured access to the DSN, you can access the data source from the ribbon in Excel.

1. In an Excel spreadsheet, open the Data tab and click From Other Sources -> From Data Connection Wizard.
2. Select 'Other/Advanced' for the type and on the next screen, select the 'Microsoft OLE DB Provider for ODBC Drivers'. On the Connection tab, select CData Paylocity Sys, the system DSN. The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from SharePoint. 👁 The DSN to connect to. (Salesforce is shown.)
   
3. Select the table you would like to connect to.
4. On the last step of the wizard, click the 'Authentication Settings' button. Select the 'Use a stored account' and enter the name of the secure store target application you created earlier. Or, if you want to use the Unattended Service Account, select None. 👁 The name of the secure store target application.
   
5. After you finish the wizard, the data is imported into the spreadsheet. You can now update and save Paylocity data directly in SharePoint. 👁 Data imported into the spreadsheet from the ODBC data source.