Replicate Multiple Paylocity Accounts

CData Sync is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. CData Sync includes a web-based interface that makes it easy to manage multiple Paylocity connections. In this article we show how to use the web app to replicate multiple Paylocity accounts to a single database.

Configure the Replication Destination

Using CData Sync, you can replicate Paylocity data to any number of databases, both cloud-based and on-premises. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select a destination and enter the necessary connection properties. In this article, we use SQLite.
3. Enter the necessary connection properties. To replicate Paylocity to a SQLite database, enter a file path in the Data Source box.
4. Click Test Connection to ensure that the connection is configured properly.
5. Click Save Changes.

Configure Paylocity Connections

You can configure connections to Paylocity from the Connections tab. To add a connection to one of your Paylocity accounts, navigate to the Connections tab. For each Paylocity account you wish to replicate, do the following:

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 Queries for Each Paylocity Instance

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. To configure a replication, 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 a SQL query to customize your replication. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Paylocity API. To customize your replication, click Add Custom Query in the Tables section and define the Query Statement.

The statement below caches and incrementally updates a table of Paylocity data:

REPLICATE Employee;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Paylocity accounts into the same database:

• Use a different table prefix in the REPLICATE SELECT statement:

  REPLICATE PROD_Employee SELECT * FROM Employee;

• Alternatively, use a different schema:

  REPLICATE PROD.Employee SELECT * FROM Employee;

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 10 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 the data from your different Paylocity accounts.