Use the CData ODBC Driver for Paylocity in SAS for Real-Time Reporting and Analytics

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity ODBC Driver

The Paylocity ODBC Driver is a powerful tool that allows you to connect with live data from Paylocity, directly from any applications that support ODBC connectivity.

Access Paylocity data like you would a database - read, write, and update Paylocity FALSE, etc. through a standard ODBC Driver interface.



Connect to real-time Paylocity data in SAS for reporting, analytics, and visualizations using the CData ODBC Driver for Paylocity.

SAS is a software suite developed for advanced analytics, multivariate analysis, business intelligence, data management, and predictive analytics. When you pair SAS with the CData ODBC Driver for Paylocity, you gain database-like access to live Paylocity data from SAS, expanding your reporting and analytics capabilities. This articles walks through creating a library for Paylocity in SAS and creating a simple report based on real-time Paylocity data.

The CData ODBC Driver offers unmatched performance for interacting with live Paylocity data in SAS due to optimized data processing built into the driver. When you issue complex SQL queries from SAS 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 easily visualize and analyze Paylocity data in SAS.

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 (the ODBC Driver for Paylocity must be installed on the machine hosting the SAS System).

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

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

Create a Paylocity Library in SAS

Connect to Paylocity in SAS by adding a library based on the CData ODBC Driver for Paylocity.

  1. Open SAS and expand Libraries in the Explorer pane.
  2. In the Active Libraries window, right-click and select New.
  3. Name your library (odbclib), select ODBC as the Engine, and click to Enable at startup (if you want the library to persist between sessions).
  4. Set Data Source to the DSN you previously configured and click OK.

Create a View from a Paylocity Query

SAS natively supports querying data either using a low-code, point-and-click Query tool or programmatically with PROC SQL and a custom SQL query. When you create a View in SAS, the defining query is executed each time the view is queried. This means that you always query live Paylocity data for reports, charts, and analytics.

Using the Query Tool

  1. In SAS, click Tools -> Query
  2. Select the table sources and the table(s) you wish to pull data from. Then, click OK.
  3. Select columns and right-click to add filtering, ordering, grouping, etc.
  4. Create a local view to contain the query results by right-clicking the SQL Query Tool window, selecting Show Query, and clicking Create View. Name the View and click OK.

Using PROC SQL

  1. In SAS, navigate to the Editor window.
  2. Use PROC SQL to query the data and create a local view.
    NOTE: This procedure creates a view in the Work library. You can optionally specify a library in the create view statement.
    proc sql;
      create view employee_view as
      select 
        firstname, 
        lastname 
      from 
        odbclib.employee 
      where 
        EmployeeId = '1234';
    quit;
    
  3. Click Run -> Submit to execute the query and create a local view.

Report On or Visualize Paylocity Data in SAS

With a local view created, you can report, visualize, or otherwise analyze Paylocity data using the powerful SAS features. Print a simple report using PROC PRINT and create a basic graph based on the data using PROC GCHART.

Print an HTML Report

  1. In SAS, navigate to the Editor window.
  2. Use PROC PRINT to print an HTML report for the Paylocity Employee data.
    proc print data=employee;
      title "Paylocity Employee Data";
    run;
    

Print a Chart

  1. In SAS, navigate to the Editor window.
  2. Use PROC GCHART to create a chart for the Employee data.
    proc gchart data=employee;
      pie firstname / sumvar=lastname
          value=arrow
          percent=arrow
          noheading
          percent=inside plabel=(height=12pt)
          slice=inside value=none
          name='EmployeeChart';
    run;