Analyze Paylocity Data in Cognos Analytics

Cognos Analytics, powered by IBM Watson®, empowers users to cleanse and establish connections with their data while creating visualizations. When integrated with CData Connect AI, users gain immediate, real-time connectivity between cloud-based data sources and Cognos Analytics, facilitating data management, visualization, analytics, and more. This article provides step-by-step guidance on connecting to Paylocity via CData Connect AI and subsequently analyzing Paylocity data within Cognos Analytics.

NOTE: These instructions require Cognos Analytics 11.2.4 or higher

CData Connect AI offers a dedicated cloud-to-cloud interface for Paylocity, enabling users to perform real-time analysis on Paylocity data within Cognos without the need to replicate data to a natively supported database. Equipped with built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, directly to Paylocity. This harnesses server-side processing to promptly provide the requested Paylocity data.

Configure Paylocity Connectivity for Cognos Analytics

Connectivity to Paylocity from Cognos Analytics is made possible through CData Connect AI. To work with Paylocity data from Cognos Analytics, 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 Cognos Analytics.

Connect to Paylocity from Cognos Analytics

The steps below outline connecting to CData Connect AI from Cognos Analytics to analyze live Paylocity data.

Download and install the CData Connect AI JDBC driver

1. Open the Integrations page of CData Connect AI.
2. Search for and select JDBC.
3. Download and run the setup file.
4. When the installation is complete, copy the JAR file (cdata.jdbc.connect.jar) from the installation directory (e.g., C:\Program Files\CData\JDBC Driver for CData Connect\lib) to the "drivers" folder in your Cognos Analytics installation directory.

Configure the Connection to CData Connect AI

1. Open IBM Cognos and navigate to Manage > Data server connections.
2. Click the icon to add a data server.
3. Select CData Connect AI.
4. Set JDBC URL to the appropriate connection string. For example:

    jdbc:connect:AuthScheme=Basic;user=username;password=PAT;
    

5. Set Driver class name to "cdata.jdbc.connect.ConnectDriver"
6. Create and store authenticate credentials by selecting an authentication method
   • Set Username to your CData Connect AI username (e.g., [email protected])
   • Set Password to the PAT you previously generated.
7. Click Test connection to confirm that the connection succeeds. 👁 Connecting to CData Connect AI from Cognos Analytics
   

At this point, you are ready to analyze and visualize Paylocity data in Cognos Analytics. For more information about using Cognos Analytics, please refer to the Cognos Analytics documentation.

Live Access to Paylocity Data for Analytics

Now you have a direct, cloud-to-cloud connection to live Paylocity data from Cognos Analytics. You can create new visualizations, build reports, and more — without replicating Paylocity data.

Try CData Connect AI and get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications.