Learn more
 

Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

In this article

Related articles

DataBind Wijmo Grid to Paylocity Data


Provide real-time Paylocity data to interactive controls.

The Connect Server enables you to use Web services to connect to and query Paylocity data. This article details how to import an OData feed of Paylocity data into Wijmo Grid.

Configuring Connect Server

To work with live Paylocity data in Wijmo Grid, we need to connect to Paylocity from Connect Server, provide user access to the new virtual database, and create OData endpoints for the Paylocity data.

Add a Connect Server User

Create a User to connect to Paylocity from Wijmo Grid through Connect Server.

  1. Click Users -> Add
  2. Configure a User
  3. Click Save Changes and make note of the Authtoken for the new user

Connect to Paylocity from Connect Server

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open Connect Server and click Connections
  2. Select "Paylocity" from Available Data Sources
  3. Enter the necessary authentication properties to connect to Paylocity.

    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 Save Changes
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions (SELECT is all that is required for Reveal).

Add Paylocity OData Endpoints in Connect Server

After connecting to Paylocity, create OData Endpoints for the desired table(s).

  1. Click OData -> Tables -> Add Tables
  2. Select the Paylocity database
  3. Select the table(s) you wish to work with and click Next
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in OData -> Settings.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Connect to Paylocity Data using Wijmo Grid

Create a Real-Time Grid

Follow the steps below to consume Paylocity data from the Wijmo JavaScript controls:

  1. Load the required Wijmo, jQuery, and Knockout libraries: 
    			
			<script src="http://code.jquery.com/jquery-1.11.1.min.js"></script>
			<script src="http://code.jquery.com/ui/1.11.0/jquery-ui.min.js"></script>

			<!--Theme-->
			<link href="http://cdn.wijmo.com/themes/aristo/jquery-wijmo.css" rel="stylesheet" type="text/css">

				<!--Wijmo Widgets CSS-->
				<link href="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20161.90.min.css" rel="stylesheet" type="text/css">

					<!--Wijmo Widgets JavaScript-->
					<script src="http://cdn.wijmo.com/jquery.wijmo-open.all.3.20161.90.min.js"></script>
					<script src="http://cdn.wijmo.com/jquery.wijmo-pro.all.3.20161.90.min.js"></script>
					<script src="http://cdn.wijmo.com/interop/wijmo.data.ajax.3.20161.90.js"></script>

					<!--Knockout JS Library-->
					<!-- Both of the links below can work -->
					<script src="http://cdn.wijmo.com/wijmo/external/knockout-2.2.0.js"></script>
					<!--<script src="http://cdn.wijmo.com/amd-js/3.20161.90/knockout-3.1.0.js"></script>-->

					<!--Wijmo Knockout Integration Library-->
					<script src="http://cdn.wijmo.com/interop/knockout.wijmo.3.20161.90.js"></script>
  2. Create a ViewModel and connect to it using the ODataView. You will need to replace the placeholder values for the URL of the API Server, an API Server user, and the authtoken for that user. 
    			
			<script id="scriptInit">
			$.support.cors = true;
			var viewModel;

			function ViewModel() {
			var employeeView = new wijmo.data.ODataView("http://MyServer:MyPort/api.rsc/Employee", {
			ajax: {
			dataType: "jsonp",
			username: "MyUser",
			password: "MyAuthtoken",
			data: { "$inlinecount": null }
			},
			pageSize: 10
			});
			employeeView.refresh();
			employeeView.nextPage();
			this.employee = employeeView;
			this.prevPage = function () {employeeView.prevPage();};
			this.nextPage = function () {employeeView.nextPage();};
			}

			$(document).ready(function () {
			viewModel = new ViewModel();
			ko.applyBindings(viewModel, $(".container").get(0));
			});
			</script>
  3. DataBind: Below is a simple table with some paging buttons, which you can paste into the body section of your markup. 
    			
			<h2>Connect to Live Paylocity Data in Real Time</h2>

			<h3>Employee</h3>
			<div>
				<button title="previous page" class="pagebuttons" data-bind="click: prevPage, button: {}">
					<span class="ui-icon ui-icon-seek-prev" />
				</button>
				<button title="next page" class="pagebuttons" data-bind="click: nextPage, button: {}">
					<span class="ui-icon ui-icon-seek-next" />
				</button>
			</div>
			<table id="demo-grid" data-bind="wijgrid: { 
      data: employee, 
      showFilter: true, 
      allowPaging: true,
      pagerSettings: { position: 'none'},
      columnsAutogenerationMode: 'append',
    }" >
			</table>

At this point, you may be prompted to re-enter the username and authtoken. After doing so, a resulting table or grid should appear, as seen below. You can filter and sort through pages of Paylocity data.

Free Trial & More Information

If you are interested in connecting to your Paylocity data (or data from any of our other supported data sources) from Wijmo Grid, sign up for a free trial of CData Connect Server today! For more information on Connect Server and to see what other data sources we support, refer to our CData Connect page.