VOOZH about

URL: https://www.cdata.com/kb/tech/paylocity-cloud-geckoboard.rst

⇱ Create Dashboards and Visualize Live Paylocity Data in Geckoboard


Create Dashboards and Visualize Live Paylocity Data in Geckoboard

πŸ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData Connect AI to connect to live Paylocity data and create dashboards for real-time monitoring and visualization in Geckoboard.

Geckoboard is a business intelligence tool that simplifies the visualization of key performance indicators (KPIs) by creating live dashboards. It allows teams to consolidate data from various sources - such as Salesforce, Snowflake, Google Analytics, and spreadsheets - and display it in a visually engaging and easy-to-understand format. Designed for simplicity and clarity, Geckoboard helps businesses monitor performance, track goals, and make data-driven decisions.

When used with CData Connect AI, you gain instant, cloud-to-cloud access to Paylocity data from Geckoboard for dashboards, monitoring, visualizations, and more. This article explains how to connect to Paylocity and create visualizations using Paylocity data in Geckoboard.

CData Connect AI offers a seamless SQL Server, cloud-to-cloud interface for Paylocity, enabling you to effortlessly create dashboards and visualizations using live Paylocity data in Geckoboard. While building visualizations, Geckoboard requires SQL queries to retrieve the necessary data. With built-in optimized data processing, CData Connect AI pushes all supported SQL operations (such as filters and JOINs) directly to Paylocity, utilizing server-side processing for fast and efficient data retrieval of Paylocity data.

Configure Paylocity connectivity for Geckoboard

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

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Paylocity" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. 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)

  6. Click Save & Test
  7. 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 Geckoboard.

Connect live Paylocity data in Geckoboard

Follow these steps to establish a connection from Geckoboard to the CData Connect AI Virtual SQL Server API.

  1. Log into Geckoboard
  2. Add a custom dashboard name and click Add widget πŸ‘ Click on Add widget.
  3. Search for "Databases" in the Connect your data search bar πŸ‘ Search and click on Databases.
  4. Select SQL Server as the Database type πŸ‘ Select SQL Server.
  5. Fill in the connection details:
    • Connection name: enter a name for the connection to CData Connect AI
    • Host: enter the Virtual SQL Server endpoint: tds.cdata.com
    • Port: : enter 14333
    • Database name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Paylocity1)
    • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
    • Password: enter the PAT you generated on the Settings page
    πŸ‘ Configuring the connection to the Virtual SQL Server API
  6. Click Connect

After successfully configuring your connection, you can query and visualize your Paylocity data.

Visualize live Paylocity data in Geckoboard

To visualize live Paylocity data in Geckoboard, follow these steps:

  1. Write an SQL query to select the specific Paylocity data needed for visualization in Paste your SQL query compiler screen πŸ‘ Write an SQL query to select specific Paylocity data.
  2. Depending on your use case, you can also generate the desired SQL query using the Data Copilot or Query Builder features of CData Connect AI

    πŸ‘ Generate an SQL query using AI Generator in Connect AI.
  3. Choose the visualization type (Line Chart, Bar Chart, or Column Chart) that best suits your business requirements πŸ‘ Choose the visualization type.
  4. The selected chart will be displayed on Geckoboard πŸ‘ Chart is displayed.
  5. Click the menu (three dots in the top-right corner of the graph) and select Edit to modify the SQL query or set a refresh interval for the chart πŸ‘ Edit the widget.
  6. Live access to Paylocity data from cloud applications

    At this stage, you have established a direct, cloud-to-cloud connection to live Paylocity data in Geckoboard. This enables you to create dashboards to monitor and visualize your data seamlessly.

    For more details on accessing live data from over 100 SaaS, Big Data, and NoSQL sources through cloud applications like Geckoboard, visit our Connect AI page.