Build an OLAP Cube in SSAS from Paylocity Data

SQL Server Analysis Services (SSAS) serves as an analytical data engine employed in decision support and business analytics, offering high-level semantic data models for business reports and client applications like Power BI, Excel, Reporting Services reports, and various data visualization tools. When coupled with the CData ADO.NET Provider for Paylocity, you gain the capability to generate cubes from Paylocity data, facilitating more profound and efficient data analysis.

In this article, we will guide you through the process of developing and deploying a multi-dimensional model of Paylocity data by creating an Analysis Services project in Visual Studio. To proceed, ensure that you have an accessible SSAS instance and have installed the ADO.NET Provider.

Creating a Data Source for Paylocity

Start by creating a new Analysis Service Multidimensional and Data Mining Project in Visual Studio. Next, create a Data Source for Paylocity data in the project.

1. In the Solution Explorer, right-click Data Source and select New Data Source.
2. Opt to create a data source based on an existing or new connection and click New.
3. In the Connection Manager, select CData ADO.NET Provider for Paylocity, enter the necessary connection properties, and click Next.

   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 connection, 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.

   👁 Setting the Connection properties (Salesforce is shown.)
   
4. Set the impersonation method to Inherit and click Next. 👁 Setting the impersonation method.
   
5. Name the data source (CData Paylocity Source) and click Finish.

Creating a Data Source View

After you create the data source, create the data source view.

1. In the Solution Explorer, right-click Data Source Views and select New Data Source View.
2. Select the data source you just created (CData Paylocity Source) and click Next.
3. Choose a foreign key match pattern that matches your underlying data source and click Next. 👁 Selecting the Foreign key match pattern.
   
4. Select Paylocity tables to add to the view and click Next. 👁 Selecting Tables (Salesforce is shown).
   
5. Name the view and click Finish

Based on the foreign key match scheme, relationships in the underlying data will be automatically detected. You can view (and edit) these relationships by double clicking Data Source View.

Note that adding a secondary data source to the Data Source View is not supported. When working with multiple data sources, SSAS requires both sources to support remote queries via OpenRowset which is unavailable in the ADO.NET Provider.

Creating a Cube for Paylocity

The last step before you can process the project and deploy Paylocity data to SSAS is creating the cubes.

1. In the Solution Explorer, right-click Cubes and select New Cube
2. Select "Use existing tables" and click Next.
3. Select the tables that will be used for measure group tables and click Next. 👁 Selecting measure group tables (Salesforce is shown).
   
4. Select the measures you want to include in the cube and click Next. 👁 Selecting measures (Salesforce is shown).
   
5. Select the dimensions to be created, based on the available tables, and click Next. 👁 Selecting dimensions (Salesforce is shown).
   
6. Review all of your selections and click Finish.

Process the Project

With the data source, data source view, and cube created, you are ready to deploy the cube to SSAS. To configure the target server and database, right-click the project and select properties. Navigate to deployment and configure the Server and Database properties in the Target section.

After configuring the target server and database, right-click the project and select Process. You may need to build and deploy the project as a part of this step. Once the project is built and deployed, click Run in the Process Database wizard.

Now you have an OLAP cube for Paylocity data in your SSAS instance, ready to be analyzed, reported, and viewed. Get started with a free, 30-day trial of the CData ADO.NET Provider for Paylocity.