Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Rapidly Develop Paylocity-Driven Apps with Active Query Builder
Leverage the Active Query Builder SQL interface builder and the ease of .NET data access to create data-driven WinForms and ASP.NET apps.
Write standard .NET to expose Paylocity data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Paylocity enables standards-based access to Paylocity. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.
Connect to Paylocity as an ODBC Data Source
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
Use SQL to Interact with Paylocity
Follow the steps below to create a WinForms visual query builder.
- Open Active Query Builder for .NET WinForms.
- In the new Windows Forms project go to the "File" menu and click "Connect..."
- Under Database Connections, click "Add..."
- Set your desired Connection Name (e.g. CData Paylocity), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
- Click "OK" to save the new connection.
- Back in the Database Connection wizard, select the newly created connection and click "OK."
- Click "File" > "New Query" to create a QueryBuilder
You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.