Build Paylocity-Connected Web Apps with Axios and CData Connect AI

Axios is a JavaScript library that allows developers to make HTTP requests to servers from a web browser or Node.js. When paired with CData Connect AI, you get access to live Paylocity data for your web apps. This article shows how to connect to Paylocity and build web apps in Axios with access to live Paylocity data.

Connect to Paylocity from Axios

To work with Paylocity in Axios, we need to connect to Paylocity from Connect AI, provide user access to the connection, and create a Workspace for the Paylocity data.

Connect to Paylocity from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

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.

Configure Paylocity Endpoints for Axios

After connecting to Paylocity, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). 👁 The Workspaces page.
   👁 Adding a new Workspace.
   
2. Click Add to add new assets to the Workspace.
3. Select the Paylocity connection (e.g. Paylocity1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
   
4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
   
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Paylocity data from Axios.

Connect to Paylocity Data in Axios Workflows

To establish a connection from Axios to CData Connect AI using the OData protocol, follow these steps.

1. Create a project directory for your web app. For example: ~/connect_cloud/
2. Open a terminal, navigate the the project directory and initialize a node project using the command:

   npm init -y

3. Install the Axios dependency in the project using the following command:

   npm install axios

4. In your project directory, create a file called server.js that contains the following code. Provide your CData Connect AI username (e.g. [email protected]) and PAT (the PAT you created in the prerequisites). You must also provide a query for your data, such as SELECT * FROM Paylocity1.SCHEMA.Employee.

   server.js code

    const axios = require('axios')
   
    const user = '[email protected]'
    const pat = '***********************************';
   
    //Your API endpoint
    const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';
   
    //Your data to be sent in the POST request
    const data = {
    "query":"SELECT * FROM {workspace_name}.SCHEMA.Employee"
    };
   
    axios.post(url, data, {
    auth: {
    username: user,
    password: pat
    }
    })
    .then(response => {
    const rows = response.data.results[0].rows;
    const schema = response.data.results[0].schema;
   
    //Create an array of column names
    const columnNames = schema.map(col => col.columnName);
   
    //Loop through each row and log the column name with its value
    rows.forEach(row => {
    const rowObject = {};
    row.forEach((value, index) => {
    const columnName = columnNames[index];
    rowObject[columnName] = value;
    });
    console.log(rowObject);
    })
    })
    .catch(error => {
    console.error('Error:', error);
    });
    

5. In the terminal, execute the following command to run the server:

   node server.js

   The query results will appear:

    { ID: 1, VALUE: -2 }
    { ID: 2, VALUE: 1 }
    { ID: 11, VALUE: null }
    { ID: 3, VALUE: 2 }
    { ID: 4, VALUE: 5 }
    ...

Simplified Access to Paylocity Data from Cloud Applications

At this point, you have a direct connection to live Paylocity data from Axios. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Axios, refer to our Connect AI page.