Prepare, Blend, and Analyze Paylocity Data in Alteryx Designer (ODBC)

The CData ODBC driver for Paylocity enables access to live data from Paylocity under the ODBC standard, allowing you work with Paylocity data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to Paylocity data using an ODBC connection in Alteryx Designer to perform self-service BI, data preparation, data blending, and advanced analytics.

The CData ODBC drivers offer unmatched performance for interacting with live Paylocity data in Alteryx Designer due to optimized data processing built into the driver. When you issue complex SQL queries from Alteryx Designer to Paylocity, the driver pushes supported SQL operations, like filters and aggregations, directly to Paylocity and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Paylocity data using native Alteryx data field types.

Connect to Paylocity Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
   
   

   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 DSN, 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.

👁 Configuring the DSN (Salesforce is shown.)

2. Open Alteryx Designer and create a new workflow.
3. If your application is set to run in DCM Mode Only by default, you need to change it to DCM Mode Optional to enable the CData ODBC Driver connection:
   1. Open Options > User Settings > Edit User Settings 👁 Opening User Settings
      
   2. Set the DCM Mode to "DCM Optional" and SDK Access Mode to "Allow" or "AllowAll" 👁 Overriding DCM Settings
      
4. Drag and drop a new input data tool onto the workflow.
👁 Add a new Input Data tool to the Workflow.

5. Click the drop down under Connect a File or Database and select the Data sources tab.
👁 Navigate to the Data sources tab.

6. Navigate tot he end of the page and click on "ODBC" under "Generic connection" 👁 Select New ODBC Connection.
   
7. Select the DSN (CData Paylocity Source) that you configured for use in Alteryx.
👁 Select the configured DSN.

8. In the wizard that opens, drag, and drop the table to be queried in the "Query Builder box." Select the fields by checking the boxes that you wish to include in your query. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Paylocity, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the connector.
👁 Select table(s) and field(s) (Salesforce is shown).


If you wish to further customize your dataset, you can open the SQL Editor and modify the query manually, adding clauses, aggregations, and other operations to ensure that you are retrieving exactly the Paylocity data you want .

👁 Modify the query in the SQL Editor.

With the query defined, you are ready to work with Paylocity data in Alteryx Designer.

Perform Self-Service Analytics on Paylocity Data

You are now ready to create a workflow to prepare, blend, and analyze Paylocity data. The CData ODBC Driver performs dynamic metadata discovery, presenting data using Alteryx data field types and allowing you to leverage the Designer's tools to manipulate data as needed and build meaningful datasets. In the example below, you will cleanse and browse data.

1. Add a data cleansing tool to the workflow and check the boxes in Replace Nulls to replace null text fields with blanks and replace null numeric fields with 0. You can also check the box in Remove Unwanted Characters to remove leading and trailing whitespace.
👁 Add and configure a new Data Cleansing tool.

2. Add a browse data tool to the workflow.
👁 Add a new Data Browse tool.

3. Click to run the workflow (CTRL+R).
👁 Run the workflow.

4. Browse your cleansed Paylocity data in the results view.
👁 Browse the results of the Workflow (Salesforce is shown.)

Thanks to built-in, high-performance data processing, you will be able to quickly cleanse, transform, and/or analyze your Paylocity data with Alteryx.