Use the CData ODBC Driver for Paylocity in MicroStrategy Desktop

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired with the CData ODBC Driver for Paylocity, you gain database-like access to live Paylocity data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding Paylocity as a data source in MicroStrategy Desktop and creating a simple visualization of Paylocity data.

The CData ODBC Driver offers unmatched performance for interacting with live Paylocity data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Paylocity, the driver pushes supported SQL operations, like filters and aggregations, directly to Paylocity and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Paylocity data using native MicroStrategy data types.

Connect to Paylocity as an ODBC Data Source

Information for connecting to Paylocity follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

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.

Linux

If you are installing the CData ODBC Driver for Paylocity in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData Paylocity Sys]
Driver = CData ODBC Driver for Paylocity
Description = My Description
OAuthClientID = YourClientId
OAuthClientSecret = YourClientSecret
RSAPublicKey = YourRSAPubKey
Key = YourKey
IV = YourIV
InitiateOAuth = GETANDREFRESH

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Connect to and Visualize Paylocity Data using MicroStrategy Desktop

In addition to connecting Paylocity in MicroStrategy enterprise products, you can connect to Paylocity in MicroStrategy Desktop. Follow the steps below to add Paylocity data as a dataset and create visualizations and reports of Paylocity data.

1. Open MicroStrategy Desktop and create a new dossier.
2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
3. Add a new data source and choose DSN data sources.
4. Choose the DSN you previously configured (likely CData Paylocity Sys) and select Generic DBMS in the Version menu.
5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.
👁 Creating a new data source for Paylocity.

6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
7. Create a SQL query for the Paylocity data (see below) and click Execute SQL to test the query.

   SELECT * FROM Employee
   

   👁 Querying Paylocity for data.
   NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
8. Click Finish and choose to connect live.
9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of Paylocity data. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Paylocity, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL Engine embedded in the driver. 👁 Visualize Paylocity data.
   
10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for Paylocity in MicroStrategy Desktop, you can easily create robust visualizations and reports on Paylocity data. Read our other articles on connecting to Paylocity in MicroStrategy and connecting to Paylocity in MicroStrategy Web for more examples.