Deploy CData Mule Connectors (On-Premise or to the Cloud)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity MuleSoft Connector



Embed the CData MuleSoft Connector for Paylocity in a Mule Application and deploy it to the MuleSoft CloudHub or an on-premise server.

The CData Mule Connector for Paylocity connects Paylocity data to Mule applications enabling read, write, update, and delete functionality with familiar SQL queries. The Connector allows users to easily create Mule applications with access to live Paylocity data that can be deployed to an on-premise server for internal access or to the MuleSoft CloudHub for direct cloud access.

Add Paylocity Connectivity to Mule Apps

This article walks through embedding the CData Mule Connector for Paylocity in an application and deploying the application to MuleSoft CloudHub and to on-premise servers. You will need Mule and Anypoint Studio installed, in addition to the CData Paylocity Connector.

Embed Paylocity Connectivity

The steps below outline adding the Paylocity Connector to your project and configuring the connection and connector.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add a CData Paylocity Connector to the application.
  3. Create a new Connection (or edit an existing one) and configure the properties to connect to Paylocity (see below). Once the connection is configured, click Test Connection to ensure the connectivity 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.

  4. Configure the CData Paylocity Connector with the Operation, Query type, and SQL query.
  5. Finish and save your application.

Once you have completed your application, you can use Anypoint Studio in conjunction with Anypoint Platform to deploy the application to your MuleSoft CloudHub instance or an on-premise server.

Deploy to MuleSoft CloudHub

  1. Right-click your Project and select Anypoint Platform -> Deploy to Cloud
  2. Configure the deployment and click "Deploy Application"
  3. When the deployment completes, navigate to the Anypoint Platform Runtime Manager to manage the deployed application

Once the application is deployed, you will be able to access it from anywhere on the web by navigating to the App URL, adding any parameters needed.

Deploy to an On-Premise Server

In order to deploy a Mule application to an on-premise server through the Anypoint Platform, you will need to have a Mule server instance installed on the machine. The steps below walk through adding the on-premise server to Anypoint Platform and deploying the Mule application.

Add the On-Premise Mule Server to Anypoint Platform

  1. Stop your on-premise Mule server (if it is currently running)
  2. Navigate to the Anypoint Platform and click Add Server to see the command for adding a server, including the security token.
  3. Setup the MuleSoft Runtime Manager Agent (on Windows, run amc_setup.bat ... ).

    %MULE_HOME%\bin> amc_setup -H 12ab3cd4-567e-8fa9-0123-4b56c7de8901---234567 MYSERVER
  4. Start the on-premise Mule Server (on Windows, run mule.bat ).

    %MULE_HOME%\bin> mule

Deploy the Mule Application

  1. In Anypoint Studio, right-click the project -> Export
    • In the Mule folder, choose "Anypoint Studio Project to Mule Deployable Archive" and click "Next" to create the deployable file
  2. In the Anypoint Platform Runtime Manager, navigate to Applications and click Deploy Application
    • Name the application
    • Select the on-premise server as the Deployment Target
    • Under "Application File," click "Choose file" -> "Upload file" and select the project you exported
    • Click "Deploy Application"

Once the application is deployed to the on-premise server, you will be able to access it from any browser with access to the server. Simply navigate to the server address and port, adding any URL parameters needed for the application.

At this point, you have deployed a Mule Application for working with Paylocity data. Download a free, 30 day trial of the Mule Connector for Paylocity and see the CData difference in your Mule applications today.