Create Datasets from Paylocity in Domo Workbench and Build Visualizations of Paylocity Data in Domo

Domo helps you manage, analyze, and share data across your entire organization, enabling decision makers to identify and act on strategic opportunities. Domo Workbench provides a secure, client-side solution for uploading your on-premise data to Domo. The CData ODBC Driver for Paylocity links Domo Workbench to operational Paylocity data. You can build datasets from Paylocity data using standard SQL queries in Workbench and then create real-time visualizations of Paylocity data in the Domo service.

The CData ODBC Drivers offer unmatched performance for interacting with live Paylocity data in Domo due to optimized data processing built into the driver. When you issue complex SQL queries from Domo 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 Domo data types.

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.

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.

After creating a DSN, you will need to create a dataset for Paylocity in Domo Workbench using the Paylocity DSN and build a visualization in the Domo service based on the dataset.

Build a Dataset for Paylocity Data

You can follow the steps below to build a dataset based on a table in Paylocity in Domo Workbench using the CData ODBC Driver for Paylocity.

1. Open Domo Workbench and, if you have not already, add your Domo service server to Workbench. In the Accounts submenu, click Add New, type in the server address (i.e., domain.domo.com) and click through the wizard to authenticate. 👁 Connecting to the Domo Service.
   
2. In the DataSet Jobs submenu, click Add New.
3. Name the dataset job (i.e., ODBC Paylocity Employee), select ODBC Connection Provider as the transport method, and click through the wizard. 👁 Configuring the DataSet Job.
   
4. In the newly created DataSet Job, navigate to Source and click to configure the settings.
5. Select System DSN for the Connection Type.
6. Select the previously configured DSN (CData Paylocity Sys) for the System DSN.
7. Click to validate the configuration. 👁 Configuring the Source Settings.
   
8. Below the settings, set the Query to a SQL query:

   SELECT * FROM Employee

   NOTE: By connecting to Paylocity data using an ODBC driver, you simply need to know SQL in order to get your data, circumventing the need to know Paylocity-specific APIs or protocols.
9. Click preview. 👁 Querying Paylocity Data.
   
10. Check over the generated schema, add any transformations, then save and run the dataset job. 👁 Save and Run the Configured DataSet Job (Salesforce is shown).
    

With the dataset job run, the dataset will be accessible from the Domo service, allowing you to build visualizations, reports, and more based on Paylocity data.

Create Data Visualizations

With the DataSet Job saved and run in Domo Workbench, we are ready to build visualizations of the Paylocity data in the Domo service.

1. Navigate to the Data Center. 👁 Accessing the Data Center (Salesforce is shown).
   
2. In the data warehouse, select the ODBC data source and drill down to our new dataset. 👁 Selecting the Paylocity Dataset (Salesforce is shown).
   
3. With the dataset selected, choose to create a visualization.
4. In the new card:
   • Drag a Dimension to the X Value.
   • Drag a Measure to the Y Value.
   • Choose a Visualization.
   👁 Visualizing Paylocity Data in Domo (Salesforce is shown).
   

With the CData ODBC Driver for Paylocity, you can build custom datasets based on Paylocity data using only SQL in Domo Workbench and then build and share visualizations and reports through the Domo service.