CData Sync App は、Paylocity データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Paylocity コネクタはCData Sync アプリケーションから使用可能で、Paylocity からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はPaylocity API を使用して、Paylocity への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Paylocity は、Pay Entry API 経由と標準のPaylocity API 経由の2つの接続方法を提供します。
接続する前に、次のプロパティを設定します（該当する場合）。
暗号化をオプトインしているサイトの場合：
Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。
UsePayEntryAPI をtrue に設定する場合は、以下のストアドプロシージャのみ利用できることに注意してください。
また、Pay Entry API で使用するために取得したOAuthAccessToken は、別途保存する必要があります。このため、この接続プロパティを使用する際には、別のOAuthSettingsLocation の設定が必要になることがよくあります。
以下のサブセクションでは、3つの最も一般的な認証フローでのPaylocity への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Paylocity で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
OAuth アクセストークンの自動リフレッシュ：
Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
OAuth アクセストークンの手動リフレッシュ：
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
このセクションでは、Paylocity Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Paylocity にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Paylocity Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Paylocity API へのSQL の実行について詳しく説明します。
テーブル では、利用可能なテーブルを説明します。テーブルは、Earnings、LocalTaxes、およびEmployeeDetails などを静的にモデル化するように定義されています。
ビュー では、利用可能なビューを説明します。ビューは、Employees、CompanyCodes、およびCustomFields などのリソースを静的にモデル化するように定義されています。
ストアドプロシージャ は、Paylocity のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Paylocity の操作を実行できます。
Sync App はPaylocity のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| AdditionalRates | Add/update additional rates |
| 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 |
| EmergencyContacts | Add/update emergency contacts |
| EmployeeBenefitSetup | Add/update employee's benefit setup |
| EmployeeDetails | Add new employee. Get employee. Update employee |
| 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. |
| LocalTaxes | Get local taxes by tax code. Get all local taxes. Add new local tax. Delete local tax by tax code |
| NonPrimaryStateTax | Add/update non-primary state tax |
| PrimaryStateTax | Add/update primary state tax |
| SensitiveData | Gets employee sensitive data information directly from Web Pay. |
Add/update additional rates
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM AdditionalRates WHERE EmployeeId = '123'
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')
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'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| CostCenter1 | String | False |
Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 1 drop down. This cell must be in a text format. | |
| CostCenter2 | String | False |
Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 2 drop down. This cell must be in a text format. | |
| CostCenter3 | String | False |
Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 3 drop down. This cell must be in a text format. | |
| RatePer | String | False |
Required. Valid values are HOUR or WEEK. | |
| Rate | Decimal | False |
Required. Enter dollar amount that corresponds to the Per selection. | |
| RateCode | String | False |
Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down. | |
| ChangeReason | String | False |
Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down. | |
| EffectiveDate | Date | False |
Required. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| EndCheckDate | Date | False |
Not required. Must match one of the system coded check dates available in the Additional Rates End Check Date drop down. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| RateNotes | String | False |
Not required. | |
| Job | String | False |
Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down. | |
| Shift | String | False |
Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down. | |
| CompanyId | String | True |
Id of the Company. |
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
The Sync App 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 Sync App.
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'
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')
Following is an example of how to update a Earnings table:
UPDATE Earnings SET EarningCode = '1098', StartDate = '2020-02-09' WHERE employeeId = '999621027'
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'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| PaidTowardsGoal | Decimal | False |
Amount already paid to employee toward goal. Decimal(12,2) | |
| MiscellaneousInfo | String | False |
Information to print on the check stub if agency is set up for this earning. | |
| EffectiveDate | Date | False |
Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD. | |
| CostCenter1 | String | False |
Cost Center associated with earning. Must match Company setup. | |
| CostCenter2 | String | False |
Cost Center associated with earning. Must match Company setup. | |
| CostCenter3 | String | False |
Cost Center associated with earning. Must match Company setup. | |
| AnnualMaximum | Decimal | False |
Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums. Decimal(12,2) | |
| IsSelfInsured | Bool | False |
Used for ACA. If not entered, defaulted to Company earning setup. | |
| Rate | Decimal | False |
Rate is used in conjunction with the hoursOrUnits field. Decimal(12,2) | |
| Frequency | String | False |
Needed if earning is applied differently from the payroll frequency (one time earning for example). | |
| EndDate | Date | False |
Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD. | |
| HoursOrUnits | Decimal | False |
The value is used in conjunction with the Rate field. When entering Group Term Life Insurance (GTL), it should contain the full amount of the group term life insurance policy. Decimal(12,2) | |
| EarningCode | String | False |
Earning code. Must match Company setup. | |
| RateCode | String | False |
Rate Code applies to additional pay rates entered for an employee. Must match Company setup. | |
| Goal | Decimal | False |
Dollar amount. The employee earning will stop when the goal amount is reached. Decimal(12,2) | |
| CalculationCode | String | False |
Defines how earnings are calculated. Common values are *% (percentage of gross), flat (flat dollar amount)*. Defaulted to the Company setup calcCode for earning. | |
| StartDate | Date | False |
Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD. | |
| PayPeriodMaximum | Decimal | False |
Maximum amount of the earning on a single paycheck. Decimal(12,2) | |
| JobCode | String | False |
Job code associated with earnings. Must match Company setup. | |
| Amount | Decimal | False |
Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%). Decimal(12,2) | |
| Agency | String | False |
Third-party agency associated with earning. Must match Company setup. | |
| PayPeriodMinimum | Decimal | False |
Minimum amount of the earning on a single paycheck. Decimal(12,2) | |
| CompanyId | String | True |
Id of the Company. |
Add/update emergency contacts
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM EmergencyContacts WHERE EmployeeId = '123'
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')
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'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| FirstName | String | False |
Required. Contact first name. | |
| LastName | String | False |
Required. Contact last name. | |
| MobilePhone | String | False |
Contact Mobile Phone.Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed. | |
| Zip | String | False |
Postal code. If U.S. address, must be a valid zip code. | |
| Priority | String | False |
Required. Contact priority. Valid values are *P* (Primary) or *S* (Secondary). | |
| Notes | String | False |
Notes. | |
| Address1 | String | False |
1st address line. | |
| Pager | String | False |
Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed. | |
| WorkPhone | String | False |
Contact Work Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed. | |
| PrimaryPhone | String | False |
Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work) | |
| Address2 | String | False |
2nd address line. | |
| HomePhone | String | False |
Contact Home Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed. | |
| WorkExtension | String | False |
Work Extension. | |
| SyncEmployeeInfo | Bool | False |
Valid values are *true* or *false*. | |
| City | String | False |
City. | |
| Country | String | False |
County. | |
| Relationship | String | False |
Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father. | |
| County | String | False |
Country. Must be a valid 3 character country code. Common values are *USA* (United States), *CAN* (Canada). | |
| String | False |
Contact email. Must be valid email address format. | ||
| State | String | False |
State or Province. If U.S. address, must be valid 2 character state code. Common values are *IL* (Illinois), *CA* (California). | |
| CompanyId | String | True |
Id of the Company. |
Add/update employee's benefit setup
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM EmployeeBenefitSetup WHERE EmployeeId = '123'
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')
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'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| BenefitSalary | Decimal | False |
Salary used to configure benefits.Decimal(12,2) | |
| BenefitClass | String | False |
Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes. | |
| BenefitSalaryEffectiveDate | Date | False |
Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| DoNotApplyAdministrativePeriod | Bool | False |
Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time. | |
| IsMeasureAcaEligibility | Bool | False |
Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time. | |
| BenefitClassEffectiveDate | Date | False |
Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| CompanyId | String | True |
Id of the Company. |
Add new employee. Get employee. Update employee
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM Employee WHERE EmployeeId = '123'
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', '[email protected]', '(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')
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'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | False |
Leave blank to have Web Pay automatically assign the next available employee ID. | |
| PreferredName | String | False |
Employee preferred display name. | |
| FirstName | String | False |
Employee first name. | |
| LastName | String | False |
Employee last name. | |
| MiddleName | String | False |
Employee middle name. | |
| WebTimeChargeRate | Decimal | False |
Rate to be charged to third party for time worked by the employee. It is most commonly referenced in the Cost Center Charge, Cost Center Charge vs. Cost Reports, and the Customer Invoice time and attendance reports. Decimal (12,2) | |
| WebTimeIsTimeLaborEnabled | Bool | False |
If set to true, changes to employee data will be reflected in Web Time. | |
| WebTimeBadgeNumber | String | False |
Badge number usually issued for time and attendance system use. | |
| WorkAddressCountry | String | False |
Country. | |
| WorkAddressAddress1 | String | False |
1st address line. | |
| WorkAddressPager | String | False |
Employee pager number. | |
| WorkAddressState | String | False |
State or province. | |
| WorkAddressMailStop | String | False |
Employee mail stop. | |
| WorkAddressEmailAddress | String | False |
Email. | |
| WorkAddressCity | String | False |
City. | |
| WorkAddressPhoneExtension | String | False |
Phone number extension. | |
| WorkAddressLocation | String | False |
Work Location name. | |
| WorkAddressPostalCode | String | False |
Postal code. | |
| WorkAddressCounty | String | False |
County. | |
| WorkAddressAddress2 | String | False |
2nd address line. | |
| WorkAddressMobilePhone | String | False |
Mobile phone number. | |
| WorkAddressPhone | String | False |
Phone number. | |
| Currency | String | False |
Employee is paid in this currency. | |
| EmergencyContacts | String | False |
Add or update Emergency Contacts. | |
| OwnerPercent | Decimal | False |
Percentage of employee's ownership in the company, entered as a whole number. Decimal (12,2) | |
| CustomTextFields | String | False |
Up to 8 custom fields of text type value. | |
| NonPrimaryStateTaxExemptions | Decimal | False |
State tax exemptions value.Decimal (12,2) | |
| NonPrimaryStateTaxOtherIncomeAmount | Decimal | False |
Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2) | |
| NonPrimaryStateTaxAmount | Decimal | False |
State tax code. | |
| NonPrimaryStateTaxDependentsAmount | Decimal | False |
Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2) | |
| NonPrimaryStateTaxDeductionsAmount | Decimal | False |
Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2) | |
| NonPrimaryStateTaxTaxCalculationCode | String | False |
Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage). | |
| NonPrimaryStateTaxPercentage | Decimal | False |
State Tax percentage. Decimal (12,2) | |
| NonPrimaryStateTaxW4FormYear | Int | False |
The state W4 form year Integer | |
| NonPrimaryStateTaxExemptions2 | Decimal | False |
State tax exemptions 2 value.Decimal (12,2) | |
| NonPrimaryStateTaxFilingStatus | String | False |
Employee state tax filing status. Common values are *S* (Single), *M* (Married). | |
| NonPrimaryStateTaxHigherRate | Bool | False |
Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean | |
| NonPrimaryStateTaxTaxCode | String | False |
State tax code. | |
| NonPrimaryStateTaxReciprocityCode | String | False |
Non-primary state tax reciprocity code. | |
| NonPrimaryStateTaxSpecialCheckCalc | String | False |
Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code). | |
| DepartmentPositionPositionCode | String | False |
Employee position code. Must match Company setup. | |
| DepartmentPositionShift | String | False |
Employee work shift. | |
| DepartmentPositionCostCenter1 | String | False |
Employer defined location, like *branch, division, department*, etc. Must match Company setup. | |
| DepartmentPositionIsSupervisorReviewer | Bool | False |
Indicates if employee is a supervisor or reviewer. | |
| DepartmentPositionIsUnionDuesCollected | Bool | False |
Indicates if union dues are collected. | |
| DepartmentPositionIsMinimumWageExempt | Bool | False |
Indicates if employee is exempt from minimum wage. | |
| DepartmentPositionUnionCode | String | False |
Employee union code. Must match Company setup. | |
| DepartmentPositionSupervisorCompanyNumber | String | False |
Supervisor's company number. Defaults to employee company number. | |
| DepartmentPositionJobTitle | String | False |
Employee current job title. | |
| DepartmentPositionUnionPosition | String | False |
Employee union position. Must match Company setup. | |
| DepartmentPositionCostCenter2 | String | False |
Employer defined location, like *branch, division, department*, etc. Must match Company setup. | |
| DepartmentPositionIsOvertimeExempt | Bool | False |
Indicates if employee is exempt from overtime. | |
| DepartmentPositionEffectiveDate | Date | False |
The date the position takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| DepartmentPositionCostCenter3 | String | False |
Employer defined location, like *branch, division, department*, etc. Must match Company setup. | |
| DepartmentPositionEqualEmploymentOpportunityClass | String | False |
Values are configured in Company > Setup > HR > EEO Classes. | |
| DepartmentPositionClockBadgeNumber | String | False |
Employee clock badge number. Defaults to employeeId. | |
| DepartmentPositionReviewerEmployeeId | String | False |
Employee id of the reviewer. | |
| DepartmentPositionTipped | String | False |
Indicates if employee receives tips. | |
| DepartmentPositionReviewerCompanyNumber | String | False |
Company number of reviewer. | |
| DepartmentPositionIsUnionInitiationCollected | Bool | False |
Indicates if initiations fees are collected. | |
| DepartmentPositionSupervisorEmployeeId | String | False |
EmployeeId of the supervisor. | |
| DepartmentPositionChangeReason | String | False |
Employee department/position change reason. Must match Company setup. | |
| DepartmentPositionEmployeeType | String | False |
Employee current employment type. Common values *RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*. | |
| DepartmentPositionWorkersCompensation | String | False |
Employee worker compensation code. Must match Company setup. | |
| DepartmentPositionUnionAffiliationDate | Date | False |
Employee union affiliation effective date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| DepartmentPositionPayGroup | String | False |
Employee pay group. Must match Company setup. | |
| DisabilityDescription | String | False |
Indicates if employee has disability status. | |
| Ethnicity | String | False |
Employee ethnicity. | |
| AdditionalRate | String | False |
Add Additional Rates. | |
| CustomBooleanFields | String | False |
Up to 8 custom fields of boolean (checkbox) type value. | |
| AdditionalDirectDeposit | String | False |
Add up to 19 direct deposit accounts in addition to the main direct deposit account. IMPORTANT: A direct deposit update will remove ALL existing main and additional direct deposit information in WebPay and replace with information provided on the request. GET API will not return direct deposit data. | |
| CustomDropDownFields | String | False |
Up to 8 custom fields of the dropdown type value. | |
| CompanyFEIN | String | False |
Company FEIN as defined in Web Pay, applicable with GET requests only. | |
| Suffix | String | False |
Employee name suffix. Common values are *Jr, Sr, II*. | |
| MainDirectDepositNameOnAccount | String | False |
Name on the bank account. Defaults to employee's name. | |
| MainDirectDepositRoutingNumber | String | False |
ABA Transit Routing Number, entered without dashes or spaces. | |
| MainDirectDepositBlockSpecial | Bool | False |
Indicates if direct deposit should be blocked when special check types such as Bonus are processed. | |
| MainDirectDepositIsSkipPreNote | Bool | False |
Indicates if account will not pre-note. | |
| MainDirectDepositAccountNumber | String | False |
Account number, entered without special characters and spaces. | |
| MainDirectDepositAccountType | String | False |
Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card). | |
| MainDirectDepositPreNoteDate | Date | False |
Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| WorkEligibilityIsSsnVerified | Bool | False |
Indicates if employee SSN is verified. | |
| WorkEligibilityForeignPassportNumber | String | False |
Foreign Passport Number. | |
| WorkEligibilityIsI9Verified | Bool | False |
Indicates if employee I9 is verified. | |
| WorkEligibilityAlienOrAdmissionDocumentNumber | String | False |
Employee USCIS or Admission Number. Must be 7-10 characters and may begin with an 'A' | |
| WorkEligibilityI9Notes | String | False |
Notes regarding employee's i9. | |
| WorkEligibilityVisaType | String | False |
Employee Visa type. Must match one of the system coded values. | |
| WorkEligibilityWorkAuthorization | String | False |
Employee work authorization. Must match one of the system coded values. | |
| WorkEligibilityI9DateVerified | String | False |
Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| WorkEligibilitySsnDateVerified | String | False |
The date of employer verification of employee SSN. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| WorkEligibilityCountryOfIssuance | String | False |
If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup. | |
| WorkEligibilityAttestedDate | Date | False |
The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are *MM-DD-CCYY, CCYY-MM-DD*. | |
| WorkEligibilityI94AdmissionNumber | String | False |
Form I-94 admission number. Must be 11 numeric characters | |
| WorkEligibilityWorkUntil | String | False |
End date of employee work eligibility. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| WorkEligibilitySsnNotes | String | False |
Notes regarding employee's SSN. | |
| TaxSetupSitwExemptReason | String | False |
Reason code for SITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious). | |
| TaxSetupSuiExemptReason | String | False |
Reason code for SUI exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious). | |
| TaxSetupSuiState | String | False |
Employee SUI (State Unemployment Insurance) state. | |
| TaxSetupIsStatutory | Bool | False |
Indicates if employee is statutory. | |
| TaxSetupTaxDistributionCode1099R | String | False |
Employee 1099R distribution code. Common values are *7* (Normal Distribution), *F* (Charitable Gift Annuity). | |
| TaxSetupMedExemptReason | String | False |
Reason code for Medicare exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor). | |
| TaxSetupFutaExemptReason | String | False |
Reason code for FUTA exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor). | |
| TaxSetupSitwExemptNotes | String | False |
Notes for SITW exemption. | |
| TaxSetupMedExemptNotes | String | False |
Notes for Medicare exemption. | |
| TaxSetupSsExemptNotes | String | False |
Notes for Social Security exemption. | |
| TaxSetupIsEmployee943 | Bool | False |
Indicates if employee in agriculture or farming. | |
| TaxSetupIsPension | Bool | False |
Indicates if employee is eligible for pension. | |
| TaxSetupSuiExemptNotes | String | False |
Notes for SUI exemption. | |
| TaxSetupFitwExemptNotes | String | False |
Notes for FITW exemption. | |
| TaxSetupFitwExemptReason | String | False |
Reason code for FITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious). | |
| TaxSetupSsExemptReason | String | False |
Reason code for Social Security exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious). | |
| TaxSetupTaxForm | String | False |
Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2. | |
| TaxSetupFutaExemptNotes | String | False |
Notes for FUTA exemption. | |
| CustomDateFields | String | False |
Up to 8 custom fields of the date type value. | |
| FederalTaxHigherRate | Bool | False |
Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean | |
| FederalTaxDependentsAmount | Decimal | False |
Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2) | |
| FederalTaxAmount | Decimal | False |
Tax amount. Decimal (12,2) | |
| FederalTaxTaxCalculationCode | String | False |
Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage). | |
| FederalTaxDeductionsAmount | Decimal | False |
Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2) | |
| FederalTaxFilingStatus | String | False |
Employee federal filing status. Common values are *S* (Single), *M* (Married). | |
| FederalTaxPercentage | Decimal | False |
Tax percentage. Decimal (12,2) | |
| FederalTaxOtherIncomeAmount | Decimal | False |
Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2) | |
| FederalTaxW4FormYear | Int | False |
The federal W4 form year Integer | |
| FederalTaxExemptions | Decimal | False |
Federal tax exemptions value. Decimal (12,2) | |
| MaritalStatus | String | False |
Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*. | |
| Ssn | String | False |
Employee social security number. Leave it blank if valid social security number not available. | |
| BenefitSetupBenefitClassEffectiveDate | Date | False |
Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| BenefitSetupBenefitClass | String | False |
Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes. | |
| BenefitSetupBenefitSalaryEffectiveDate | Date | False |
Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| BenefitSetupBenefitSalary | Decimal | False |
Salary used to configure benefits.Decimal(12,2) | |
| BenefitSetupDoNotApplyAdministrativePeriod | Bool | False |
Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time. | |
| BenefitSetupIsMeasureAcaEligibility | Bool | False |
Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time. | |
| BirthDate | Date | False |
Employee birthdate. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| PrimaryStateTaxExemptions | Decimal | False |
State tax exemptions value.Decimal (12,2) | |
| PrimaryStateTaxFilingStatus | String | False |
Employee state tax filing status. Common values are *S* (Single), *M* (Married). | |
| PrimaryStateTaxAmount | Decimal | False |
State tax code. | |
| PrimaryStateTaxSpecialCheckCalc | String | False |
Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code). | |
| PrimaryStateTaxTaxCalculationCode | String | False |
Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage). | |
| PrimaryStateTaxW4FormYear | Int | False |
The state W4 form year Integer | |
| PrimaryStateTaxHigherRate | Bool | False |
Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean | |
| PrimaryStateTaxPercentage | Decimal | False |
State Tax percentage. Decimal (12,2) | |
| PrimaryStateTaxTaxCode | String | False |
State tax code. | |
| PrimaryStateTaxExemptions2 | Decimal | False |
State tax exemptions 2 value.Decimal (12,2) | |
| PrimaryStateTaxOtherIncomeAmount | Decimal | False |
Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2) | |
| PrimaryStateTaxDeductionsAmount | Decimal | False |
Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2) | |
| PrimaryStateTaxDependentsAmount | Decimal | False |
Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2) | |
| LocalTax | String | False |
Add, update, or delete local tax code, filing status, and exemptions including PA-PSD taxes. | |
| Gender | String | False |
Employee gender. Common values *M* (Male), *F* (Female). | |
| StatusChangeReason | String | False |
Employee status change reason. Must match Company setup. | |
| StatusAdjustedSeniorityDate | Date | False |
Adjusted seniority date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| StatusEffectiveDate | Date | False |
Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| StatusHireDate | Date | False |
Employee hired date. Updates to hire date are not allowed and will be ignored. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| StatusEmployeeStatus | String | False |
Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated). | |
| StatusIsEligibleForRehire | Bool | False |
Indicates if employee eligible for rehire. | |
| StatusReHireDate | Date | False |
Rehire date if employee is rehired. Updates to re-hire date are not allowed and will be ignored. Common formats are *MM-DD-CCYY, CCYY-MM-DD*. | |
| HomeAddressMobilePhone | String | False |
Mobile phone number. | |
| HomeAddressAddress1 | String | False |
1st address line. | |
| HomeAddressPostalCode | String | False |
Postal code. | |
| HomeAddressState | String | False |
State or province. | |
| HomeAddressCounty | String | False |
County. | |
| HomeAddressAddress2 | String | False |
2nd address line. | |
| HomeAddressEmailAddress | String | False |
Email. | |
| HomeAddressPhone | String | False |
Phone number. | |
| HomeAddressCity | String | False |
City. | |
| HomeAddressCountry | String | False |
Country. | |
| PriorLastName | String | False |
Prior last name if applicable. | |
| VeteranDescription | String | False |
Indicates if employee is a veteran. | |
| IsSmoker | Bool | False |
Indicates if employee is a smoker. | |
| Salutation | String | False |
Employee preferred salutation. | |
| IsHighlyCompensated | Bool | False |
Indicates if employee meets the highly compensated employee criteria. | |
| CustomNumberFields | String | False |
Up to 8 custom fields of numeric type value. | |
| PrimaryPayRateSalary | Decimal | False |
Employee gross salary per pay period used with payType Salary.Decimal (12,2) | |
| PrimaryPayRateBeginCheckDate | Date | False |
The date of the first check on which the new pay rate will appear. This value is only applicable when updating an existing employee. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| PrimaryPayRatePayRateNote | String | False |
Pay rate notes regarding employee. | |
| PrimaryPayRateEffectiveDate | Date | False |
The date the employee's pay rate takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| PrimaryPayRatePayType | String | False |
Employee pay type (rate code). Valid values are *Hourly* or *Salary*. | |
| PrimaryPayRateDefaultHours | Decimal | False |
Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. Decimal (12,2) | |
| PrimaryPayRateAnnualSalary | Decimal | False |
Employee annual salary.Decimal (12,2) | |
| PrimaryPayRateChangeReason | String | False |
Pay rate change reason. | |
| PrimaryPayRatePayGrade | String | False |
Employee pay grade. Must match Company setup. | |
| PrimaryPayRateIsAutoPay | Bool | False |
If set to *True*, employee will be paid automatically using deafultHours. | |
| PrimaryPayRateBaseRate | Decimal | False |
Employee base rate, used for Hourly employees. Decimal (12,2) | |
| PrimaryPayRateRatePer | String | False |
Employee base rate frequency used with payType Hourly. Common values are *Hour, Week*. Default is Hour. | |
| PrimaryPayRatePayFrequency | String | False |
Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*. | |
| CompanyName | String | False |
Company name as defined in Web Pay, applicable with GET requests only. | |
| CompanyId | String | True |
Id of the Company. |
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.
| Name | Type | ReadOnly | References | Description |
| EmployeeId | String | False |
Id of the Employee | |
| Det | String | False |
Identifies the type of record being imported. Use E for earning, D for deduction, or A for accrual balances. | |
| DetCode | String | False |
The earning or benefit code. This must be a code currently defined for the company. | |
| Hours | Double | False |
The number of hours worked by the employee or the used accrual hours. | |
| Amount | Integer | False |
The dollar amount to pay the employee or the available accrual hours. If an amount is entered, any information entered in the hours, rate, and rateCode fields will be ignored. | |
| TempRate | String | False |
The employee's pay rate. If no rate is entered, the system will use the employee's base rate. | |
| RateCode | String | False |
The company defined rate code used for paying the employee. If a rate code is entered, the system will ignore the value in the rate field. | |
| CostCenter1 | String | False |
Use this field to enter an override value for the first level cost center charged by the employee. | |
| CostCenter2 | String | False |
Use this field to enter an override value for the second level cost center charged by the employee. | |
| CostCenter3 | String | False |
Use this field to enter an override value for the third level cost center charged by the employee. If entering a value for CC3, also enter values for CC1 and CC2. | |
| JobCode | String | False |
This field is used to enter an override company defined job code to be charged by the employee. | |
| Shift | String | False |
This field is used to enter an override company defined shift code to be charged by the employee. | |
| BeginDate | String | False |
Begin Date associated with this line item. | |
| EndDate | String | False |
End Date associated with this line item. | |
| WorkersCompCode | String | False |
The company defined workers comp code for the work performed by the employee. | |
| TCode1 | String | False |
Not used unless directed by service bureau (State override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data. | |
| TCode2 | String | False |
Not used unless directed by service bureau (Local 1 override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data. | |
| TCode3 | String | False |
Not used unless directed by service bureau (Local 2 override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data. | |
| TCode4 | String | False |
Not used unless directed by service bureau (Do not use). | |
| Sequence | String | False |
Use this field to indicate multiple checks. | |
| CheckType | String | False |
Use this field to indicate an override Check Type. | |
| CheckNumber | String | False |
Use this field to indicate an override check Number. It is only valid when Check Type is 'Manual'. Check number for regular checks is assigned during processing. |
Get local taxes by tax code. Get all local taxes. Add new local tax. Delete local tax by tax code
The Sync App 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 Sync App.
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'
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')
Following is an example of how to Delete LocalTaxes from the table:
DELETE FROM LocalTaxes WHERE employeeId = '123' AND TaxCode = 'AL-BIR1'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| Exemptions | Decimal | False |
Local tax exemptions value.Decimal (12,2) | |
| Exemptions2 | Decimal | False |
Local tax exemptions 2 value.Decimal (12,2) | |
| FilingStatus | String | False |
Employee local tax filing status. Must match specific local tax setup. | |
| WorkPSD | String | False |
Work location PSD. Must match Company setup. | |
| ResidentPSD | String | False |
Resident PSD (political subdivision code) applicable in PA. Must match Company setup. | |
| TaxCode | String | False |
Local tax code. | |
| CompanyId | String | True |
Id of the Company. |
Add/update non-primary state tax
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM NonPrimaryStateTax WHERE EmployeeId = '123'
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)
Following is an example of how to Update a Non-PrimaryStateTax table:
UPDATE [NonPrimaryStateTax] SET Percentage = 2.5, Exemptions = 10 WHERE employeeId = '123'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| TaxCalculationCode | String | False |
Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage). | |
| Amount | Decimal | False |
State tax code. | |
| TaxCode | String | False |
State tax code. | |
| DeductionsAmount | Decimal | False |
Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2) | |
| Exemptions2 | Decimal | False |
State tax exemptions 2 value.Decimal (12,2) | |
| HigherRate | Bool | False |
Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean | |
| OtherIncomeAmount | Decimal | False |
Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2) | |
| DependentsAmount | Decimal | False |
Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2) | |
| ReciprocityCode | String | False |
Non-primary state tax reciprocity code. | |
| FilingStatus | String | False |
Employee state tax filing status. Common values are *S* (Single), *M* (Married). | |
| SpecialCheckCalc | String | False |
Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code). | |
| W4FormYear | Int | False |
The state W4 form year Integer | |
| Percentage | Decimal | False |
State Tax percentage. Decimal (12,2) | |
| Exemptions | Decimal | False |
State tax exemptions value.Decimal (12,2) | |
| CompanyId | String | True |
Id of the Company. |
Add/update primary state tax
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM PrimaryStateTax WHERE EmployeeId = '123'
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)
Following is an example of how to Update a PrimaryStateTax table:
UPDATE PrimaryStateTax SET Exemptions = 20, Amount = 125 WHERE employeeId = '123'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | True |
Employees.EmployeeId |
Id of the Employee. |
| DeductionsAmount | Decimal | False |
Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2) | |
| DependentsAmount | Decimal | False |
Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2) | |
| FilingStatus | String | False |
Employee state tax filing status. Common values are *S* (Single), *M* (Married). | |
| OtherIncomeAmount | Decimal | False |
Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2) | |
| TaxCalculationCode | String | False |
Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage). | |
| Exemptions | Decimal | False |
State tax exemptions value.Decimal (12,2) | |
| Exemptions2 | Decimal | False |
State tax exemptions 2 value.Decimal (12,2) | |
| HigherRate | Bool | False |
Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean | |
| Percentage | Decimal | False |
State Tax percentage. Decimal (12,2) | |
| W4FormYear | Int | False |
The state W4 form year Integer | |
| TaxCode | String | False |
State tax code. | |
| SpecialCheckCalc | String | False |
Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code). | |
| Amount | Decimal | False |
State tax code. | |
| CompanyId | String | True |
Id of the Company. |
Gets employee sensitive data information directly from Web Pay.
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM SensitiveData WHERE EmployeeId = '1234'
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')
Following is an example of how to Update a SensitiveData table:
UPDATE SensitiveData SET Disability = 'ads', DisabilityClassifications = 'dawd,afsc', HasDisability = '1' WHERE EmployeeId = '1234'
| Name | Type | ReadOnly | References | Description |
| EmployeeId [KEY] | String | False |
Employees.EmployeeId |
Id of the Employee. |
| CompanyId | String | False |
Id of the Company. | |
| Disability | String | False |
Description of employee's disability or accommodation. | |
| DisabilityClassifications | String | False |
Indicates the type of disability. | |
| HasDisability | String | False |
Indicates if the employee has a disability. Values include:0 = No, 1 = Yes or 2 = Prefer not to say. | |
| Ethnicity | String | False |
Employee's legal ethnicity or race. | |
| EthnicRacialIdentities | String | False |
Employee's preferred or chosen ethnicity or race. | |
| DisplayPronouns | String | False |
Specifies whether employee's preferred pronouns will be displayed to co-workers in Community, Directory, etc. Values include:0 = No or 1 = Yes. | |
| GenderIdentityDescription | String | False |
Employee's preferred or chosen gender identification. Values include:0 = No, 1 = Yes or 2 = Prefer not to say. | |
| IdentifyAsLegalGender | String | False |
Employee's self-identification of legal gender. | |
| LegalGender | String | False |
Employee's legal gender. | |
| Pronouns | String | False |
Employee's preferred or chosen pronouns. | |
| SexualOrientation | String | False |
Employee's self-identification of sexual orientation. | |
| IsVeteran | String | False |
Indicates if the employee is a veteran. Values include:0 = No, 1 = Yes or 2 = Prefer not to say. | |
| Veteran | String | False |
Employee's Veteran Notes. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| CompanyCodes | Get All Company Codes |
| CustomFields | Get All Custom Fields |
| DirectDeposit | Get All Direct Deposit |
| Employees | Get all employee info |
| PayStatementsdetails | Get employee pay statement details data for the specified year.. Get employee pay statement details data for the specified year and check date. |
| PayStatementssummary | Get employee pay statement summary data for the specified year.. Get employee pay statement summary data for the specified year and check date. |
Get All Company Codes
The Sync App 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 Sync App.
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'
| Name | Type | References | Description |
| Code | String | Code. | |
| Description | String | Description. | |
| CodeResource | String | Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions. | |
| CompanyId | String | Id of the Company. |
Get All Custom Fields
The Sync App 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 Sync App.
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'
| Name | Type | References | Description |
| Category | String | The custom field category. | |
| Label | String | The custom field label. | |
| Values | String | A set of values that are applicable to the custom field. | |
| Type | String | The custom field type. | |
| IsRequired | Bool | Indicates whether the custom field is required. | |
| DefaultValue | String | Specifies the default value of the custom field. | |
| CompanyId | String | Id of the Company. |
Get All Direct Deposit
The Sync App 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 Sync App.
For example, the following queries are processed server side:
SELECT * FROM DirectDeposit WHERE EmployeeId = '123'
| Name | Type | References | Description |
| EmployeeId [KEY] | String |
Employees.EmployeeId | Id of the Employee. |
| AdditionalDirectDeposit | String | Additional Direct Deposits that are not the main Direct Deposit. | |
| MainDirectDepositRoutingNumber | String | ABA Transit Routing Number, entered without dashes or spaces. | |
| MainDirectDepositNameOnAccount | String | Name on the bank account. Defaults to employee's name. | |
| MainDirectDepositBlockSpecial | Bool | Indicates if direct deposit should be blocked when special check types such as Bonus are processed. | |
| MainDirectDepositAccountNumber | String | Account number, entered without special characters and spaces. | |
| MainDirectDepositIsSkipPreNote | Bool | Indicates if account will not pre-note. | |
| MainDirectDepositAccountType | String | Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card). | |
| MainDirectDepositPreNoteDate | Date | Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*. | |
| CompanyId | String | Id of the Company. |
Get all employee info
The Paylocity does not support any column for filtering this table. All filters will be executed client side.
| Name | Type | References | Description |
| EmployeeId [KEY] | String | Employee Id. | |
| StatusCode | String | Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated). | |
| StatusTypeCode | String | Employee current work status type. | |
| CompanyId | String | Id of the Company. |
Get employee pay statement details data for the specified year.. Get employee pay statement details data for the specified year and check date.
The Sync App 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 Sync App.
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'
| Name | Type | References | Description |
| EmployeeId [KEY] | String |
Employees.EmployeeId | Id of the Employee |
| CheckDate [KEY] | Date | The Check Date of pay statement details data | |
| CompanyId [KEY] | String | Id of the Company | |
| TransactionNumber | Int | The Transaction Number of pay statement details data | |
| DetCode | String | The Det Code of pay statement details data | |
| Det | String | The Det of pay statement details data | |
| Hours | Decimal | The Hours of pay statement details data | |
| Rate | Decimal | The Rate of pay statement details data | |
| TransactionType | String | The Transaction type of pay statement details data | |
| Year | Int | The The year for which to retrieve pay statement data | |
| Amount | Decimal | The Amount of pay statement details data | |
| DetType | String | Pay statement details related to specific deduction, earning or tax types. | |
| EligibleCompensation | Decimal | The Eligible Compensation of pay statement details data |
Get employee pay statement summary data for the specified year.. Get employee pay statement summary data for the specified year and check date.
The Sync App 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 Sync App.
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'
| Name | Type | References | Description |
| EmployeeId [KEY] | String |
Employees.EmployeeId | Id of the Employee |
| CheckDate [KEY] | Date | The Check Date of pay statement summary data | |
| CompanyId [KEY] | String | Id of the Company | |
| TransactionNumber | Int | The Transaction Number of pay statement summary data | |
| BeginDate | Date | The Begin Date of pay statement summary data | |
| AutoPay | Bool | The If AutoPay is enabled pay statement summary data | |
| OvertimeDollars | Decimal | The Overtime Dollars of pay statement summary data | |
| GrossPay | Decimal | The Gross Pay of pay statement summary data | |
| NetPay | Decimal | The Net Pay of pay statement summary data | |
| Hours | Decimal | The Hours of pay statement summary data | |
| RegularHours | Decimal | The Regular Hours of pay statement summary data | |
| Process | Int | The Process of pay statement summary data | |
| CheckNumber | Int | The Check Number of pay statement summary data | |
| WorkersCompCode | String | The Workers CompCode of pay statement summary data | |
| NetCheck | Decimal | The Net Check of pay statement summary data | |
| VoucherNumber | Int | The Voucher Number of pay statement summary data | |
| DirectDepositAmount | Decimal | The Direct Deposit Amount of pay statement summary data | |
| RegularDollars | Decimal | The Regular Dollars of pay statement summary data | |
| Year | Int | The Year of pay statement summary data | |
| OvertimeHours | Decimal | The Over timeHours of pay statement summary data | |
| EndDate | Date | The EndDate of pay statement summary data |
| プロパティ | 説明 |
| CompanyId | The ID of the company file. |
| CustomFieldsCategory | The custom field category in the company. |
| UseSandbox | Set to true if you you are using sandbox account. |
| RSAPublicKey | Set this to the public key shared by Paylocity. |
| Key | The secret key for the symmetric algorithm. |
| IV | The initialization vector (IV). |
| 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. |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| CompanyId | The ID of the company file. |
| CustomFieldsCategory | The custom field category in the company. |
| UseSandbox | Set to true if you you are using sandbox account. |
| RSAPublicKey | Set this to the public key shared by Paylocity. |
| Key | The secret key for the symmetric algorithm. |
| IV | The initialization vector (IV). |
| 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. |
The ID of the company file.
The ID of the company file.
The custom field category in the company.
Add comma separated values to set more than one custom fields category. The following is an example of a custom field category:
Set to true if you you are using sandbox account.
Set to true if you you are using sandbox account.
Set this to the public key shared by Paylocity.
Either enter the key value or complete path of the file. This is required for executing Insert and Update statements.
The secret key for the symmetric algorithm.
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.
The initialization vector (IV).
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.
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.
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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
クライアント証明書のための証明書ストア名。
SSLClientCertType フィールドは、SSLClientCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、SSLClientCertPassword でパスワードを指定します。
SSLClientCert は、SSLClientCertSubject フィールドとともにクライアント証明書を指定するために使われます。SSLClientCert に値がある場合で、SSLClientCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、SSLClientCertSubject を参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。
TLS/SSL クライアント証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
| USER - デフォルト | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。 |
| JKSBLOB | この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
TLS/SSL クライアント証明書のパスワード。
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
TLS/SSL クライアント証明書のサブジェクト。
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]" です。共通のフィールドとその説明は以下のとおりです。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所（市町村名） |
| S | 法人の住所（都道府県） |
| C | 国名 |
| E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint （hex 値はスペースおよびコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint （hex 値はスペースおよびコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はPaylocity への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Paylocity Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
| Platform | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Employee WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。