Analyze Paylocity Data in Infragistics Reveal

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Paylocity data. The CData API Server generates an OData API for Paylocity, which is natively consumable in Reveal. In this article, we walk through connecting to Paylocity in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Paylocity from API Server

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

1. Open API Server and click Settings -> Connection -> Add Connection 👁 Adding a connection
   
2. Select "Paylocity" 👁 Selecting a Connector (Salesforce is shown).
   
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. 👁 Configuring a connection (Salesforce is shown).
   

Add Paylocity Resource Definitions in API Server

After connecting to Paylocity, create Resources, which represent API endpoints for Paylocity data.

1. Click Settings -> Resources -> Add Resource 👁 Adding a new resource
   
2. Select the Paylocity connection 👁 Selecting a connection (Salesforce is shown)
   
3. Select the table you wish to retrieve and click Next 👁 Selecting a Table (Salesforce is shown)
   
4. (Optional) Edit the resource to select specific fields and more
5. Save the settings

Add an API Server User

Create a User to connect to Paylocity from Reveal through API Server.

1. Click Settings -> Users
2. Click Add
3. Configure a User with access to the Paylocity Connection and Resource(s) 👁 Creating a new user
   

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

When accessing and connecting to multiple different 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 Settings -> Server.

• 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.

Create a Dashboard in Reveal

With the API Server configured, we can visualize Paylocity data in Reveal.

1. Log into Reveal and click Dashboards -> New 👁 Adding a new dashboard
   
2. Click Data Source -> OData Feed 👁 Adding a new OData data source
   
3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc 👁 Configuring the OData URL
   
4. Select Generic Credentials and specify the API Server username and authentication token 👁 Configuring the credentials
   
5. Select the entity you wish to visualize 👁 Selecting an entity to visualize (Salesforce is shown.)
   
6. Select fields and choose a chart type 👁 Visualizing data in Reveal (Salesforce is shown.)
   

More Information & Free Trial

At this point, you have created a simple dashboard from live Paylocity data. For more information on creating OData feeds from Paylocity (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Paylocity data in tools that consume OData APIs.