Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Integrate with Live Paylocity Data in MuleSoft (via CData Connect Cloud)
Use CData Connect Cloud to connect to Paylocity from the MuleSoft Anypoint Platform to integrate live Paylocity data into custom reports and dashboards.
The MuleSoft Anypoint Platform enables the building, deployment, and management of APIs and integrations, facilitating seamless connectivity across applications and systems. When combined with CData Connect Cloud, it provides access to Paylocity data for visualizations, dashboards, and more. This article explains how to use CData Connect Cloud to create a live connection to Paylocity and how to connect and access live Paylocity data from the MuleSoft Anypoint Platform.
Prerequisites
Before configuring and using MuleSoft with CData Connect Cloud, you must first connect a data source to your CData Connect Cloud account. For more information, see the Connections section.
Additionally, you need to generate a Personal Access Token (PAT) on the Settings page. Be sure to copy it down, as it serves as your password during authentication.
Configure Paylocity Connectivity for MuleSoft
Connectivity to Paylocity from MuleSoft is made possible through CData Connect Cloud. To work with Paylocity data from MuleSoft, we start by creating and configuring a Paylocity connection.
- Log into Connect Cloud, click Connections and click Add Connection
- Select "Paylocity" from the Add Connection panel
-
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.
- RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.
- Click Create & Test
- Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.
With the connection configured, you are ready to connect to Paylocity data from MuleSoft.
Connecting to CData Connect Cloud
Follow these steps to establish a connection from Mulesoft to CData Connect Cloud through the JDBC driver:
- Download and install the CData Connect Cloud JDBC driver.
- Open the Client Tools page of CData Connect Cloud.
- Locate MuleSoft and click on Download for Mac/Windows/Linux.
- Download and run the setup file.
- When the installation is complete, the JAR file can be found in the installation directory (inside the lib folder).
- Log into Mulesoft Anypoint Studio or launch the desktop application.
- Create a new Mulesoft project. The new project appears in a project folder.
- In the Mule Palette located on the right, drag an HTTP Listener to the Message Flow area.
- Click on the HTTP Listener to configure it.
- Click the + sign on the right of Connector configuration. The HTTP Listener config dialog appears.
- Configure the HTTP Listener, providing a Port on which to query your data, and click OK.
- Provide a path on which to perform the actions. The HTTP Listener is now configured.
- In the Mule Palette on the right, type database in the search bar.
- Drag the database operation you want to perform to the Message Flow area. For this example, we choose Select.
- Select Generic Connection from the Connection dropdown in the Database Config dialog.
- Click the Configure button to configure the JDBC driver. Select Use local file from the drop-down list.
- Locate the CData Connect Cloud JAR file from the JDBC driver installation and click OK.
- Provide the following information:
- URL: the URL for the connection, for example:
jdbc:connect:Authscheme=Basic;user=username;password=password
Note: the password is the PAT created in the Prerequisites section. - Driver class name: Enter the Driver class name as:
cdata.jdbc.connect.ConnectDriver
- URL: the URL for the connection, for example:
- Click Test Connection.
- If the connection is successful, provide the SQL Query Text in the editor. You can see the table metadata on the right side in the Output tab.
- In the Mule Palette, drag Transform Message to the Message Flow area.
- Click Transform Message to configure it. Change the Output as follows:
- Save your project and run it. In the console, Mulesoft starts initializing the dependencies.
- Once you see the message, "Message source 'listener' on flow your_project_name successfully started", you can start querying your data at the endpoint you provided.
- Query to check out the data using the Postman application (as shown below).
SQL Access to Paylocity Data from Cloud Applications
Now you have a direct connection to live Paylocity data from MuleSoft Anypoint Platform. You can create more connections to ensure seamless data flow, automate business processes, and manage APIs - all without replicating Paylocity data.
To get real-time data access to 100+ SaaS, Big Data, and NoSQL sources (including Paylocity) directly from your cloud applications, explore the CData Connect Cloud.