Paylocity Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.9039 of the connector.

Get Started

Paylocity Version Support

The connector leverages the Paylocity API to enable bidirectional access to Paylocity.

Establish a Connection

Connect to Paylocity

Paylocity provides two ways to connect: via the Pay Entry API, and via the standard Paylocity API.

Before you connect, set these properties (if applicable):

• If you are using a Sandbox account, set UseSandbox to true; otherwise, false.
• If IncludeCustomFields is true, set CustomFieldsCategory to the Customfields category. The default value for this property is PayrollAndHR.

For sites that have opted-in to encryption:

• Set only one of the following encryption properties:
  • Key: The AES symmetric key (base 64 encoded) is encrypted with the Paylocity Public Key. This key is used to encrypt Paylocity content. Paylocity decrypts the AES key using RSA decryption.
    Used if the IV value is not provided.
  • IV: The AES IV (base 64 encoded) used when encrypting Paylocity. If no Key value is provided, IV is generated internally.
• If RSA encryption is enabled in your Paylocity account, set RSAPublicKey to the RSA Key associated with your Paylocity. (This property is required for executing Insert and Update statements.) If the feature is disabled, it is not required.

The Pay Entry API

The Pay Entry API is an extremely limited connection that enables users 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, it does not have a seaparate schema. However, it can be

enabled via the UsePayEntryAPI connection property.

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.

Note that when setting UsePayEntryAPI to true, you may only use the following stored procedures:

• CreatePayEntryImportBatch
• MergePayEntryImportBatch
• Input_TimeEntry
• available OAuth stored procedures

Attempts to use other features of the product will result in an error.

Also, the OAuthAccessToken you obtain for use with the Pay Entry API must be stored separately. This often requires you to set a different OAuthSettingsLocation when using this connection property.

Authenticate to Paylocity

Paylocity supports OAuth authentication for all connections to data, from either Pay Entry API or the standard Payloticity API. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to Paylocity from the three most common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Paylocity, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

• InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId = the client ID assigned when you registered your application.
• OAuthClientSecret = the client secret that was assigned when you registered your application.
• CallbackURL = the redirect URI that was defined when you registered your application.

When you connect, the connector opens Paylocity's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector then completes the OAuth process:

1. The connector obtains an access token from Paylocity and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. Before connecting to data for the first time, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client ID in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client ID in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.
3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Paylocity connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Paylocity and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Paylocity connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Employee WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Client SSL Certificates

The Paylocity connector also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Paylocity APIs.

Key Features

• The connector models Paylocity entities like documents, folders, and groups as relational views, allowing you to write SQL to query Paylocity data.
• Stored procedures allow you to execute operations to Paylocity.
• Live connectivity to these objects means any changes to your Paylocity account are immediately reflected when using the connector.

Tables

Tables describes the available tables. Tables are statically defined to model resources such as Earnings, LocalTaxes, and EmployeeDetails.

Views

Views describes the available views. Views are statically defined to model resources such as Employees, CompanyCodes, and CustomFields.

Stored Procedures

Stored Procedures are function-like interfaces to Paylocity. Stored procedures allow you to execute operations to Paylocity, including downloading documents and moving envelopes.

Tables

The connector models the data in Paylocity as a list of tables in a relational database that can be queried using standard SQL statements.

Paylocity Connector Tables

AdditionalRates

Add/update additional rates

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM AdditionalRates WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into AdditionalRates table. For example:

INSERT INTO AdditionalRates (employeeid, Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ('123', '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')

Update

Following is an example of how to Update a AdditionalRates table:

UPDATE AdditionalRates SET CostCenter1 = '100', ratecode = 'CN', rate = 100, rateper = 'hour' WHERE employeeId = '123'

Columns

Earnings

Get All Earnings. Delete Earning by Earning Code and Start Date. Add/Update Earning. Get Earnings by Earning Code. Get Earning by Earning Code and Start Date

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.
• EarningCode supports the '=' comparison.
• StartDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Earnings WHERE EmployeeId = '123'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098' AND StartDate = '2019-04-01'

Insert

Following is an example of how to inserting into Earnings table. For example:

INSERT INTO Earnings (EmployeeId, EarningCode, StartDate) VALUES ('999621027', '1098', '2020-02-10')

Update

Following is an example of how to update a Earnings table:

UPDATE Earnings SET EarningCode = '1098', StartDate = '2020-02-09' WHERE employeeId = '999621027'

Delete

Following is an example of how to delete earnings in the Earnings table:

DELETE FROM Earnings WHERE employeeId = '123' AND EarningCode = '1' AND StartDate = '2021-01-01'

Columns

EmergencyContacts

Add/update emergency contacts

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM EmergencyContacts WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into EmergencyContacts table. For example:

INSERT INTO EmergencyContacts (EmployeeId, firstName, lastName, primaryPhone, priority, relationship, MobilePhone, Zip, Notes, Address1, City, County) VALUES ('123', 'firstName', 'lastName', 'M', 'P', 'Brother', 9876543210, 75791, 'Test Notes', 'Address Line1', 'NY', 'USA')

Update

Following is an example of how to Update a EmergencyContacts table:

UPDATE EmergencyContacts SET WorkPhone = '9876543210', firstName = 'firstName', lastName = 'lastName', primaryPhone = 'W', priority = 'S', relationship = 'brother' WHERE employeeId = '999621027'

Columns

EmployeeBenefitSetup

Add/update employee's benefit setup

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM EmployeeBenefitSetup WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into EmployeeBenefitSetup table. For example:

INSERT INTO EmployeeBenefitSetup (EmployeeId, BenefitSalary, BenefitClass, BenefitSalaryEffectiveDate, BenefitClassEffectiveDate) VALUES ('123', '250', 'FULL', '2021-02-10', '2021-02-10')

Update

Following is an example of how to Update a EmployeeBenefitSetup table:

UPDATE EmployeeBenefitSetup SET BenefitSalary = '250', BenefitClass = 'FULL', BenefitClassEffectiveDate = '2021-02-10', BenefitSalaryEffectiveDate = '2021-02-10' WHERE EmployeeId = '123'

Columns

EmployeeDetails

Add new employee. Get employee. Update employee

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Employee WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into Employee table with aggregate column(Optional). For example:

INSERT INTO AdditionalRates#TEMP (Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ( '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')

INSERT INTO Employee (FirstName, LastName, MiddleName, Gender, MaritalStatus, PreferredName, PriorLastName, Salutation, Currency, BirthDate, CompanyFEIN, CompanyName, DepartmentPositionChangeReason, DepartmentPositionCostCenter1, DepartmentPositionCostCenter2, DepartmentPositionCostCenter3, DepartmentPositionEffectiveDate, DepartmentPositionEmployeeType, DepartmentPositionIsMinimumWageExempt, DepartmentPositionIsOvertimeExempt, DepartmentPositionIsSupervisorReviewer, DepartmentPositionIsUnionDuesCollected, DepartmentPositionIsUnionInitiationCollected, DepartmentPositionJobTitle, FederalTaxAmount, FederalTaxExemptions, FederalTaxFilingStatus, FederalTaxPercentage, FederalTaxTaxCalculationCode, FederalTaxW4FormYear, HomeAddressAddress1, HomeAddressAddress2, HomeAddressCity, HomeAddressCountry, HomeAddressEmailAddress, HomeAddressMobilePhone, HomeAddressPhone, HomeAddressPostalCode, HomeAddressState, NonPrimaryStateTaxFilingStatus, NonPrimaryStateTaxHigherRate, NonPrimaryStateTaxOtherIncomeAmount, NonPrimaryStateTaxReciprocityCode, NonPrimaryStateTaxtaxCode, PrimaryPayRateAnnualSalary, PrimaryPayRateBaseRate, PrimaryPayRateChangeReason, PrimaryPayRateDefaultHours, PrimaryPayRateEffectiveDate, PrimaryPayRatePayFrequency, PrimaryPayRatePayType, PrimaryStateTaxAmount, PrimaryStateTaxExemptions, PrimaryStateTaxExemptions2, PrimaryStateTaxPercentage, PrimaryStateTaxFilingStatus, PrimaryStateTaxTaxCalculationCode, PrimaryStateTaxTaxCode, PrimaryStateTaxW4FormYear, StatusAdjustedSeniorityDate, StatusChangeReason, StatusEffectiveDate, StatusEmployeeStatus, StatusHireDate, StatusIsEligibleForRehire, TaxSetupSuiState, TaxSetupTaxForm, WorkAddressAddress1, WorkAddressCity, WorkAddressCountry, WorkAddressMobilePhone, WorkAddressPostalCode, WorkAddressState, suffix, IsSmoker, AdditionalRate) VALUES ('TestFirstName1', 'TestLastName', 'TestMiddleName', 'M', 'S', 'Test1', 'TestPrior', 'Mr', 'USD', '1985-11-01', '00-5554442', 'SusanW  Z2222 Clone', 'New Hire', '100', '101', '100', '2021-02-01', 'RFT', false, true, false, false, false, 'Clinical Psychologist', '1', '0', 'M', '1', 'AFAP', '2021', 'TestAddr1', 'TestAddr2', 'NewJordi', 'USA', 'test@test.com', '(961)062-1234', '(588)148-1234', '75791', 'NY', 'M', 'false', 0, 'Both', 'NY', '1000', '100', 'New Hire', '8', '2021-02-01', 'M', 'Salary', '1', '0', '0', 5, 'S', 'AFAP', 'AZ', '2019', '2021-02-01', 'New Hire', '2021-02-01', 'A', '2021-02-01', true, 'NY', 'W2', '78FraleighStreet', 'RedHook', 'USA', '(276)369-1234', '12571', 'NY', 'Jr.', true, 'AdditionalRates#TEMP')

Update

Following is an example of how to Update a Employee table:

UPDATE Employee SET PriorLastName = 'PriorLastName', [CF_PayrollAndHR_Full Computer Access] = true WHERE EmployeeId = '123'

Columns

Input_TimeEntry

To create the csv content for the CreatePayEntryImportBatch.TimeEntry using this as a TEMP Table. When the connection to Paylocity is closed, all tables names started with Input are cleared.

Columns

LocalTaxes

Get local taxes by tax code. Get all local taxes. Add new local tax. Delete local tax by tax code

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.
• TaxCode supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM LocalTaxes WHERE EmployeeId = '123'

SELECT * FROM LocalTaxes WHERE EmployeeId = '123' AND TaxCode = 'AL-BIR1'

Insert

Following is an example of how to inserting into LocalTaxes table. For example:

INSERT INTO LocalTaxes (EmployeeId, TaxCode, FilingStatus) VALUES ('999621027', 'AL-BIR1', 'N/A')

Delete

Following is an example of how to Delete LocalTaxes from the table:

DELETE FROM LocalTaxes WHERE employeeId = '123' AND TaxCode = 'AL-BIR1'

Columns

NonPrimaryStateTax

Add/update non-primary state tax

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM NonPrimaryStateTax WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into Non-PrimaryStateTax table. For example:

INSERT INTO [NonPrimaryStateTax] (Employeeid, TaxCalculationCode, Amount, TaxCode, ReciprocityCode, FilingStatus, W4FormYear, Percentage, Exemptions) VALUES ('123', 'AFAP', 50, 'NY', 'Both', 'M', 2019, 1.5, 5)

Update

Following is an example of how to Update a Non-PrimaryStateTax table:

UPDATE [NonPrimaryStateTax] SET Percentage = 2.5, Exemptions = 10 WHERE employeeId = '123'

Columns

PrimaryStateTax

Add/update primary state tax

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PrimaryStateTax WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into PrimaryStateTax table. For example:

INSERT INTO PrimaryStateTax (Employeeid, FilingStatus, TaxCalculationCode, Exemptions, Exemptions2, Percentage, W4FormYear, TaxCode, Amount) VALUES ('999621027', 'MS', 'AFAP', 10, 15, 5, 2019, GA, 100)

Update

Following is an example of how to Update a PrimaryStateTax table:

UPDATE PrimaryStateTax SET Exemptions = 20, Amount = 125 WHERE employeeId = '123'

Columns

SensitiveData

Gets employee sensitive data information directly from Web Pay.

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SensitiveData WHERE EmployeeId = '1234'

Insert

Following is an example of how to Insert into SensitiveData table.

INSERT INTO SensitiveData (EmployeeId, Disability, DisabilityClassifications, HasDisability, IsVeteran) VALUES ('1234', 'ads', 'dawd, afsc', '1', '0')

Update

Following is an example of how to Update a SensitiveData table:

UPDATE SensitiveData SET Disability = 'ads', DisabilityClassifications = 'dawd,afsc', HasDisability = '1' WHERE EmployeeId = '1234'

Columns

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Paylocity Connector Views

CompanyCodes

Get All Company Codes

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• codeResource supports the '=' comparison.

In the case of simple SELECTs, the CodeResource value will be considered as costCenter1. For example, the following queries are processed server side:

SELECT * FROM CompanyCodes WHERE codeResource = 'costCenter1'

Columns

CustomFields

Get All Custom Fields

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• category supports the '=' comparison.

In the case of simple SELECTs, the Category value will be considered as PayrollAndHR. For example, the following queries are processed server side:

SELECT * FROM CustomFields WHERE Category = 'PayrollAndHR'

Columns

DirectDeposit

Get All Direct Deposit

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM DirectDeposit WHERE EmployeeId = '123'

Columns

Employees

Get all employee info

Table Specific Information

Select

The Paylocity does not support any column for filtering this table. All filters will be executed client side.

Columns

PayStatementsdetails

Get employee pay statement details data for the specified year.. Get employee pay statement details data for the specified year and check date.

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.
• Year supports the '=' comparison.
• CheckDate supports the '=' comparison.

In the case of simple SELECT the Paylocity will return present and last year records. For example, the following queries are processed server side:

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019 AND CheckDate = '2019-02-01'

Columns

PayStatementssummary

Get employee pay statement summary data for the specified year.. Get employee pay statement summary data for the specified year and check date.

Table Specific Information

Select

The connector will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• EmployeeId supports the '=' comparison.
• Year supports the '=' comparison.
• CheckDate supports the '=' comparison.

In the case of simple SELECTs, the Paylocity will return records from the current and previous year.

For example, the following queries are processed server side:

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019 AND CheckDate = '2019-02-01'

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Paylocity.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Paylocity, along with an indication of whether the procedure succeeded or failed.

Paylocity Connector Stored Procedures

CreatePayEntryImportBatch

Create or merge Pay Entry Time Tracking Batch.

Stored Procedures Specific Information

In order to insert into CreatePayEntryImportBatch, you must submit the TimeEntry details and a Pay Period. The TimeEntry details may be submitted via a Temp table by first inserting to the Input_TimeEntry input only table. The Pay Period may be specified by setting the PayPeriodBeginDate, PayPeriodEndDate, and CheckDate. Alternatively, the CalendarId may be specified. For example:

INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623635, 'E', 'REG', 40.00, 30, '2021-08-08', '2021-08-14')
INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623636, 'E', 'REG', 40.00, 25, '2021-08-08', '2021-08-14')

EXECUTE CreatePayEntryImportBatch TimeEntry = 'Input_TimeEntry#TEMP', AutoAcknowledge = 'true', BatchName = 'Test', PayPeriodBeginDate = '2021-08-15', PayPeriodEndDate = '2021-08-21', CheckDate = '2021-08-27'

To fetch the processed data information, use the below query.

SELECT * FROM LastResultInfo#TEMP

Input

Result Set Columns

CreateSchema

Creates a schema definition of a table in Paylocity.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The connector checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the connector.

Input

Result Set Columns

GetOAuthAccessToken

Gets an authentication token from Paylocity.

Result Set Columns

MergePayEntryImportBatch

This is used to create or merge a batch when the Pay Entry Import Status is halted at TimeClockValidationPendingAcknowledgement.

Stored Procedures Specific Information

TimeImportFileTrackingId is required to execute this procedure. The TimeImportFileTrackingId will be generated as the response of CreatePayEntryImportBatch Stored Procedure. For example:

EXECUTE MergePayEntryImportBatch TimeImportFileTrackingId = 'e84b3808-4477-423a-89bf-e32f58c0e685'

Input

Result Set Columns

OnBoardingEmployee

Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Web Pay.

Stored Procedures Specific Information

Paylocity allows multiple columns to be used in the Exec query. These columns can typically be used with only = comparison. FirstName and LastName params are required to execute this procedure. For example:

EXECUTE OnBoardingEmployee FirstName = 'EmpFirstName', LastName = 'EmpLastName', BaseRate = 350.0, CostCenter1 = '100', DefaultHours = '9', EmployeeStatus = 'A', MaritalStatus = 'S'

Input

Result Set Columns

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with Paylocity.

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Paylocity:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Employee table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Employee'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateSchema stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateSchema' AND Direction=1 OR Direction=2

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Employee table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Employee'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:paylocity:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Connection

OAuth

SSL

Schema

Miscellaneous

Connection

This section provides a complete list of connection properties you can configure.

CompanyId

The ID of the company file.

Data Type

string

Default Value

""

Remarks

The ID of the company file.

CustomFieldsCategory

The custom field category in the company.

Data Type

string

Default Value

PayrollAndHR

Remarks

Add comma separated values to set more than one custom fields category. The following is an example of a custom field category:

• PayrollAndHR

UseSandbox

Set to true if you you are using sandbox account.

Data Type

bool

Default Value

false

Remarks

Set to true if you you are using sandbox account.

RSAPublicKey

Set this to the public key shared by Paylocity.

Data Type

string

Default Value

""

Remarks

Either enter the key value or complete path of the file. This is required for executing Insert and Update statements.

Key

The secret key for the symmetric algorithm.

Data Type

string

Default Value

""

Remarks

The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. Paylocity will decrypt the AES key using RSA decryption and use it to decrypt the content. It is an optional property if the IV value is not provided. In this case, the driver will generate a key internally.

IV

The initialization vector (IV).

Data Type

string

Default Value

""

Remarks

The AES IV (base 64 encoded) used when encrypting the content. If you have set the Key, this property is optional because the driver generates an IV internally.

UsePayEntryAPI

Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

Data Type

bool

Default Value

false

Remarks

Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\Paylocity Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\Paylocity Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

SSLClientCert

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

SSLClientCertType

The type of key store containing the TLS/SSL client certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

SSLClientCertPassword

The password for the TLS/SSL client certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

SSLClientCertSubject

The subject of the TLS/SSL client certificate.

Data Type

string

Default Value

*

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.

If a field value contains a comma, it must be quoted.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\Paylocity Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\Paylocity Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Employee WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.