Connect to Live Paylocity Data in MicroStrategy through CData Connect AI

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with CData Connect AI, you gain database-like access to live Paylocity data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through connecting to Paylocity in Connect AI and connecting to Connect AI in MicroStrategy to create a simple visualization of Paylocity data.

As a cloud-based integration platform, Connect AI is ideal for working with cloud-based BI and analytics tools. With no servers to configure or data proxies to set up, you can simply use the web-based UI to create a live connection to Paylocity and connect from MicroStrategy to start performing analytics based on live Paylocity data.

Configure Paylocity Connectivity for Microstrategy

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

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Paylocity" from the Add Connection panel
👁 Selecting a data source

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. 👁 Configuring a connection (Salesforce is shown)
   

4. Click Save & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
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 and a PAT generated, you are ready to connect to Paylocity data from MicroStrategy.

Connect to and Visualize Paylocity Data Using MicroStrategy

You can connect to Paylocity in MicroStrategy by adding a data source based on the native SQL Server functionality. Once you have created a data source, you can build dynamic visualizations of Paylocity data in MicroStrategy.

1. Open MicroStrategy and select your account.
2. Click Add External Data, select Databases, and use Select Tables as the Import Option. 👁 Adding External Data
   
3. In the Import from Tables wizard, click to add a new Data Source.
4. Select "SQL Server" in the Database menu and select "SQL Server 2017" in the Version menu.
5. Sat the connection properties as follows:
   • Server Name: tds.cdata.com
   • Port Number: 14333
   • Database Name: the name of your Paylocity connection (e.g. Paylocity1)
   • User: a Connect AI user
   • Password: the PAT for your Connect AI user
   • Data Source Name: a name for the new external data source, like "CData Cloud Paylocity"
6. Expand the menu for the new data source and choose "Edit Catalog Options"👁 Edit the catalog options.
   
7. Edit the "SQL statement retrieve columns ..." query to include TABLE_SCHEMA = '#?Schema_Name?#' in the WHERE clause, and click Apply and then OK (the complete query is below).
   
   

   SELECT DISTINCT 
    TABLE_SCHEMA NAME_SPACE, 
    TABLE_NAME TAB_NAME, 
    COLUMN_NAME COL_NAME, 
    (CASE 
    WHEN 
    (DATA_TYPE LIKE '%char' AND (CHARACTER_SET_NAME='utf8' OR CHARACTER_SET_NAME='usc2')) 
    THEN 
    CONCAT('a',DATA_TYPE) 
    ELSE 
    DATA_TYPE 
    END) DATA_TYPE, 
    CHARACTER_MAXIMUM_LENGTH DATA_LEN, 
    NUMERIC_PRECISION DATA_PREC, 
    NUMERIC_SCALE DATA_SCALE 
   FROM 
    INFORMATION_SCHEMA.COLUMNS 
   WHERE 
    TABLE_NAME 
   IN 
    (#TABLE_LIST#) AND TABLE_SCHEMA='#?Schema_Name?#' 
   ORDER BY 
    1,2,3
   

8. Select the new data source and select the Namespace that corresponds to your virtual Paylocity database (like Paylocity1).
9. Drag tables into the pane to insert then. 👁 Select tables to insert.
   Note: Since we create a live connection, we can insert whole tables and utilize the filtering and aggregation features native to the MicroStrategy products to customize our datasets.
10. Click Finish, choose the option to connect live, save the query, and choose the option to create a new dossier. Live connections are possible and effective, thanks to high-performance data processing native to CData Connect AI. 👁 Save the query and create a new dossier.
    
11. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of Paylocity data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Paylocity, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed by the CData SQL engine embedded in Connect AI. 👁 Visualize Paylocity data.
    
12. Once you have finished configuring the dossier, click File -> Save.

Using CData Connect AI with MicroStrategy, you can easily create robust visualizations and reports on Paylocity data. For more information on connecting to Paylocity (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Paylocity data in MicroStrategy.