Deploy the ADO.NET Provider for Paylocity on an SSRS Report Server

In this article, we will guide you through the deployment process of the CData ADO.NET Provider for Paylocity on an SQL Server Reporting Services (SSRS) report server. Additionally, you will learn how to establish a shared data source, which facilitates connectivity to real-time Paylocity data from various reports. You can then access these shared data sources from the Report Designer within Visual Studio. For detailed instructions on creating datasets in Report Designer using ADO.NET, please refer to the "Using ADO.NET" section in the help documentation.

Deploy the ADO.NET Provider

The provider installation automatically deploys the provider on report servers in native mode. On report servers in SharePoint mode, you can use the install-sprs.ps1 PowerShell script to deploy. Simply run the script from the lib subfolder in the installation directory, or pass in the "path" parameter.

Create a Shared Data Source for Paylocity

You can create shared data sources directly from a report server or SharePoint site. Alternatively, you can use Report Designer to create shared data sources.

Report Designer

You can use Report Designer to create shared data sources on native mode report servers and report servers on a SharePoint server farm.

1. In a Report Server Project in Visual Studio, right-click Shared Data Sources in Solution Explorer and click Add New Data Source.
2. Enter a name for the data source and in the Type menu select CData Paylocity Report.
3. In the Connection String box, enter the connection string to connect to Paylocity. A typical connection string is below: OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

   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.

   When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

4. Set the folder and server URL in your project properties. If you are publishing to SharePoint, the values for all properties must be fully qualified URLs. For example:
   • Report Server: http://MyServerName/ReportServer
   • SharePoint: http://MyServerName/MySite/MySubsite
5. Right-click the shared data source and click Deploy.

Report Manager

On native mode installations of report server, you can use Report Manager to create shared data sources. You must have permissions to manage data sources on the report server.

1. From the Home page in Report Manager, click New Data Source. The New Data Source page is displayed.
2. Enter a name for the data source and in the Data Source Type menu, select CData Paylocity Report.
3. In the Connection String box, enter the connection string to connect to Paylocity. A typical connection string is below: OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

   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.

SharePoint

Follow the steps below to create a shared data source on a SharePoint site. Note that this step has the following prerequisites in SharePoint 2013:

• The Reporting Services add-in for SharePoint
• The Report Server Integration site collection feature

Follow the steps below to add the report server content types to your library:

1. Log into SharePoint and open the library where you want to save the .rsds file.
2. Click Library on the ribbon and then click Library Settings.
3. In the General Settings section, click Advanced Settings.
4. In the Content Types section, select Yes to allow the management of content types. The Content Types section is added to the Library Settings page.
5. On the Library Settings page, click Add from existing site content types.
6. In the Available Site Content Types list, select Report Data Source and click Add.

You can then create the shared data source. You will create an .rsds file that contains the connection information to Paylocity.

1. Log into SharePoint and open the library where you want to save the .rsds file.
2. On the ribbon click Documents -> New Document -> Report Data Source.
3. Enter a name for the data source.
4. In the Data Source Type menu, select CData Paylocity Report.
5. In the Connection String box, enter the connection string to connect to Paylocity. A typical connection string is below: OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

   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.