Paylocity への接続を追加

Paylocity への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Paylocity アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからPaylocity コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Connecting 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):

• UseSandbox: True if you are using a Sandbox account; otherwise, False.
• CustomFieldsCategory: If IncludeCustomFields is True, set CustomFieldsCategory to the appropriate Custom Fields category. (Default: 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 separate 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.

Notes:

• 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.
• 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.

Authenticating to Paylocity

Paylocity supports OAuth authentication for all connections to data, from either Pay Entry API or the standard Paylocity API. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must obtain the proper credentials from Paylocity, as described in OAuth 認証情報の取得.

The following subsections describe how to authenticate to Paylocity from the three most common authentication flows.

For a complete list of connection string properties available in Paylocity, see Connection.

Automatic refresh of the OAuth access token:

To have the Sync App 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 you obtained from Paylocity.
   • OAuthClientSecret = The secret you obtained from Paylocity.
   • OAuthAccessToken = The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = The path where you want the Sync App 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 you obtained from Paylocity.
   • OAuthClientSecret = The Client Secret you obtained from Paylocity.

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.

このセクションでは、Paylocity Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Paylocity にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Paylocity Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Paylocity API へのSQL の実行について詳しく説明します。

主要機能

• Sync App はドキュメント、フォルダ、およびグループなどのPaylocity エンティティをリレーショナルビューとしてモデル化し、SQL を記述してPaylocity データをクエリできるようにします。
• ストアドプロシージャを使用するとPaylocity の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Sync App を使用するとPaylocity アカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Earnings、LocalTaxes、およびEmployeeDetails などを静的にモデル化するように定義されています。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Employees、CompanyCodes、およびCustomFields などのリソースを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Paylocity のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Paylocity の操作を実行できます。

Sync App はPaylocity のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Paylocity Connector for CData Sync テーブル

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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• 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

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).
Email	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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• 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', '[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')

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

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.

Columns

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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• 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

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.
Exemptions2	Decimal	False		State tax exemptions 2 value.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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DeductionsAmount	Decimal	Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2), This column is for INSERT and UPDATE only.
HigherRate	Bool	Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean, This column is for INSERT and UPDATE only.
OtherIncomeAmount	Decimal	Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2), This column is for INSERT and UPDATE only.
DependentsAmount	Decimal	Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2), This column is for INSERT and UPDATE only.

Add/update primary state tax

Table Specific Information

Select

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.

• 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

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
FilingStatus	String	False		Employee state tax filing status. Common values are *S* (Single), *M* (Married).
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)
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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
DeductionsAmount	Decimal	Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2), This column is for INSERT and UPDATE only.
DependentsAmount	Decimal	Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2), This column is for INSERT and UPDATE only.
OtherIncomeAmount	Decimal	Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2), This column is for INSERT and UPDATE only.
HigherRate	Bool	Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean, This column is for INSERT and UPDATE only.

Gets employee sensitive data information directly from Web Pay.

Table Specific Information

Select

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.

• 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

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	Boolean	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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Paylocity Connector for CData Sync ビュー

Name	Description
CompanyCodes	Get All Company Codes
CustomFields	Get All Custom Fields
DirectDeposit	Get All Direct Deposit
EmployeePunchDetails	Get employee punch details.
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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• 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

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

Table Specific Information

Select

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.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM DirectDeposit WHERE EmployeeId = '123'

Columns

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 employee punch details.

Columns

Name	Type	References	Description
EmployeeId [KEY]	String	Employees.EmployeeId	The Id of the Employee.
SegmentsPunchId [KEY]	String		A unique identifier assigned to each punch or time entry, ensuring that each entry is distinct, traceable, and easily referenced for tracking purposes.
CompanyId	String		The Paylocity Company Id. This is the unique value provided by Paylocity to each specific Payroll Entity.
BadgeNumber	Integer		The Time and Labor badge number.
RelativeStart	Datetime		The relative DateTime for the beginning of the WorkedShift in the format yyyy-MM-ddThh:mm:ss.
RelativeEnd	Datetime		The relative DateTime for the end of the WorkedShift in the format yyyy-MM-ddThh:mm:ss.
SegmentsOrigin	String		The associated origin of the time entry.
SegmentsDate	Date		The date the worked shift segment took place. In the case of overnight shifts, this is the date these worked hours apply to in payroll and can play a role in some overtime calculations.
SegmentsPunchType	String		The type of punch recorded, indicating categories such as work or lunch break.
SegmentsRelativeStart	Datetime		The relative DateTime of the beginning of this segment after payroll policy rules are applied. This value is Null if the segment began with a missed punch.
SegmentsRelativeEnd	Datetime		The relative DateTime of the end of this segment after payroll policy rules are applied. This value is Null if the segment ended with a missed punch.
SegmentsRelativeOriginalStart	Datetime		The relative DateTimeOffset of the beginning of this segment before payroll policy rules are applied. This value is Null if the segment began with a missed punch.
SegmentsRelativeOriginalEnd	Datetime		The relative DateTime of the end of this segment before payroll policy rules are applied. This value is Null if the segment ended with a missed punch.
SegmentsDurationHours	Double		The total hours worked by the employee for a particular punch or time entry, reflecting the duration of their work.
SegmentsEarnings	Double		The total earnings accrued by the employee for the specific punch or time entry, including wages, bonuses, or additional compensation.
SegmentsCostCenters	String		A list of cost centers, at most one per cost center level, that this segment of the worked shift is allocated to.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TestFlag	Boolean		A Boolean value that, when set to 'true', returns mock data.

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

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.

Table Specific Information

Select

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.

• 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

Name	Type	References	Description
EmployeeId	String	Employees.EmployeeId	Id of the Employee
CheckDate	Date		The Check Date of pay statement details data
CompanyId	String		Id of the Company
TransactionNumber	Long		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.

Table Specific Information

Select

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.

• 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

Name	Type	References	Description
EmployeeId	String	Employees.EmployeeId	Id of the Employee
CheckDate	Date		The Check Date of pay statement summary data
CompanyId	String		Id of the Company
TransactionNumber	Long		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

ストアドプロシージャはファンクションライクなインターフェースで、Paylocity の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにPaylocity から関連するレスポンスデータを返します。

Paylocity Connector for CData Sync ストアドプロシージャ

Name	Description
CreatePayEntryImportBatch	Create or merge Pay Entry Time Tracking Batch.
MergePayEntryImportBatch	This is used to create or merge a batch when the Pay Entry Import Status is halted at TimeClockValidationPendingAcknowledgement.
OnBoardingEmployee	Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Web Pay.

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

Name	Type	Required	Description
TimeEntry	String	True	The CSV Time Import Data. This can be submitted by inserting to the Input_TimeEntry input only table.
AutoAcknowledge	Boolean	False	Use true to auto acknowledge any errors or warnings for the import, false to not auto acknowledge
BatchName	String	False	The name of the batch.
MergeBatchId	String	False	The Id of the batch to be merged.
CalendarId	String	False	The Calendar Id for the check date.
PayPeriodBeginDate	String	False	The Pay Period Begin Date in YYYY-MM-DD format.
PayPeriodEndDate	String	False	The Pay Period End Date in YYYY-MM-DD format.
CheckDate	String	False	The Pay Period Check Date in YYYY-MM-DD format.

Result Set Columns

Name	Type	Description
TimeImportFileTrackingId	String	The Id of the time import file tracking.
Status	String	Status of the Time Import Batch.
BatchId	String	The Id of the Batch.

Creates a schema definition of a table in Paylocity.

CreateSchema

データモデル内の既存のテーブルまたはビューからローカルスキーマファイル（.rsd）を作成します。

スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。

Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。

Input

Name	Type	Required	Description
TableName	String	True	The name of the table.
FileName	String	False	The full file path and name of the schema to generate, required if the location connection property is not set. Ex:'C:\\scripts\\Employee.rsd'
SimplifyNames	String	False	Whether to output simple names for columns or not. Default is to simplify.

Result Set Columns

Name	Type	Description
Result	String	Whether or not the schema was successfully downloaded.

Gets an authentication token from Paylocity.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Paylocity.
ExpiresIn	String	The remaining lifetime on the access token.

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

Name	Type	Required	Description
TimeImportFileTrackingId	String	True	Id of the Time Import File Tracking.

Result Set Columns

Name	Type	Description
Message	String	Message of the create or merge batch operation.

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

Name	Type	Required	Description
FirstName	String	True	Employee first name
LastName	String	True	Employee last name.
EmployeeId	String	False	Employee Id (optional)
Address1	String	False	Employee home 1st address line.
Address2	String	False	Employee home 2nd address line.
AutoPayType	String	False	N- employee won't automatically receive a salary or hours during payroll, D - employee will be automatically paid in defaultHours during payroll, S - employee will be automatically paid Salary amount during payroll 使用できる値は次のとおりです。N, D, S
BaseRate	Decimal	False	Employee home 2nd address line.
City	String	False	Employee home city.
CostCenter1	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
CostCenter2	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
CostCenter3	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
DefaultHours	Decimal	False	Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours
EmployeeStatus	String	False	Employee current work status. Common values are *A (Active), L (Leave of Absence), T (Terminated)*.
EmploymentType	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)*.
FederalFilingStatus	String	False	Employee federal filing status. Common values *M (Married), S (Single)*.
Sex	String	False	Employee gender. Common values *M (Male), F (Female)*.
HireDate	Date	False	Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD
HomePhone	String	False	Employee gender. Common values *M (Male), F (Female)*.
MaritalStatus	String	False	Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*.
PersonalMobilePhone	String	False	Employee personal mobile phone number.
PayFrequency	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)*.
PersonalEmailAddress	String	False	Employee personal email address.
PayType	String	False	Employee pay type. Valid values are *Hourly or Salary*.
RatePer	String	False	Employee base rate frequency used with payType Hourly. Common values are *Hour or Week*. Default is Hour.
Salary	Decimal	False	Employee gross salary per pay period used with payType Salary.
State	String	False	Employee home state.
Ssn	String	False	Employee social security number. Leave it blank if valid social security number not available.
StateFilingStatus	String	False	Employee state filing status. Common values are *M (Married), S (Single)*.
SuiState	String	False	Employee SUI (State Unemployment Insurance) state.
TaxForm	String	False	Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2.
TaxState	String	False	Employee primary tax state.
UserName	String	False	Required. Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. Must be between 3 and 20 characters and cannot have special characters other than . (period) and _ (underscore)
WorkEmailAddress	String	False	Employee work email.
Zip	String	False	Employee home zip code.

Result Set Columns

Name	Type	Description
Status	String	Stored Procedure Execution Status

Refreshes the OAuth access token used for authentication with Paylocity.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Paylocity.
ExpiresIn	String	The remaining lifetime on the access token.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

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.

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能な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:

• PayrollAndHR

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（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用の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 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がPaylocity への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がPaylocity への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がPaylocity にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note：Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note：Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Paylocity Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note：特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

統合およびフォーマット

プロパティ	説明
DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse（ローカルタイムを使用）です。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

詳しくは、ユーザー定義ビュー を参照してください。

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.