Build AI/ML Models with Live Paylocity Data using Dataiku

Dataiku is a data science and machine learning platform used for data preparation, analysis, visualization, and AI/ML model deployment, enabling collaborative and efficient data-driven decision-making. When paired with the CData JDBC Driver for Paylocity, Dataiku enhances data integration, preparation, real-time analysis, and reliable model deployment for Paylocity data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Paylocity data. When you issue complex SQL queries 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 client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Paylocity data using native data types.

This article shows how you can easily integrate to Paylocity using CData JDBC Driver for Paylocity in Dataiku DSS (Data Science Studio) platform, allowing you to prepare the data and build custom AI/ML models.

Preparing the Dataiku DSS environment

In this section, we will explore how to set up Dataiku, as previously introduced, with Paylocity data. Be sure to install Dataiku DSS (On-Prem version) for your preferred operating system, beforehand.

Install the CData JDBC Driver for Paylocity

First, install the CData JDBC Driver for Paylocity on the same machine as Dataiku. The JDBC Driver will be installed in the following path:

C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.paylocity.jar

Connecting the JDBC Driver in Dataiku DSS

To use the CData JDBC driver in Dataiku, you must create a new SQL database connection and add the JDBC Driver JAR file in the DSS connection settings.

1. Log into Dataiku DSS platform. It should open locally in your browser (e.g. localhost:11200) 👁 Log into Dataiku DSS platform.
   👁 Dataiku DSS platform dashboard.
   
2. Click on Navigate to other sections of Dataiku menu on the top right section of the platform and select Administration. 👁 Select Administration.
   
3. Select the Connections tab. 👁 Select Connections.
   
4. In Connections, click on New Connections button. 👁 Click New Connections.
   
5. Now, scroll down and select Other SQL databases. 👁 Select Other SQL databases.
   

6. Generate a JDBC URL for connecting to Paylocity, beginning with jdbc:paylocity: followed by a series of semicolon-separated connection string properties.

   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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.paylocity.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   A typical JDBC URL is given below:

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH;
   

7. On the New SQL database (JDBC) connection screen, enter a name in the New connection name field and specify the basic parameters:
   • JDBC Driver Class: cdata.jdbc.paylocity.PaylocityDriver
   • JDBC URL: JDBC connection URL obtained in the previous step
   • Driver jars directory: the folder path where the JAR file is installed on your system
   👁 Enter a connection name and specify the basic connection parameters.
   

   Next, select the SQL dialect of your choice. Here, we have selected 'SQL Server' as the preferred dialect. Click on Create. If the connection is successful, a prompt will display, saying 'Connection OK'.

8. The Data Catalog window will appear. Select the desired connection, catalog, and schema from the Connection to browse, Restrict to catalog, and Restrict to schema dropdowns, then click on List Tables. The Dataiku platform will list all the required tables. 👁 Select the connection, catalog and schema to filter the list of tables.
   👁 Data Catalog lists all the available tables in the datasource.
   
9. Select any table from the list and click Preview to view the table data. Click Close to exit the window. 👁 Preview any specific table data.
   

Creating a new project

To prepare data flows, create dashboards, analyze the Paylocity data, and build AI and ML models in the Dataiku DSS platform, you need to first create a new project.

1. Select Projects from the Navigate to other sections of Dataiku menu. 👁 Select Project.
   
2. In the Projects screen, click New Project and select + Blank Project. 👁 Select a Blank Project.
   
3. In the New Project window, assign a Name and Project Key. Click Create. The new project dashboard opens up. 👁 Enter a Name and Project Key.
   👁 Project dashboard is displayed.
   
4. Select Notebooks from the menu at the top of the project screen. 👁 Select Notebooks.
   
5. Click on + Create Your First Notebook dropdown menu and select Write your own option. 👁 Create the notebook.
   
6. In the New Notebook window, select SQL. 👁 Select SQL.
   
7. Now, select the required connection from the Connection dropdown and enter a name in the Notebook Name field. 👁 Select a connection and add a notebook name.
   

Testing the connection

To test the Paylocity connection and analyze the Paylocity data, write a query in the query compiler and click Run. The queried/filtered Paylocity data results will then appear on the screen.

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Paylocity to integrate with Dataiku, and effortlessly build custom AI/ML models from Paylocity data.

Reach out to our Support Team if you have any questions.