The Paylocity ADO.NET Data Provider enables user to easily connect to Paylocity data from .NET applications. Rapidly create and deploy powerful .NET applications that integrate with Paylocity.
Paylocity .NET Connectivity Features
- Fully compatible with the Paylocity REST API V2.0
- SQL Stored Procedures for on-boarding employees, creating pay entries, and more
- Powerful metadata querying enables SQL-like access to non-database sources
- Push down query optimization pushes SQL operations down to the server whenever possible, increasing performance
- Client-side query execution engine, supports SQL-92 operations that are not available server-side
- Connect to live Paylocity data, for real-time data access with the Paylocity ADO.NET Provider
- Full support for data aggregation and complex JOINs in SQL queries
- Secure connectivity through modern cryptography, including TLS 1.2, SHA-256, ECC, etc.
- Seamless integration with leading BI, reporting, and ETL tools and with custom applications via the Paylocity Connector.
Target Service, API
The driver connects to Paylocity API. Payroll and HR platform.
Schema, Data Model
Models Paylocity data as tables. Employee and payroll focused.
Key Objects
Employees, Earnings, Deductions, and Time entries. Payroll data access.
Operations
Read operations on payroll data. Limited write for time entries.
Authentication
OAuth 2.0 with client credentials. Company-specific endpoints.
See what you can do with Paylocity ADO.NET provider
Use Paylocity from SQL Server Analysis Service (SSAS) multi-dimensional cubes. Keep your analytical data modeling and access to any source including cloud and on-premises.
The Paylocity ADO.NET Provider allows developers to build applications that connect to Paylocity using familiar SQL and Entity Framework. Integrate Paylocity to your mission -critical applications or create easy side-by-side applications.
You can connect from ADO.NET compliant low-code development tools:
You can connect Paylocity from .NET-based reporting and analytics tools:
Standard ADO.NET Access to Paylocity
The Paylocity ADO.NET Provider offers the most natural way to access Paylocity data from any .NET application. Simply use Paylocity Data Provider objects to connect and access data just as you would access any traditional database. You will be able to use the Paylocity Data Provider through Visual Studio Server Explorer, in code through familiar classes, and in data controls like DataGridView, GridView, DataSet, etc.
The CData ADO.NET Provider for Paylocity hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Working with DataAdapters, DataSets, DataTables, etc.
The Paylocity Data Provider has the same ADO.NET architecture as the native .NET data providers for SQL Server and OLEDB, including: PaylocityConnection, PaylocityCommand, PaylocityDataAdapter, PaylocityDataReader, PaylocityDataSource, PaylocityParameter, etc. Because of this you can now access Paylocity data in an easy, familiar way.
For example:
using (PaylocityConnection conn = new PaylocityConnection("...")) {
string select = "SELECT * FROM Employees";
PaylocityCommand cmd = new PaylocityCommand(select, conn);
PaylocityDataAdapter adapter = new PaylocityDataAdapter(cmd);
using (adapter) {
DataTable table = new DataTable();
adapter.Fill(table);
...
}
}
More Than Read-Only: Full Update/CRUD Support
Paylocity Data Provider goes beyond read-only functionality to deliver full support for Create, Read, Update, and Delete operations (CRUD). Your end-users can interact with the data presented by the Paylocity Data Provider as easily as interacting with a database table.
using (PaylocityConnection connection = new PaylocityConnection(connectionString)) {
PaylocityDataAdapter dataAdapter = new PaylocityDataAdapter(
"SELECT Id, Where FROM Employees", connection);
dataAdapter.UpdateCommand = new PaylocityCommand(
"UPDATE Employees SET Where = @Where " +
"WHERE Id = @ID", connection);
dataAdapter.UpdateCommand.Parameters.AddWithValue("@Where", "Where");
dataAdapter.UpdateCommand.Parameters.AddWithValue("@Id", "80000173-1387137645");
DataTable EmployeesTable = new DataTable();
dataAdapter.Fill(EmployeesTable);
DataRow firstrow = EmployeesTable.Rows[0];
firstrow["Where"] = "New Location";
dataAdapter.Update(EmployeesTable);
}
ADO.NET Provider Performance
With traditional approaches to remote access, performance bottlenecks can spell disaster for applications. Regardless if an application is created for internal use, a commercial project, web, or mobile application, slow performance can rapidly lead to project failure. Accessing data from any remote source has the potential to create these problems. Common issues include:
- Network Connections - Slow network connections and latency issues are common in mobile applications.
- Service Delays - Delays due to service interruptions, resulting in server hardware or software updates.
- Large Data - Intentional or unintentional requests for large amounts of data.
- Disconnects - Complete loss of network connectivity.
The CData ADO.NET Provider for Paylocity solves these issues by supporting powerful smart caching technology that can greatly improve the performance and dramatically reduce application bottlenecks.
Smart Caching
Smart caching is a configurable option that works by storing queried data into a local database. Enabling smart caching creates a persistent local cache database that contains a replica of data retrieved from the remote source. The cache database is small, lightweight, blazing-fast, and it can be shared by multiple connections as persistent storage.
Caching with our ADO.NET Providers is highly configurable, including options for:
- Auto Cache - Maintain an automatic local cache of data on all requests. The provider will automatically load data into the cache database each time you execute a SELECT query. Each row returned by the query will be inserted or updated as necessary into the corresponding table in the cache database.
- Explicit Cache - Cache only on demand. Developers decide exactly what data gets stored in the cache and when it is updated. Explicit caching provides full control over the cache contents by using explicit execution of CACHE statements.
- No Cache - All requests access only live data and no local cache file is created.
This powerful caching functionality increases application performance and allows applications to disconnect and continue limited functioning without writing code for additional local storage and/or data serialization/deserialization.
More information about ADO.NET Provider caching and best caching practices is available in the included help files.
Visual Studio Integration & Server Explorer
Working with the new Paylocity ADO.NET Provider is easy. As a fully-managed .NET Data Provider, the Paylocity Data Provider integrates seamlessly with the Visual Studio development environment as well as any .NET application.
As an ADO.NET Data Provider, Paylocity ADO.NET Provider can be used to access and explore Paylocity data directly from the Visual Studio Server Explorer.
It's easy. As a standard ADO.NET adapter, developers can connect the Server Explorer to Paylocity ADO.NET Provider just like connecting to any standard database.
- Add a new Data Connection from the Server Explorer and select the Paylocity Data Source
- Configure the basic connection properties to access your Paylocity account data.
Explore all of the data available! Paylocity ADO.NET Provider makes it easy to access live Paylocity data from Visual Studio.
- After configuring the connection, explore the feeds, views, and services provided by the Paylocity Data Source.
- These constructs return live Paylocity data that developers can work with directly from within Visual Studio!
Developer Integration: Databind to Paylocity
Connecting Web, Desktop, and Mobile .NET applications with Paylocity is just like working with SQL Server. It is even possible to integrate Paylocity ADO.NET Provider into applications without writing code.
Developers are free to access the Paylocity ADO.NET Provider in whatever way they like best. Either visually through the Visual Studio Winforms or Webforms designers, or directly through code.
- Developers can connect the Paylocity Data Source directly to form components by configuring the object's smart
tags.
- Add a new Data Connection from the Server Explorer and select the Paylocity Data Source. Then, select the
feed, view, or services you would like to connect the object to.
Done! It's just like connecting to SQL Server.
- Once the object is bound to the data source, applications can easily interact with Paylocity data with full
read/write (CRUD) support.
Popular ADO Videos:
