Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Paylocity Data through External Services in Salesforce
Use CData Connect Cloud to securely provide OData feeds of Paylocity data to smart devices and cloud-based applications. Use the CData Connect and Salesforce Connect to create Paylocity Data objects that you can access from apps and the dashboard.
CData Connect Cloud, 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 Cloud to access Paylocity data through Salesforce External Services.
Connect to Paylocity from Salesforce
To work with live Paylocity data in Salesforce Connect, we need to connect to Paylocity from Connect Cloud, provide user access to the connection, and create OData endpoints for the Paylocity data.
(Optional) Add a New Connect Cloud User
As needed, create Users to connect to Paylocity through Connect Cloud.
- Navigate to the Users page and click Invite Users
- Enter the new user's email address and click Send to invite the user
- You can review and edit users from the Users page
Add a Personal Access Token
If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.
- Click on your username at the top right of the Connect Cloud app and click User Profile.
- On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
- Give your PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
Connect to Paylocity from Connect Cloud
CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.
- Log into Connect Cloud, click Connections and click Add Connection
- Select "Paylocity" from the Add Connection panel
-
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.
- RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.
- Click Create & Test
- Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.
Create an OpenAPI File for Paylocity
After connecting to Paylocity, create a workspace and virtual dataset for your desired table(s).
- Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
- Click Add to add new assets to the Workspace.
- Select the Paylocity connection (e.g. Paylocity1) and click Next.
- Select the table(s) you wish to work with and click Confirm.
- Configure the Open API options:
- Set Version to "3.0"
- Set Convert array types to strings to off
- Click Download to download the OpenAI JSON file.
With the connection configure and OpenAPI file downloaded, you are ready to connect to Paylocity data from Salesforce External Services.
Connect to Paylocity Data as an External Service
Follow the steps below to connect to the OpenAPI produced by Connect Cloud.
- Log into Salesforce and navigate to Salesforce Setup.
- Select Platform Tools -> Integrations -> External Services.
- Click Add an External Service.
- Click Select an API source from API Specification and click Next.
- In Provide Registration Details, enter the following:
- External Service Name — an identifying name for your external service.
- Description — a description of your external service.
- Service Schema — select Upload from local.
- Select a Named Credential — select the named credential you created.
- Upload the JSON file you downloaded from CData Connect.
- If the schema validation was successful, click Save & Next.
The next step is Select Operations. These operations are all the actions of the connector that are contained in the OpenAPI specification file. The actions include all the functions you need for the table, including list, get, create, update, and delete records. The actions include a description, input parameters, and output parameters.
The input parameters are appended to the URL, such as $top, $filter, and $orderby. See API Operations for a complete parameter reference. The input parameters are based on OData filtering.
Select the operations you want to include in the external service.
- Review the actions for your external service, including the input and output parameters. If you need to change input or output parameters, you need to edit the OpenAPI specification file.
- Click Finish. Your external service appears in the list of external services for Salesforce and is now available to build flows.
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 Cloud page.