Visualize Paylocity Data in Sisense

Sisense lets you join, analyze, and picture data to make more intelligent business decisions and craft effective strategies. The CData JDBC Driver for Paylocity makes it easy to integrate with Paylocity data in Sisense. This article shows how to create an ElastiCube that connects to Paylocity data and use the ElastiCube to visualize Paylocity data in Sisense.

Configure the Connection to Paylocity

Before creating the ElastiCube, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Paylocity 20XX\lib) or copy the jar file (cdata.jdbc.paylocity.Paylocity.jar) to a new folder in the Sisense JDBC driver directory (typically C:\ProgramData\Sisense\DataConnectors\jdbcdrivers).

1. In the Data page of the Sisense application, create a new ElastiCube (or open an existing one).
2. In the Model Editor, click "+ Data" to open the Add Data dialog box.
3. Click Generic JDBC to open the JDBC settings.
4. Set the connection string property to the JDBC URL for Paylocity, adding required 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 example follows:

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=REFRESH
5. Set the JDBC JARs folder property to the location of the CData JDBC Driver JAR file (see above).
6. Set the driver's class name to the class name for the JDBC Driver: cdata.jdbc.paylocity.PaylocityDriver
7. Leave the username and password properties blank.
8. Click Next.

Add Paylocity Data to an ElastiCube

Once you are connected to Paylocity, you can add tables and views to your ElastiCubes.

1. From the Tables list, select the tables and/or views you wish to work with.
2. (Optional) Click "+" to customize the data you want to import with SQL.
3. Click Done.
4. Click Build to build the ElastiCube for analytics.

Visualize Paylocity Data

With Paylocity tables added to your ElastiCube, you can perform analytics on your Paylocity data.

1. Navigate to the Analytics page of the Sisense application
2. Select a Dashboard (or create a new one)
3. Select your Data Source and click Create
4. Click "+ Select Data" and choose fields to add to your visualization.

With the CData JDBC Driver for Paylocity, you can access Paylocity data right in Sisense for powerful visualization and analytics. Download a free, 30-day trial and start working with Paylocity data in Sisense today!