Automated Continuous 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. 👁 Add a new connection.
   
2. Select the Destinations tab and locate the MongoDB connector. 👁 Configure a Destination connection to MongoDB.
   
3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the MongoDB connector. For more information about installing new connectors, see Connections in the Help documentation.
4. To connect to MongoDB, set the following connection properties:
   • Connection Name: Enter a connection name of your choice for the MongoDB connection.
   • Server: Enter either the host name or the IP address of the server that hosts your MongoDB instance.
   • Port: Enter the port number of the server that hosts your instance of MongoDB. The default port value is 27017.
   • Auth Scheme: Select the authentication scheme.
   • User: Set this to the database user.
   • Password: Set this to the user's password.
   • Database: Set this to the database you want to read from and write to.
   • Auth Database: Enter the name of the MongoDB database for authentication.
👁 Enter the connection details.

5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to MongoDB and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

👁 Add a label.

In this article, we will demonstrate how to load Paylocity data into MongoDB and utilize it as a destination.

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. 👁 Configuring a Source connection (Salesforce is shown).
   

4. Click Connect to Paylocity to ensure that the connection is configured properly.
5. Click Save & Test to save the 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.

👁 Select Source and Destination connections for the replication.

Replicate Entire Tables

To replicate an entire table, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of Paylocity tables you wish to replicate into MongoDB, and click Add Tasks again.

👁 Choose entire tables to replicate (Salesforce is shown).

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 with the help of SQL queries. 👁 Configure a replication Transform.

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at specified intervals, ranging from once every 10 minutes to once every month.

👁 Schedule your job to run automatically.

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.

Run the Replication Job

Once all the required configurations are made for the job, select the Paylocity table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

👁 Run the job.

Free Trial & More Information

Now that you have seen how to replicate Paylocity data into MongoDB, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.