Use the CData JDBC Driver for Paylocity in MicroStrategy Desktop

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Paylocity.



Connect to Paylocity data in MicroStrategy Desktop using the CData JDBC Driver for Paylocity.

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData JDBC 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 JDBC 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 use native MicroStrategy data types to visualize and analyze Paylocity data.

Connect to and Visualize Paylocity Data using MicroStrategy Desktop

In addition to connecting to Paylocity in MicroStrategy enterprise products, you can connect to Paylocity in MicroStrategy Desktop. Follow the steps below to add Paylocity data as a dataset using JDBC 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 choose Select a Table as the Import Option.
  3. Add a new data source and choose the DSN-less data sources option.
  4. Choose Generic in the Database menu and Generic DBMS in the Version menu.
  5. Click the link to show the connection string and opt to edit the connection string. In the Driver menu, select MicroStrategy Cassandra ODBC Driver. (MicroStrategy requires a certified driver to interface through JDBC; the actual driver will not be used.)
  6. Set the connection string as follows and click OK:
    • Add the JDBC keyword to the connection string.
    • Set MSTR_JDBC_JAR_FOLDER to the path of the JAR file for the JDBC driver. (C:\Program Files\CData JDBC Driver for Paylocity\lib\ on Windows.)
    • Set DRIVER to cdata.jdbc.paylocity.PaylocityDriver, the driver class.
    • Set URL to the JDBC URL for the Paylocity driver, setting the necessary connection properties.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.paylocity.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, 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.

    A typical connection string follows:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.paylocity.PaylocityDriver;URL={jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;};
  7. Right-click on the new data source, and choose Edit catalog options.
  8. Edit the SQL Statement to SELECT * FROM SYS_SCHEMAS to read the metadata from the JDBC Driver.
  9. Select the new data source to view the available tables. You may need to manually click the search icon in the Available Tables section to see the tables.
  10. Drag tables into the pane to import them. Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
  11. Click Finish and choose the option to connect Live. Live connections are possible and effective, thanks to the high-performance data processing native to CData JDBC Drivers.
  12. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of Paylocity data. Data types are discovered automatically through dynamic metadata discovery. 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.
  13. Once you are finished configuring the dossier, click File -> Save.

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