Build Paylocity-Connected Visualizations in datapine

datapine is a browser-based business intelligence platform. When paired with the CData Connect Cloud, you get access to your Paylocity data directly from your datapine visualizations and dashboards. This article describes connecting to Paylocity in CData Connect Cloud and building a simple Paylocity-connected visualization in datapine.

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 datapine

Connectivity to Paylocity from datapine is made possible through CData Connect Cloud. To work with Paylocity data from datapine, 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.

Connecting to Paylocity from datapine

Once you configure your connection to Paylocity in Connect Cloud, you are ready to connect to Paylocity from datapine.

1. Log into datapine
2. Click Connect to navigate to the "Connect" page
3. Select MS SQL Server as the data source
4. In the Integration step, fill in the connection properties and click "Save and Proceed"
   • Set the Internal Name
   • Set Database Name to the name of the connection we just configured (e.g. Paylocity1)
   • Set Host / IP to "tds.cdata.com"
   • Set Username to your Connect Cloud username (e.g. user@mydomain.com)
   • Set Password to the corresponding PAT
   • Set Database Port to "14333"
5. In the Data Schema step, select the tables and fields to visualize and click "Save and Proceed"
6. In the References step, define any relationships between your selected tables and click "Save and Proceed"
7. In the Data Transfer step, click "Go to Analyzer"

Visualize Paylocity Data in datapine

After connecting to CData Connect Cloud, you are ready to visualize your Paylocity data in datapine. Simply select the dimensions and measures you wish to visualize!

Having connect to Paylocity from datapine, you are now able to visualize and analyze real-time Paylocity data no matter where you are. To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from datapine, try CData Connect Cloud today!