Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Automate Paylocity Data Replication to Couchbase



Use CData Sync to Customize and automate Paylocity data replication to Couchbase.

Always-on applications rely on automatic failover capabilities and real-time access to data. CData Sync integrates live Paylocity data into your Couchbase instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure Replication Destinations

Using CData Sync, you can replicate Paylocity data to Couchbase. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select Couchbase as a destination.
  3. Enter the necessary connection properties.
    • Server - Enter either the host name or the IP address of your Couchbase server.
    • Auth Scheme - Select the authentication scheme. Basic is the default setting. For this setting, specify your login credentials:
      • User - Enter the username that you use to authenticate to Couchbase.
      • Password - Enter the password that you use to authenticate to Couchbase.
    • Couchbase Service - Select the Couchbase service that you want to use. The default service is N1QL.
    • Connection Mode - Select the connection mode that you want to use. The default mode is Direct.
    • Use SSL - Specify whether you want to use the Secure Sockets Layer (SSL) protocol. The default value is False.
    • Click Test Connection to ensure that the connection is configured properly.
    • Click Save Changes.

Configure the Paylocity Connection

You can configure a connection to Paylocity from the Connections tab. To add a connection to your Paylocity account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (Paylocity).
  3. Configure the connection 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.

  4. Click Connect to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 15 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Paylocity data to Couchbase.