Visualize Paylocity Data in TIBCO Spotfire through OData

OData is a major protocol enabling real-time communication among cloud-based, mobile, and other online applications. The CData Connect Server provides Paylocity data to OData consumers like TIBCO Spotfire. This article shows how to use the Connect Server and Spotfire's built-in support for OData to access Paylocity data in real time.

Configuring Connect Server

To work with live Paylocity data in TIBCO Spotfire, 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 TIBCO Spotfire 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.

Create Data Visualizations on External Paylocity Data

1. Open Spotfire and click Data -> Add data...
2. Then, click "Connect to" -> OData -> New Connection. In the OData Connection dialog, enter the following information:
   • Service URL: Enter the Connect Server's OData endpoint. For example: http://localhost:8080/odata.rsc
   • Authentication Method: Select Username and Password.
   • Username: Enter the username of a Connect Server user. You can create API users on the Security tab of the administration console.
   • Password: Enter the authtoken of a Connect Server user.
3. Select the tables and columns you want to add to the dashboard. This example uses Employee.

4. If you want to work with the live data, click the Keep Data Table External option. This option enables your dashboards to reflect changes to the data in real time.

   If you want to load the data into memory and process the data locally, click the Import Data Table option. This option is better for offline use or if a slow network connection is making your dashboard less interactive.

5. After you have selected a table, Spotfire uses the data to detect number, time, and other categories. You are now on your way to creating new visualizations for analytics, reporting, and more.

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 TIBCO Spotfire, 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.