How to create an RPA flow for Paylocity Data in UiPath Studio



Use the Paylocity ODBC Driver to create workflows that access real-time Paylocity data without any coding.

UiPath is a Robotic Process Automation (RPA) platform with rich features and an easy-to-use UI that enables non-developers to create process automation. By using UiPath Studio, you can build an RPA program just like drawing a diagram. With the CData ODBC Driver for Paylocity, users can embed Paylocity data in the workflow.

This article walks through using the Paylocity ODBC Driver in UiPath Studio to create an RPA program that accesses Paylocity data.

Configure the Connection to Paylocity

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.

Connect UiPath Studio to Paylocity Data

Now you are ready to use Paylocity data ODBC DSN in UiPath Studio with the following steps.

  1. From the Start page, click Blank to create a New Project.
  2. Click Manage Packages then search for and install UiPath.Database.Activities.
  3. Navigate to the Activities and drop a Flowchart (Workflow -> Flowchart -> Flowchart) onto the process.
  4. Drop a database Connect activity (App Integration -> Datbase -> Connect) after the Start activity.
  5. Double-click the Connect activity and configure the Connection.
    1. Click the Connection Wizard
    2. Select "Microsoft ODBC Data Source"
    3. In Connection Properties, select your DSN (CData Paylocity Source) and click OK
  6. To store Connection info, create a variable and bind to Output in the Properties section. Choose DatabaseConnection in Output.

Create an Execute Query Activity

With the connection configured, we are ready to query Paylocity data in our RPA.

  1. From the Activities navigation, select Execute Query and drop it on the Flowchart.
  2. Double-click the Execute Query activity and set the properties as follows:
    • ExistingDbConnection: Your Connection variable
    • Sql: SELECT statement like SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
    • DataTable: Create and use a variable with the Type System.Data.DataTable

Create Write CSV Activity

With the Connection and Execute Query activities configured, we are ready to add a Write CSV activity to the Flowchart to replicate the Paylocity data.

  1. From the Activities navigation, select Write CSV and drop it after the Execute Query activity.
  2. Double-click the Write CSV activity and set the properties as follows:
    • FilePath: Set to a file (new or existing) on disk (i.e.: C:\UiPath[id]-data.csv
    • DataTable: Set to the DataTable variable you created earlier

Connect the Activities and Run the Flowchart

If they are not already connected, connect each Activity that you created to complete the RPA project for extracting Paylocity data and exporting it to CSV.

Click Run to extract Paylocity data and create a CSV file.

In this article, we used the CData ODBC Driver for Paylocity to create an automation flow that accesses Paylocity data in UiPath Studio. Download a free, 30-day trial of the ODBC Driver and start working with live Paylocity data in UiPath Studio today!

Ready to get started?

Download a free trial of the Paylocity ODBC Driver to get started:

 Download Now

Learn more:

Paylocity Icon Paylocity ODBC Driver

The Paylocity ODBC Driver is a powerful tool that allows you to connect with live data from Paylocity, directly from any applications that support ODBC connectivity.

Access Paylocity data like you would a database - read, write, and update Paylocity FALSE, etc. through a standard ODBC Driver interface.