Automated Continuous Paylocity Replication to MongoDB

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Use CData Sync for automated, continuous, customizable Paylocity replication to MongoDB.

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

Configure MongoDB as a Replication Destination

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

  1. Click Add Connection.
  2. Select MongoDB as a destination.
  3. Enter the necessary connection properties. To connect to MongoDB, set the following:
    • Server: Set this to the name or address of the server where your MongoDB instance is running. You can specify the port here or in Port.
    • Database: Set this to the database you want to read from and write to.

    Connecting to CosmosDB with the MongoDB API

    To obtain the connection string needed to connect to a Cosmos DB account using the MongoDB API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values.

    • Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can also specify the port here or in Port.
    • Port: Set this to the port.
    • Database: Set this to the database you want to read from and write to.
    • User: Set this to the database user.
    • Password: Set this to the user's password.

  4. Click Test Connection to ensure that the connection is configured properly.
  5. 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 Transform feature to customize your replication. The Transform feature allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. To customize your replication, click the Transform button in the Tables section and customize 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 MongoDB.