Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial

Connect to Paylocity Data in RunMyProcess through Connect Cloud



Use CData Connect Cloud to create on OData API for Paylocity Data and connect to Paylocity data in Akorbi Digital RunMyProcess.

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect Cloud creates a live connection to Paylocity and can be used to generate an OData API (natively supported in RunMyProcess) for Paylocity. By pairing RunMyProcess with CData Connect Cloud, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect Cloud from RunMyProcess as you would any other REST service and get instant, live access to your Paylocity data.

In this article, we walk through connecting to Paylocity from CData Connect Cloud and accessing Paylocity data through an OData feed in RunMyProcess.

Connect to Paylocity from RunMyProcess

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

  1. Navigate to the Users page and click Invite Users
  2. Enter the new user's email address and click Send to invite the user
  3. 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.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your PAT a name and click Create.
  4. 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.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Paylocity" from the Add Connection panel
  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.

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add Paylocity OData Endpoints in Connect Cloud

After connecting to Paylocity, create OData Endpoints for the desired table(s).

  1. Navigate to the OData page and click Add to create new OData endpoints
  2. Select the Paylocity connection (e.g. Paylocity1) and click Next
  3. Select the table(s) you wish to work with and click Confirm

Sample URLs for OData Feeds

Once you have configured a connection to Paylocity, created a user, and created OData endpoints in Connect Cloud, you can access OData feeds for Paylocity data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the OData page for Connect Cloud. For the URLs, you will need the URL of Connect Cloud: https://cloud.cdata.com/api/odata/service.

Table         URL
Entity (table) List https://cloud.cdata.com/api/odata/service/
Metadata https://cloud.cdata.com/api/odata/service/$metadata
Employee https://cloud.cdata.com/api/odata/service/Employee

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

With the connection and OData endpoints configured, you are ready to connect to Paylocity data from RunMyProcess.

Retrieve Paylocity Data from RunMyProcess DigitalSuite Studio

With the connection to Paylocity and OData endpoints created, we are ready to add Paylocity data to RunMyProcess for Retrieval.

Create a Provider

  1. Log into RunMyProcess and open DigitalSuite Studio.
  2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab.
  3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm.
  4. In the provider settings page, configure the following properties.
    • URL: Set the OData endpoint in the Connect Cloud OData page: https://cloud.cdata.com/api/odata/service.
    • Authentication Schema: Select Login/Password.
    • Login: Specify a CData Connect Cloud username (e.g. [email protected]).
    • Password: Specify the PAT of the Connect Cloud user.
  5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
  6. Click Save to save the properties.

Retrieve Paylocity Data by Creating a Connector

  1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
  2. In the following page, set Connector URL to the OData endpoint configured in Connect Cloud (e.g. https://cloud.cdata.com/api/odata/service)
  3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information.

More Information & Free Trial

Now, you have created a provider and connector to retrieve Paylocity data. For more information on creating OData feeds from Paylocity (and more than 100 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live Paylocity data in RunMyProcess.