Edit and Search External Paylocity Objects in Salesforce Connect

CData Connect AI, enables you to access Paylocity data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect AI and Salesforce Connect to access external Paylocity objects alongside standard Salesforce objects.

Connect to Paylocity from Salesforce

To work with live Paylocity data in Salesforce Connect, 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 Salesforce Connect

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 Salesforce Connect.

Connect to Paylocity Data as an External Data Sources

Follow the steps below to connect to the feed produced by Connect AI.

1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
2. Click Now External Data Sources.
3. Enter values for the following properties:
   • External Data Sources: Enter a label to be used in list views and reports.
   • Name: Enter a unique identifier.
   • Type: Select the option "Salesforce Connect: OData 4.0".
   • URL: Enter the URL to the OData endpoint of Connect AI: https://cloud.cdata.com/api/odata/{workspace_name}
4. Select the Writable External Objects option.
5. Select JSON in the Format menu.
6. In the Authentication section, set the following properties:
   • Identity Type: If all members of your organization will use the same credentials to access Connect AI, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
   • Authentication Protocol: Select Password Authentication to use basic authentication.
   • Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
   • Username: Enter a CData Connect AI username (e.g. [email protected]).
   • Password: Enter the user's PAT.

Synchronize Paylocity Objects

After you have created the external data source, follow the steps below to create Paylocity external objects that reflect any changes in the data source. You will synchronize the definitions for the Paylocity external objects with the definitions for Paylocity tables.

1. Click the link for the external data source you created.
2. Click Validate and Scan.
3. Select the Paylocity tables you want to work with as external objects.

Access Paylocity Data as Salesforce Objects

After adding Paylocity data as an external data source and syncing Paylocity tables as external objects, you can use the external Paylocity objects just as you would standard Salesforce objects.

• Create a new tab with a filter list view:

  👁 Viewing external objects from Salesforce (NetSuite is shown)
  

• Create reports of external objects:

  👁 Reporting on external objects from Salesforce (NetSuite is shown)
  

• Create, update, and delete Paylocity objects from the Salesforce dashboard:

  👁 Editing external objects from Salesforce (NetSuite is shown)
  

Simplified Access to Paylocity Data from Cloud Applications

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