Build Semantic Layer Views for Paylocity Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live Paylocity data, enabling real-time analytics on Paylocity just like working with a relational database.

With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live Paylocity data. When you issue complex SQL queries 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 client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Paylocity data using native data types.

Download and Install the Connector Files

In order to access Paylocity data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.Paylocity.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.paylocity.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.paylocity.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the Paylocity Connection String

Before establishing the connection to Paylocity from the APOS Live Data Gateway, you need to configure the Paylocity JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, 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.

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. 👁 Using the built-in connection string designer to generate a JDBC URL (paylocity is shown.)

Your connection string will look similar to the following:

jdbc:Paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH;

Connecting to Paylocity & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to Paylocity in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to Paylocity

1. Log into your APOS Live Data Gateway Manager 👁 Logging into the APOS LDG Manager
   
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "Paylocity"
   • Set Connection String to the connection string configured earlier (e.g.:

     jdbc:Paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH;

   • Set Driver Class to "cdata.jdbc.paylocity.PaylocityDriver" (this should be set by default)
   👁 Configuring the Connection (Salesforce is shown).
   
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "paylocity")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI" 👁 Approving Users For Web UI.
   
9. Approve the appropriate DB users to create views and click "Save" 👁 Configuring which DB users can create views.
   

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "paylocity")
3. Since Paylocity does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login" 👁 Connecting from the Web UI (Salesforce is shown).
   
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View" 👁 Adding a new semantic layer view.
   
7. Set the Semantic Layer View Prefix and Semantic Layer View Name 👁 Setting the semantic layer view prefix and name.
   
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view 👁 Selecting table(s) and column(s).
   
10. Click "Step 3"
11. Select the Measures from the available table columns 👁 Selecting the measure(s).
    
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save" 👁 Saving the semantic layer view.
    

With the Semantic Layer View created, you are ready to access your Paylocity data through the APOS Live Data Gateway, enabling real-time data connectivity to Paylocity data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email [email protected] for more information on working with your live Paylocity data in APOS Live Data Gateway.