Analyze Live Paylocity Data in SAS Viya

SAS Viya is an analytics platform that enhances data management, machine learning, and analytics, fostering efficient decision-making and insights. When paired with CData Connect Cloud, you get instant, cloud-to-cloud access to Paylocity data for building predictive models, crafting stunning insights to make data-driven decisions, and more. This article shows how to connect to Connect Cloud from the SAS Viya cloud platform and integrate live Paylocity data into your self-service AI and analytics deployments.

CData Connect Cloud provides a pure SQL, cloud-to-cloud interface for Paylocity, allowing you to easily integrate with live Paylocity data in SAS Viya — without replicating the data. CData Connect Cloud looks exactly like a SQL Server database to SAS Viya and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc.) directly to Paylocity, leveraging server-side processing to return Paylocity data quickly.

Configure Paylocity Connectivity for SAS Viya

Connectivity to Paylocity from SAS Viya is made possible through CData Connect Cloud. To work with Paylocity data from SAS Viya, we start by creating and configuring a Paylocity connection.

1. Log into Connect Cloud, click Connections and click Add Connection.
2. Select "Paylocity" from the Add Connection panel
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 Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured, you are ready to connect to Paylocity data from SAS Viya.

Connecting to CData Connect Cloud from SAS Viya

The following steps detail the process of loading data from Paylocity into SAS Viya using the established connection in CData Connect Cloud.

1. Download and install the CData Connect Cloud JDBC driver from the Client Tools section.
2. Now, log in to SAS Viya and navigate to the Applications Menu at the top-left corner.
3. Select Develop Code and Flows from the Analytics Life Cycle topic.
4. Navigate to the Explorer tab and click on SAS Server on the left panel.
5. Follow the steps to upload the JAR file of the CData Connect JDBC driver:
   • Right-click on the "Home" directory.
   • Click on Upload files.
   • Place the JAR file in the specified location and note its file path.
6. Once done, navigate to the Libraries tab and click on Create a new library connection (on the top left corner as shown below) for the CData Connect JDBC.
7. Enter the library connection settings:
   • Connection name: enter a name for your connection
   • Library name (libref): enter a reference for your library
   • Library type: choose "SAS/ACCESS to JDBC"
8. Click on the Properties tab and set Library attributes to READONLY.
9. Click the Connection Options tab and enter the following details:
   • Hive JDBC driver's class name: cdata.jdbc.connect.ConnectDriver
   • Java CLASSPATH: enter the file path to the JAR driver file (Refer to Step 5)
10. Click on Test connection. If it succeeds, click on Save and connect.
11. Click on to add a new tab and select SAS program.
12. Fill in the code block below with your setup parameters:
    • Libref: enter the library reference you defined in Step 9.
    • ClassPath: enter the file path to the JAR driver file.
    • Username: enter your CData Connect username. This is displayed in the top-right corner of the CData Connect interface. For example, test@cdata.com.
    • DefaultCatalog: enter the connection configured in CData Connect Cloud that you want to query.
    • Password: enter the PAT you generated in the "Add a Personal Access Token" section.
    libname [Libref] JDBC classpath=[ClassPath] class="cdata.jdbc.connect.ConnectDriver" URL="jdbc:Connect:AuthScheme=Basic;User=[Username];DefaultCatalog=[DefaultCatalog];DefaultSchema=dbo;Password=[Password]"; proc sql; SELECT * FROM [Libref].MyTable; quit;
13. Click on Run. You can see the data load from CData Connect Cloud into SAS Viya.

Live Access to Paylocity Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to Paylocity data from SAS Viya. You can build predictive models, craft insights to make data-driven decisions, and more — all without replicating Paylocity data.

Try Connect Cloud and get real-time data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications.