> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paylocity

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "Paylocity";
export const pageTitle = "Paylocity";
export const advancedurl = "KP";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Prerequisites

Before you can authenticate to {datasource} using OAuth, you must first obtain API access. To request access, contact [service@paylocity.com](mailto:service@paylocity.com) or [sales@paylocity.com](mailto:sales@paylocity.com).

Once your request is reviewed and approved, {datasource} provides OAuth credentials and grants you access either to a Sandbox or Production account. This access is required in order to authenticate your API requests.

Paylocity issues the following OAuth credentials:

* **client\_id:** The identifier (Id) that is assigned to your registered OAuth application in the {datasource} Developer Portal. Use this value to set the OAuth client Id.
* **secret:** The secret that is assigned to your registered OAuth application. Use this value to set the OAuth client secret. {datasource} requires secrets to be rotated every 365 days. You will receive reminder emails ten days and five days prior to expiration.

## Add the Paylocity Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to Paylocity

After you add the connector, you need to set the required properties.

* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

## Complete Your Connection

To complete your connection:

1. Specify the following properties:
   * (Optional) **Company Id:** Enter your company identifier.
   * (Optional) **RSA Public Key:** Enter the RSA key that is associated with your {datasource} account.
   * (Optional) **Key:** Enter the Base64-encoded AES symmetric key that is encrypted with the {datasource} public key.
   * **IV:** Enter the Base64-encoded AES initialization vector (IV) that is used when content is encrypted.
   * **Use Sandbox:** Select whether you want to enable the sandbox. By default, the **Enable** checkbox is not selected.
   * **Use Pay Entry API:** Select whether you want to use the Pay Entry API, which enables you to submit payroll information automatically for individual employees. By default, the **Enable** checkbox is not selected. If you do not enable this property, {siteNameShort} uses the standard {datasource} API.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />