CData Sync App は、ADP データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
ADP コネクタはCData Sync アプリケーションから使用可能で、ADP からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は次のADP API を使用してADP Workforce Now データへのアクセスを実現します。
接続を確立する前に、ADP に連絡してカスタムOAuthアプリケーションとそれに関連する認証情報を取得する必要があります。
また、認証に使用する独自のクライアント証明書を作成する必要があります。詳しくは、ADP Developer Resources を参照してください。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
ADP に接続するには以下のプロパティを設定します。
このセクションでは、ADP Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、ADP オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 ADP オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、ADP API へのSQL の実行について詳しく説明します。
ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。
Sync App はADP API により公開されるデータをリレーショナルテーブル としてモデル化します。
ビュー では、利用可能な読み取り専用ビューを説明します。
Sync App はADP のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Input_AdditionalRemunerations | To create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
| Input_configurationTags | Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
| Input_DeductionInputs | Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
| Input_EarningInputs | Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
| Input_ReimbursementInputs | Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
| PayrollRuns | Add and view the payroll runs. |
| Workers | Returns workers details. |
| WorkersPersonCommunicationEmails | Returns workers person communication emails. |
| WorkersPersonCommunicationFaxes | Returns workers person communication faxes. |
| WorkersPersonCommunicationLandlines | Returns workers person communication landlines. |
| WorkersPersonCommunicationMobiles | Returns workers person communication mobiles. |
| WorkersPersonCommunicationPagers | Returns workers person communication pagers. |
| WorkersWorkAssignments | Returns workers details. |
To create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
| Name | Type | ReadOnly | References | Description |
| RemunerationTypeCode | String | True | ||
| RemunerationTypeCodeName | String | True | ||
| RemunerationRate | Decimal | True | ||
| RemunerationCurrencyCode | String | True | ||
| effectiveDate | Date | True | ||
| NameCode | String | True |
AdditionalRemunerationNameCode.CodeValue | |
| InactiveIndicator | Boolean | True |
Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
| Name | Type | ReadOnly | References | Description |
| TagCode | String | True | ||
| TagDataType | String | True | ||
| TagValues | String | True |
Add comma separeted values with double quote | |
| ReferenceNumber | Integer | True |
Configuration tag reference number |
Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
| Name | Type | ReadOnly | References | Description |
| AssociateOID | String | True | ||
| PayrollGroupCode | String | True | ||
| DeductionCodeValue | String | True |
DeductionInputCode.CodeValue | |
| DeductionRateValue | Decimal | True | ||
| DeductionAmountcurrencyCode | String | True | ||
| DeductionBaseUnitCodeValue | String | True | ||
| DeductionConfigurationTags | String | True | ||
| ReferenceNumber | Integer | True |
Configuration tag reference number. |
Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
| Name | Type | ReadOnly | References | Description |
| AssociateOID | String | True | ||
| PayrollGroupCode | String | True | ||
| EarningCodeValue | String | True |
EarningInputCode.CodeValue | |
| RateValue | Decimal | True | ||
| RatecurrencyCode | String | True | ||
| NumberOfHours | String | True | ||
| EarningsAmountValue | Decimal | True | ||
| EarningsCurrencyCode | String | True | ||
| EarningConfigurationTags | String | True | ||
| ReferenceNumber | Integer | True |
Configuration tag reference number |
Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
| Name | Type | ReadOnly | References | Description |
| AssociateOID | String | True | ||
| PayrollGroupCode | String | True | ||
| ReimbursementCodeValue | String | True |
ReimbursementInputCode.CodeValue | |
| ReimbursementAmountValue | Decimal | True | ||
| ReimbursementAmountCurrencyCode | String | True | ||
| ReimbursementConfigurationTags | String | True | ||
| ReferenceNumber | Integer | True |
Configuration tag reference number |
Add and view the payroll runs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PayrollRuns WHERE ItemID = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM PayrollRuns WHERE PayrollRegionCodeValue = 'BOST' SELECT * FROM PayrollRuns WHERE PayrollGroupCodeValue = '3TN' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferenceScheduleEntryID = '20201117141612-l6OF8VuGHJD1ydLFoe5+nGBEm7rZkaRSorra0woRs04=' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollWeekNumber = '40' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollYear = '2020' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollRunNumber = '1' SELECT * FROM PayrollRuns WHERE Level = 'payroll'
Following is an example of how to inserting pay data inputs into PayrollRuns table. For example:
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '020024', '[{"earningCode":{"codeValue":"R"},"modifierCode":{"codeValue":"1"},"rate":{"rateValue":"44.50"},"configurationTags":[{"tagCode":"ShiftCode","tagValues":["1"]}],"numberOfHours":40},{"earningCode":{"codeValue":"O"},"modifierCode":{"codeValue":"2"},"numberOfHours":4}]', '[{"deductionCode":{"codeValue":"A"},"deductionRate":{"rateValue":9.5,"currencyCode":"USD"}}]', '[{"reimbursementCode":{"codeValue":"B"},"reimbursementAmount":{"amountValue":25,"currencyCode":"USD"}}]')
Inserting pay data inputs using Temp Table.
INSERT INTO PayrollRunsEarningInputs#TEMP (EarningCodeValue, RateValue, NumberOfHours) VALUES ('R', '50.50', '40');
INSERT INTO PayrollRunsDeductionInputs#TEMP (DeductionCodeValue, DeductionRateValue, DeductionAmountcurrencyCode) VALUES ('A', '10', 'USD');
INSERT INTO PayrollRunsReimbursementInputs#TEMP (ReimbursementCodeValue, ReimbursementAmountValue, ReimbursementAmountCurrencyCode) VALUES ('B', '25.00', 'USD');
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, PayrollWeekNumber, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', '53', 'G3BGDF8JG32ERTGK', '1', '020024', 'PayrollRunsEarningInputs#TEMP', 'PayrollRunsDeductionInputs#TEMP', 'PayrollRunsReimbursementInputs#TEMP');
| Name | Type | ReadOnly | References | Description |
| ItemID [KEY] | String | True |
The unique identifier of a instance within the collection. | |
| PayrollProcessingJobID | String | False |
The unique identifier of the related payroll processing job. This is generated as the result of the payrollProcessingJob.initiate event. | |
| AlternateJobIDs | String | True | ||
| PayrollRegionCodeValue | String | True |
The region in which the payroll is processed. | |
| PayrollGroupCodeValue | String | False |
PayrollGroup.Code |
The payroll group code relevant to payroll processing. |
| PayrollGroupCodeShortName | String | True |
Short description of the related code. | |
| PayrollGroupCodeLongName | String | True |
Long description of the related code. | |
| PayrollScheduleReferencePayrollScheduleID | String | True |
The unique identifier of the payroll schedule associated with the payroll output. | |
| PayrollScheduleReferenceScheduleEntryID | String | True |
The unique identifier of payroll schedule entry associated to the payroll schedule associated with the payroll output. | |
| PayrollScheduleReferencePayrollWeekNumber | String | True |
The week number for a payroll in the payroll schedule. This does not necessarily align with the calendar week number. | |
| PayrollScheduleReferencePayrollYear | String | True |
The year associated to a payroll in the payroll schedule. | |
| PayrollScheduleReferencePayrollRunNumber | String | True |
For a given payroll week number, this is the numbered run for that week. | |
| PayrollProcessingJobStatusCodeValue | String | True |
The Job status code of the payroll processing. | |
| PayrollProcessingJobStatusCodeShortName | String | True |
Short description of the related Job status code. | |
| PayrollProcessingJobStatusCodelongName | String | True |
Long description of the related Job status code. | |
| AssociatePayments | String | True |
This column will return data. If level set to detail. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| level | String |
使用できる値は次のとおりです。payroll, pay, details, payDetails, acc, acc-all, error, dropped pay, wage garnishements |
| AssociateOID | String |
Payroll Insert Only |
| PayrollWeekNumber | String |
Payroll Insert Only |
| PayrollFileNumber | String |
Payroll Insert Only |
| PayNumber | String |
Payroll Insert Only |
| EarningInputs | String |
Payroll Insert Only. Following Modifier codes are supported for pay data input 1 - 'Hours 1 (Regular)', 2 - 'Hours 3 Code & Quantity', 3 - 'Hours 3 Code & Quantity', 4 - 'Hours 4 Code & Quantity', 7 - 'Earnings 3 Code & Amount', 8 - 'Earnings 4 Code & Amount', 9 - 'Earnings 5 Code & Amount', 24 - 'Temporary Hourly Rate'. |
| DeductionInputs | String |
Payroll Insert Only |
| ReimbursementInputs | String |
Payroll Insert Only |
Returns workers details.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM Workers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM Workers WHERE AsOfDate = '2020-01-01'
Following is an example of how to inserting into Workers table. For example:
INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonLegalNameGivenName, PersonLegalNameFamilyName1, PersonBirthDate, PersonHighestEducationLevelCode) VALUES ('3UD', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 4', '2020-11-10', 'TestGivenName', 'TestFamilyName', '1990-06-01', 'DOC')
Following is an example of how to inserting into Workers table with WorkAssignements. For example:
INSERT INTO WorkersWorkAssignments#TEMP (StandardHoursQuantity, PayCycleCodeValue, BaseRemunerationHourlyRateAmountValue, WageLawCoverageCodeValue, BaseRemunerationDailyRateAmountValue) VALUES ('45', '4', 300, 'N', 100)
INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonBirthDate, PersonLegalNameFamilyName1, PersonLegalNameGivenName, PersonDisabledIndicator, PersonGenderCode, PersonHighestEducationLevelCode, PersonLegalAddressCityName, PersonLegalAddressCountryCode, PersonLegalAddressCountrySubdivisionLevel1Code, PersonLegalAddressCountrySubdivisionLevel1SubdivisionType, PersonLegalAddressLineOne, PersonLegalAddressLineTwo, PersonLegalAddressLineThree, PersonLegalAddressNameCodeShortName, PersonLegalAddressPostalCode, PersonLegalNameFamilyName1Prefix, PersonLegalNameGenerationAffixCode, PersonLegalNameInitials, PersonLegalNameMiddleName, PersonLegalNameNickName, PersonLegalNameQualificationAffixCode, PersonMaritalStatusCode, PersonMilitaryDischargeDate, PersonMilitaryStatusCode, WorkAssignments) VALUES ('3TQ', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 16', '2020-12-30', '1990-06-02', 'TestGivenName', 'TestFamilyName', 'FALSE', 'M', 'GRD', 'Millburn', 'US', 'NJ', 'state', 'LineOne', 'LineTwo', 'LineThree', 'Legal Residence', '07041', 'Prefix1', '2nd', 'I', 'MiddleName', 'NickName', 'CFA', 'M', '2013-04-01', '12', 'WorkersWorkAssignments#TEMP')
Following is an example of how to Update a Workers table:
UPDATE Workers SET PersonLegalNameGenerationAffixCode = '2nd', PersonLegalNameGivenName = 'GivenName', PersonLegalNameFamilyName1 = 'FamilyName1', PersonLegalNameFamilyName1Prefix = 'Prefix1', PersonLegalNameFamilyName2 = 'FamilyName2', PersonLegalNameFamilyName2Prefix = 'Prefix2', PersonLegalNameInitials = 'C', PersonLegalNameMiddleName = 'MiddleName', PersonLegalNameNickName = 'NickName', PersonLegalNamePreferredSalutations = '[{"salutationCode":{"codeValue":"Mr."},"typeCode":{"shortName":"Social"},"sequenceNumber":1}]', PersonLegalNameQualificationAffixCode = 'CFA' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonLegalAddressNameCodeShortName = 'Legal Residence', PersonLegalAddressLineOne = 'LineOne', PersonLegalAddressLineTwo = 'LineTwo', PersonLegalAddressCityName = 'Millburn', PersonLegalAddressCountryCode = 'US', PersonLegalAddressCountrySubdivisionLevel1SubdivisionType = 'state', PersonLegalAddressPostalCode = '07041' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonMaritalStatusCode = 'M', PersonMaritalStatusEffectiveDateTime = '2020-12-01T00:00:00Z' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonHighestEducationLevelCode = 'GRD' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonGenderCode = 'M' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonBirthDate = '1990-06-01' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonMilitaryClassificationCodes = '[{"codeValue":"R"}]' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True | ||
| WorkerID | String | True | ||
| WorkAssignments | String | False | ||
| WorkerAcquisitionDate | Date | True | ||
| WorkerAdjustedServiceDate | Date | True | ||
| WorkerExpectedTerminationDate | Date | True | ||
| WorkerOriginalHireDate | Date | False | ||
| WorkerRehireDate | Date | True | ||
| WorkerRetirementDate | Date | True | ||
| WorkerTerminationDate | Date | True | ||
| WorkerStatusEffectiveDate | Date | True | ||
| WorkerStatusReasonCode | String | True | ||
| WorkerStatusReasonLongName | String | True | ||
| WorkerStatusReasonShortName | String | True | ||
| WorkerStatusStatusCode | String | True | ||
| WorkerStatusStatusLongName | String | True | ||
| WorkerStatusStatusShortName | String | True | ||
| Photos | String | True | ||
| BusinessCommunicationEmails | String | False | ||
| BusinessCommunicationFaxes | String | False | ||
| BusinessCommunicationLandlines | String | False | ||
| BusinessCommunicationMobiles | String | False | ||
| BusinessCommunicationPagers | String | False | ||
| PersonAlternatePreferredNames | String | True | ||
| PersonCommunicationEmails | String | False | ||
| PersonCommunicationFaxes | String | False | ||
| PersonCommunicationLandlines | String | False | ||
| PersonCommunicationMobiles | String | False | ||
| PersonCommunicationPagers | String | False | ||
| PersonDeathDate | Date | True | ||
| PersonDeceasedIndicator | Boolean | True | ||
| PersonDisabilityIdentificationDeclinedIndicator | Boolean | True | ||
| PersonDisabilityPercentage | Integer | True | ||
| PersonDisabilityTypeCodes | String | False | ||
| PersonDisabledIndicator | Boolean | False | ||
| PersonGenderCode | String | False |
使用できる値は次のとおりです。M, F, N | |
| PersonGenderLongName | String | True | ||
| PersonGenderShortName | String | True | ||
| PersonGovernmentIDs | String | False | ||
| PersonHighestEducationLevelCode | String | False |
HighestEducationLevelCode.CodeValue | |
| PersonHighestEducationLevelLongName | String | True | ||
| PersonHighestEducationLevelShortName | String | True | ||
| PersonIdentityDocuments | String | True | ||
| PersonImmigrationDocuments | String | True | ||
| PersonLegalAddressCityName | String | False | ||
| PersonLegalAddressCountryCode | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel1Code | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel1LongName | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel1ShortName | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel2Code | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel2LongName | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel2ShortName | String | False | ||
| PersonLegalAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
| PersonLegalAddressDeliveryPoint | String | False | ||
| PersonLegalAddressLineOne | String | False | ||
| PersonLegalAddressLineTwo | String | False | ||
| PersonLegalAddressLineThree | String | False | ||
| PersonLegalAddressNameCodeValue | String | False | ||
| PersonLegalAddressNameCodeLongName | String | True | ||
| PersonLegalAddressNameCodeShortName | String | False | ||
| PersonLegalAddressPostalCode | String | False | ||
| PersonLegalAddressSameAsAddressIndicator | Boolean | False | ||
| PersonLegalAddressSameAsAddressLinkCanonicalUri | String | False | ||
| PersonLegalAddressSameAsAddressLinkEncType | String | False | ||
| PersonLegalAddressSameAsAddressLinkHref | String | False | ||
| PersonLegalAddressSameAsAddressLinkMediaType | String | False | ||
| PersonLegalAddressSameAsAddressLinkMethod | String | False | ||
| PersonLegalAddressSameAsAddressLinkPayLoadArguments | String | False | ||
| PersonLegalAddressSameAsAddressLinkRel | String | False | ||
| PersonLegalAddressSameAsAddressLinkSchema | String | False | ||
| PersonLegalAddressSameAsAddressLinkTargetSchema | String | False | ||
| PersonLegalAddressSameAsAddressLinkTitle | String | False | ||
| PersonLegalNameFamilyName1 | String | False | ||
| PersonLegalNameFamilyName1Prefix | String | False | ||
| PersonLegalNameFamilyName2 | String | False | ||
| PersonLegalNameFamilyName2Prefix | String | False | ||
| PersonLegalNameFormattedName | String | False | ||
| PersonLegalNameGenerationAffixCode | String | False |
GenerationAffixCode.CodeValue | |
| PersonLegalNameGenerationAffixLongName | String | True | ||
| PersonLegalNameGenerationAffixShortName | String | True | ||
| PersonLegalNameGivenName | String | False | ||
| PersonLegalNameInitials | String | False | ||
| PersonLegalNameMiddleName | String | False | ||
| PersonLegalNameCode | String | False | ||
| PersonLegalNameLongName | String | True | ||
| PersonLegalNameShortName | String | False | ||
| PersonLegalNameNickName | String | False | ||
| PersonLegalNamePreferredSalutations | String | False | ||
| PersonLegalNameQualificationAffixCode | String | False |
QualificationAffixCode.CodeValue | |
| PersonLegalNameQualificationAffixLongName | String | False | ||
| PersonLegalNameQualificationAffixShortName | String | False | ||
| PersonLinks | String | True | ||
| PersonMaritalStatusCode | String | False |
MaritalStatusCode.CodeValue | |
| PersonMaritalStatusEffectiveDateTime | Datetime | False | ||
| PersonMaritalStatusLongName | String | True | ||
| PersonMaritalStatusShortName | String | False |
MaritalStatusCode.ShortName | |
| PersonMilitaryClassificationCodes | String | False |
Supported values: Disabled Veteran, Active Duty Wartime or Campaign Badge Veteran, Armed Forces Service Medal Veteran, Recently Separated Veteran. | |
| PersonMilitaryDischargeDate | Date | False | ||
| PersonMilitaryStatusCode | String | False | ||
| PersonMilitaryStatusEffectiveDate | Datetime | True | ||
| PersonMilitaryStatusLongName | String | True | ||
| PersonMilitaryStatusShortName | String | False | ||
| PersonOtherPersonalAddresses | String | False | ||
| PersonPassports | String | False | ||
| PersonPreferredNameFamilyName1 | String | True | ||
| PersonPreferredNameFamilyName1Prefix | String | True | ||
| PersonPreferredNameFamilyName2 | String | True | ||
| PersonPreferredNameFamilyName2Prefix | String | True | ||
| PersonPreferredNameFormattedName | String | True | ||
| PersonPreferredNameGenerationAffixCode | String | True | ||
| PersonPreferredNameGenerationAffixLongName | String | True | ||
| PersonPreferredNameGenerationAffixShortName | String | True | ||
| PersonPreferredNameGivenName | String | True | ||
| PersonPreferredNameInitials | String | True | ||
| PersonPreferredNameMiddleName | String | True | ||
| PersonPreferredNameCode | String | True | ||
| PersonPreferredNameLongName | String | True | ||
| PersonPreferredNameShortName | String | True | ||
| PersonPreferredNameNickName | String | True | ||
| PersonPreferredNamePreferredSalutations | String | True | ||
| PersonPreferredNameQualificationAffixCode | String | True | ||
| PersonPreferredNameQualificationAffixLongName | String | True | ||
| PersonPreferredNameQualificationAffixShortName | String | True | ||
| PersonPreferredNameScriptCode | String | True | ||
| PersonPreferredNameScriptLongName | String | True | ||
| PersonPreferredNameScriptShortName | String | True | ||
| PersonPreferredNameTitleAffixCodes | String | True | ||
| PersonPreferredNameTitlePrefixCodes | String | True | ||
| PersonReligionCode | String | True | ||
| PersonReligionLongName | String | True | ||
| PersonReligionShortName | String | True | ||
| PersonResidencyCountryCodes | String | True | ||
| PersonSexualOrientationCode | String | True | ||
| PersonSexualOrientationLongName | String | True | ||
| PersonSexualOrientationShortName | String | True | ||
| PersonSocialInsurancePrograms | String | True | ||
| PersonStudentIndicator | Boolean | True | ||
| PersonStudentStatusCode | String | True | ||
| PersonStudentStatusEffectiveDate | Date | True | ||
| PersonStudentStatusLongName | String | True | ||
| PersonStudentStatusShortName | String | True | ||
| PersonTobaccoUserIndicator | Boolean | True | ||
| PersonWorkAuthorizationDocuments | String | True | ||
| Links | String | True | ||
| AsOfDate | Date | True |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| PayrollGroupCode | String |
Insert Only |
| OnboardingTemplateCode | String |
Insert Only |
| OnboardingTemplateCodeName | String |
Insert Only |
| OnboardingStatusCode | String |
Insert Only |
| OnboardingStatusCodeName | String |
Insert Only |
| HireReasonCode | String |
Insert Only |
| HireReasonCodeName | String |
Insert Only |
Returns workers person communication emails.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationEmails WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationEmails table:
UPDATE WorkersPersonCommunicationEmails SET EmailUri = '[email protected]' WHERE AssociateOID = 'G3349PZGBADQY8H8'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerID | String | True |
Workers.WorkerID | |
| EmailUri | String | False | ||
| ItemID | String | True | ||
| NameCode | String | True | ||
| NameCodeLongName | String | True | ||
| NameCodeShortName | String | True | ||
| NotificationIndicator | Boolean | True | ||
| AsOfDate | Date | True |
Returns workers person communication faxes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationFaxes table:
UPDATE WorkersPersonCommunicationFaxes SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerID | String | True |
Workers.WorkerID | |
| Access | String | False | ||
| AreaDialing | String | False | ||
| CountryDialing | String | False | ||
| DialNumber | String | False | ||
| Extension | String | False | ||
| FormattedNumber | String | True | ||
| ItemID | String | True | ||
| NameCode | String | True | ||
| NameCodeLongName | String | True | ||
| NameCodeShortName | String | True | ||
| NotificationIndicator | Boolean | True | ||
| AsOfDate | Date | True |
Returns workers person communication landlines.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationLandlines table:
UPDATE WorkersPersonCommunicationLandlines SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerID | String | True |
Workers.WorkerID | |
| Access | String | False | ||
| AreaDialing | String | False | ||
| CountryDialing | String | False | ||
| DialNumber | String | False | ||
| Extension | String | False | ||
| FormattedNumber | String | True | ||
| ItemID | String | True | ||
| NameCode | String | True | ||
| NameCodeLongName | String | True | ||
| NameCodeShortName | String | True | ||
| NotificationIndicator | Boolean | True | ||
| AsOfDate | Date | True |
Returns workers person communication mobiles.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationMobiles table:
UPDATE WorkersPersonCommunicationMobiles SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerID | String | True |
Workers.WorkerID | |
| Access | String | False | ||
| AreaDialing | String | False | ||
| CountryDialing | String | False | ||
| DialNumber | String | False | ||
| Extension | String | False | ||
| FormattedNumber | String | True | ||
| ItemID | String | True | ||
| NameCode | String | True | ||
| NameCodeLongName | String | True | ||
| NameCodeShortName | String | True | ||
| NotificationIndicator | Boolean | True | ||
| AsOfDate | Date | True |
Returns workers person communication pagers.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationPagers WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationPagers table:
UPDATE WorkersPersonCommunicationPagers SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerID | String | True |
Workers.WorkerID | |
| Access | String | False | ||
| AreaDialing | String | False | ||
| CountryDialing | String | False | ||
| DialNumber | String | False | ||
| Extension | String | False | ||
| FormattedNumber | String | True | ||
| ItemID | String | True | ||
| NameCode | String | True | ||
| NameCodeLongName | String | True | ||
| NameCodeShortName | String | True | ||
| NotificationIndicator | Boolean | True | ||
| AsOfDate | Date | True |
Returns workers details.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignments WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignments WHERE WorkerIdValue = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignments WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update BaseRemuneration:
UPDATE WorkersWorkAssignments SET StandardHoursQuantity = '45', BaseRemunerationEffectiveDate = '2020-12-21', PayCycleCodeValue = '4', BaseRemunerationHourlyRateAmountValue = 300, WageLawCoverageCodeValue = 'N', BaseRemunerationCode = 'ADJ', ItemId = '34321368N' WHERE AssociateOID = 'G3GMC21PJFZT7K4F'
Following is an example of how to Update AdditionalRemuneration using aggregates:
UPDATE WorkersWorkAssignments SET AdditionalRemunerations = '[{"remunerationTypeCode":{"code":"AE","name":"additional earnings"},"remunerationRate":{"rate":70,"currencyCode":"USD"},"effectiveDate":"2020-12-20","nameCode":{"code":"1FA"},"inactiveIndicator":false}]', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update AdditionalRemuneration using Temp Table:
INSERT INTO Input_AdditionalRemunerations#TEMP (RemunerationTypeCode, RemunerationRate, RemunerationCurrencyCode, effectiveDate, NameCode, InactiveIndicator) VALUES ('AE', '70', 'USD', '2021-01-04', 'R', false)
UPDATE WorkersWorkAssignments SET AdditionalRemunerations = 'Input_AdditionalRemunerations#TEMP', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update Worker Assignment Termination:
UPDATE WorkersWorkAssignments SET TerminationDate = '2020-01-31', LastWorkedDate = '2020-01-31', AssignmentStatusReasonCodeValue = 'A00', RehireEligibleIndicator = true, SeveranceEligibleIndicator = true, TerminationComments = 'Looking for better growth and oppurtunities', itemid = '00691088N' WHERE AssociateOID = 'G3TGG0M57JZECKRB'
Following is an example of how to Update Worker Type:
UPDATE WorkersWorkAssignments SET WorkerTypeCodeValue = 'F', ItemId = '31095304_1668', EventReasonCode = 'ADL', EffectiveDate = '2021-01-01' WHERE AssociateOID = 'G3Q8G47NKHBV1SMT'
| Name | Type | ReadOnly | References | Description |
| AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
| WorkerIdValue | String | True |
Workers.WorkerID | |
| ItemID [KEY] | String | False | ||
| ActualStartDate | Date | True | ||
| CompaRatio | Integer | True | ||
| AdditionalRemunerations | String | False | ||
| AnnualBenefitBaseRateAmountValue | Integer | True | ||
| AnnualBenefitBaseRateCurrencyCode | String | True | ||
| AnnualBenefitBaseRateNameCodeValue | String | True | ||
| AnnualBenefitBaseRateNameCodeLongName | String | True | ||
| AnnualBenefitBaseRateNameCodeShortName | String | True | ||
| AssignedOrganizationalUnits | String | False | ||
| AssignedWorkLocations | String | True | ||
| AssignmentCostCenters | String | True | ||
| AssignmentStatusEffectiveDate | Date | True | ||
| AssignmentStatusReasonCodeValue | String | False | ||
| AssignmentStatusReasonCodeLongName | String | True | ||
| AssignmentStatusReasonCodeShortName | String | True | ||
| AssignmentStatusStatusCodeValue | String | True | ||
| AssignmentStatusStatusCodeLongName | String | True | ||
| AssignmentStatusStatusCodeShortName | String | True | ||
| AssignmentTermCodeValue | String | True | ||
| AssignmentTermCodeLongName | String | True | ||
| AssignmentTermCodeShortName | String | True | ||
| BargainingUnitBargainingUnitCodeValue | String | False | ||
| BargainingUnitBargainingUnitCodeLongName | String | True | ||
| BargainingUnitBargainingUnitCodeShortName | String | False | ||
| BargainingUnitSeniorityDate | Date | False | ||
| BaseRemunerationAnnualRateAmountValue | Decimal | True | ||
| BaseRemunerationAnnualRateAmountCurrencyCode | String | True | ||
| BaseRemunerationAnnualRateAmountNameCodeValue | String | True | ||
| BaseRemunerationAnnualRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationAnnualRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationAssociatedRateQualifiers | String | True | ||
| BaseRemunerationBiweeklyRateAmountValue | Decimal | True | ||
| BaseRemunerationBiweeklyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationBiweeklyRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationBiweeklyRateAmountNameCodeValue | String | True | ||
| BaseRemunerationBiweeklyRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationCommissionRatePercentageBaseUnitCodeValue | String | True | ||
| BaseRemunerationCommissionRatePercentageBaseUnitCodeLongName | String | True | ||
| BaseRemunerationCommissionRatePercentageBaseUnitCodeShortName | String | True | ||
| BaseRemunerationCommissionRatePercentageNameCodeValue | String | True | ||
| BaseRemunerationCommissionRatePercentageNameCodeLongName | String | True | ||
| BaseRemunerationCommissionRatePercentageNameCodeShortName | String | True | ||
| BaseRemunerationCommissionRatePercentagePercentageValue | Integer | True | ||
| BaseRemunerationDailyRateAmountValue | Decimal | False | ||
| BaseRemunerationDailyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationDailyRateAmountNameCodeValue | String | False | ||
| BaseRemunerationDailyRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationDailyRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationEffectiveDate | Date | False | ||
| BaseRemunerationHourlyRateAmountValue | Decimal | False | ||
| BaseRemunerationHourlyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationHourlyRateAmountNameCodeValue | String | True | ||
| BaseRemunerationHourlyRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationHourlyRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationMonthlyRateAmountValue | Decimal | True | ||
| BaseRemunerationMonthlyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationMonthlyRateAmountNameCodeValue | String | False | ||
| BaseRemunerationMonthlyRateAmountNameLongName | String | True | ||
| BaseRemunerationMonthlyRateAmountNameShortName | String | False | ||
| BaseRemunerationPayPeriodRateAmountValue | Decimal | True | ||
| BaseRemunerationPayPeriodRateAmountCurrencyCode | String | True | ||
| BaseRemunerationPayPeriodRateAmountNameCodeValue | String | True | ||
| BaseRemunerationPayPeriodRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationPayPeriodRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationRecordingBasisCodeValue | String | True | ||
| BaseRemunerationRecordingBasisCodelongName | String | True | ||
| BaseRemunerationRecordingBasisCodeShortName | String | True | ||
| BaseRemunerationSemiMonthlyRateAmountValue | Decimal | True | ||
| BaseRemunerationSemiMonthlyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationSemiMonthlyRateAmountNameCodeValue | String | True | ||
| BaseRemunerationSemiMonthlyRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationSemiMonthlyRateAmountNameCodeShortName | String | True | ||
| BaseRemunerationWeeklyRateAmountValue | Decimal | True | ||
| BaseRemunerationWeeklyRateAmountCurrencyCode | String | True | ||
| BaseRemunerationWeeklyRateAmountNameCodeValue | String | True | ||
| BaseRemunerationWeeklyRateAmountNameCodeLongName | String | True | ||
| BaseRemunerationWeeklyRateAmountNameCodeShortName | String | True | ||
| ExecutiveIndicator | Boolean | True | ||
| ExecutiveTypeCodeValue | String | True | ||
| ExecutiveTypeCodeLongName | String | True | ||
| ExecutiveTypeCodeShortName | String | True | ||
| ExpectedStartDate | Date | True | ||
| ExpectedTerminationDate | Date | True | ||
| FullTimeEquivalenceRatio | Integer | True | ||
| GeographicPayDifferentialCodeValue | String | True | ||
| GeographicPayDifferentialCodeLongName | String | True | ||
| GeographicPayDifferentialCodeShortName | String | True | ||
| GeographicPayDifferentialPercentage | Integer | True | ||
| HighlyCompensatedIndicator | Boolean | True | ||
| HighlyCompensatedTypeCodeValue | String | True | ||
| HighlyCompensatedTypeCodeLongName | String | True | ||
| HighlyCompensatedTypeCodeShortName | String | True | ||
| HireDate | Date | True | ||
| HomeOrganizationalUnits | String | False | ||
| HomeWorkLocationAddressAttentionOfName | String | True | ||
| HomeWorkLocationAddressBlockName | String | True | ||
| HomeWorkLocationAddressBuildingName | String | True | ||
| HomeWorkLocationAddressBuildingNumber | String | True | ||
| HomeWorkLocationAddressCareOfName | String | True | ||
| HomeWorkLocationAddressCityName | String | False | ||
| HomeWorkLocationAddressCountryCode | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel1CodeValue | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel1LongName | String | True | ||
| HomeWorkLocationAddressCountrySubdivisionLevel1ShortName | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel2CodeValue | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel2LongName | String | True | ||
| HomeWorkLocationAddressCountrySubdivisionLevel2ShortName | String | False | ||
| HomeWorkLocationAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
| HomeWorkLocationAddressDeliveryPoint | String | True | ||
| HomeWorkLocationAddressDoor | String | True | ||
| HomeWorkLocationAddressFloor | String | True | ||
| HomeWorkLocationAddressGeoCoordinateLatitude | Integer | True | ||
| HomeWorkLocationAddressGeoCoordinateLongitude | Integer | True | ||
| HomeWorkLocationAddressLineFive | String | True | ||
| HomeWorkLocationAddressLineFour | String | True | ||
| HomeWorkLocationAddressLineOne | String | False | ||
| HomeWorkLocationAddressLineTwo | String | False | ||
| HomeWorkLocationAddressLineThree | String | False | ||
| HomeWorkLocationAddressNameCodeValue | String | True | ||
| HomeWorkLocationAddressNameCodeLongName | String | True | ||
| HomeWorkLocationAddressNameCodeShortName | String | True | ||
| HomeWorkLocationAddressPlotID | String | True | ||
| HomeWorkLocationAddressPostalCode | String | False | ||
| HomeWorkLocationAddressPostOfficeBox | String | True | ||
| HomeWorkLocationAddressScriptCodeValue | String | True | ||
| HomeWorkLocationAddressScriptCodeLongName | String | True | ||
| HomeWorkLocationAddressScriptCodeShortName | String | True | ||
| HomeWorkLocationAddressStairCase | String | True | ||
| HomeWorkLocationAddressStreetName | String | True | ||
| HomeWorkLocationAddressStreetTypeCodeValue | String | True | ||
| HomeWorkLocationAddressStreetTypeCodeLongName | String | True | ||
| HomeWorkLocationAddressStreetTypeCodeShortName | String | True | ||
| HomeWorkLocationAddressUnit | String | True | ||
| HomeWorkLocationCommunicationEmails | String | True | ||
| HomeWorkLocationCommunicationFaxes | String | True | ||
| HomeWorkLocationCommunicationLandlines | String | True | ||
| HomeWorkLocationCommunicationMobiles | String | True | ||
| HomeWorkLocationCommunicationPagers | String | True | ||
| HomeWorkLocationNameCodeValue | String | False | ||
| HomeWorkLocationNameCodeLongName | String | True | ||
| HomeWorkLocationNameCodeShortName | String | False | ||
| IndustryClassifications | String | False | ||
| JobCodeValue | String | False | ||
| JobCodeEffectiveDate | Date | True | ||
| JobCodeLongName | String | True | ||
| JobCodeShortName | String | False | ||
| JobTitle | String | True | ||
| LaborUnionLaborUnionCodeValue | String | False | ||
| LaborUnionLaborUnionCodeLongName | String | True | ||
| LaborUnionLaborUnionCodeShortName | String | False | ||
| LaborUnionSeniorityDate | Date | True | ||
| LegalEntityID | String | True | ||
| Links | String | True | ||
| ManagementPositionIndicator | Boolean | False | ||
| MinimumPayGradeStepDuration | String | True | ||
| NationalityContextCodeValue | String | True | ||
| NationalityContextCodeLongName | String | True | ||
| NationalityContextCodeShortName | String | True | ||
| NextPayGradeStepDate | Date | True | ||
| OccupationalClassifications | String | False | ||
| OfferAcceptanceDate | Date | True | ||
| OfferExtensionDate | Date | True | ||
| OfficerIndicator | Boolean | True | ||
| OfficerTypeCodeValue | String | False | ||
| OfficerTypeCodeLongName | String | True | ||
| OfficerTypeCodeShortName | String | False | ||
| PayCycleCodeValue | String | False | ||
| PayCycleCodeLongName | String | True | ||
| PayCycleCodeShortName | String | False | ||
| PayGradeCodeValue | String | False | ||
| PayGradeCodeLongName | String | True | ||
| PayGradeCodeShortName | String | False | ||
| PayGradePayRangeMaximumRateAmountValue | Decimal | True | ||
| PayGradePayRangeMaximumRateBaseMultiplierValue | Integer | True | ||
| PayGradePayRangeMaximumRateBaseUnitCodeValue | String | True | ||
| PayGradePayRangeMaximumRateBaseUnitCodeLongName | String | True | ||
| PayGradePayRangeMaximumRateBaseUnitCodeShortName | String | True | ||
| PayGradePayRangeMaximumRateCurrencyCode | String | True | ||
| PayGradePayRangeMaximumRateUnitCodeValue | String | True | ||
| PayGradePayRangeMaximumRateUnitCodeLongName | String | True | ||
| PayGradePayRangeMaximumRateUnitCodeShortName | String | True | ||
| PayGradePayRangeMedianRateAmountValue | Decimal | True | ||
| PayGradePayRangeMedianRateBaseMultiplierValue | Integer | True | ||
| PayGradePayRangeMedianRateBaseUnitCodeValue | String | True | ||
| PayGradePayRangeMedianRateBaseUnitCodeLongName | String | True | ||
| PayGradePayRangeMedianRateBaseUnitCodeShortName | String | True | ||
| PayGradePayRangeMedianRateCcurrencyCode | String | True | ||
| PayGradePayRangeMedianRateUnitCodeValue | String | True | ||
| PayGradePayRangeMedianRateUnitCodeLongName | String | True | ||
| PayGradePayRangeMedianRateUnitCodeShortName | String | True | ||
| PayGradePayRangeMinimumRateAmountValue | Decimal | True | ||
| PayGradePayRangeMinimumRateBaseMultiplierValue | Integer | True | ||
| PayGradePayRangeMinimumRateBaseUnitCodeValue | String | True | ||
| PayGradePayRangeMinimumRateBaseUnitCodeLongName | String | True | ||
| PayGradePayRangeMinimumRateBaseUnitCodeShortName | String | True | ||
| PayGradePayRangeMinimumRateCurrencyCode | String | True | ||
| PayGradePayRangeMinimumRateUnitCodeValue | String | True | ||
| PayGradePayRangeMinimumRateUnitCodeLongName | String | True | ||
| PayGradePayRangeMinimumRateUnitCodeShortName | String | True | ||
| PayGradeStepCodeValue | String | True | ||
| PayGradeStepCodeLongName | String | True | ||
| PayGradeStepCodeShortName | String | True | ||
| PayGradeStepPayRateAmountValue | Decimal | True | ||
| PayGradeStepPayRateBaseMultiplierValue | Integer | True | ||
| PayGradeStepPayRateBaseUnitCodeValue | String | True | ||
| PayGradeStepPayRateBaseUnitCodeLongName | String | True | ||
| PayGradeStepPayRateBaseUnitCodeShortName | String | True | ||
| PayGradeStepPayRateCurrencyCode | String | True | ||
| PayGradeStepPayRateUnitCodeValue | String | True | ||
| PayGradeStepPayRateUnitCodeLongName | String | True | ||
| PayGradeStepPayRateUnitCodeShortName | String | True | ||
| PayrollFileNumber | String | False | ||
| PayrollGroupCode | String | False | ||
| PayrollProcessingStatusCodeValue | String | True | ||
| PayrollProcessingStatusCodeEffectiveDate | Date | True | ||
| PayrollProcessingStatusCodeLongName | String | True | ||
| PayrollProcessingStatusCodeShortName | String | True | ||
| PayrollRegionCode | String | True | ||
| PayrollScheduleGroupID | String | True | ||
| PayScaleCodeValue | String | True | ||
| PayScaleCodeLongName | String | True | ||
| PayScaleCodeShortName | String | True | ||
| PositionID | String | False | ||
| PositionTitle | String | True | ||
| PrimaryIndicator | Boolean | True | ||
| RemunerationBasisCodeValue | String | True | ||
| RemunerationBasisCodeLongName | String | True | ||
| RemunerationBasisCodeShortName | String | True | ||
| ReportsTo | String | False | ||
| SeniorityDate | Date | True | ||
| StandardHoursQuantity | Integer | False | ||
| StandardHoursUnitCodeValue | String | True | ||
| StandardHoursUnitCodeLongName | String | True | ||
| StandardHoursUnitCodeShortName | String | True | ||
| StandardPayPeriodHoursHoursQuantity | Integer | True | ||
| StandardPayPeriodHoursUnitCodeValue | String | True | ||
| StandardPayPeriodHoursUnitCodeLongName | String | True | ||
| StandardPayPeriodHoursUnitCodeShortName | String | True | ||
| StockOwnerIndicator | Boolean | True | ||
| StockOwnerPercentage | Integer | True | ||
| TerminationDate | Date | False | ||
| VipIndicator | Boolean | True | ||
| VipTypeCodeValue | String | True | ||
| VipTypeCodeLongName | String | True | ||
| VipTypeCodeShortName | String | True | ||
| WageLawCoverageCodeValue | String | False |
WageLawCoverageCode.CodeValue | |
| WageLawCoverageCodeLongName | String | True | ||
| WageLawCoverageCodeShortName | String | False | ||
| WageLawCoverageWageLawNameCodeValue | String | True | ||
| WageLawCoverageWageLawNameCodeLongName | String | True | ||
| WageLawCoverageWageLawNameCodeShortName | String | True | ||
| WorkArrangementCodeValue | String | True | ||
| WorkArrangementCodeLongName | String | True | ||
| WorkArrangementCodeShortName | String | True | ||
| WorkerGroups | String | True | ||
| WorkerProbationIndicator | Boolean | True | ||
| WorkerProbationPeriodEndDate | Date | True | ||
| WorkerProbationPeriodStartDate | Date | True | ||
| WorkerTypeCodeValue | String | False |
WorkerTypeCode.CodeValue | |
| WorkerTypeCodeLongName | String | True | ||
| WorkerTypeCodeShortName | String | True | ||
| WorkLevelCodeValue | String | True | ||
| WorkLevelCodeLongName | String | True | ||
| WorkLevelCodeShortName | String | True | ||
| WorkShiftCodeValue | String | True | ||
| WorkShiftCodeLongName | String | True | ||
| WorkShiftCodeShortName | String | True | ||
| JobFunctionCodeValue | String | True | ||
| JobFunctionCodeShortName | String | True | ||
| JobFunctionCodeLongName | String | True | ||
| AsOfDate | Date | True |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| EffectiveDate | Date |
To update positionid and AssignedOrganizationalUnits |
| LastWorkedDate | Date |
Worker Termination Update |
| RehireEligibleIndicator | Boolean |
Worker Termination Update |
| SeveranceEligibleIndicator | Boolean |
Worker Termination Update |
| TerminationComments | String |
Worker Termination Update |
| BaseRemunerationCode | String | |
| EventReasonCode | String |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AdditionalRemunerationNameCode | Additional remuneration name code. |
| AssociatePaymentsAllocationsEarningsAndBenefits | View the associate payment allocation earnings and benefits in the payroll outputs. |
| AssociatePaymentsAllocationsEarningSections | View the earning sections for the associate payments allocations in payroll outputs. |
| AssociatePaymentsAllocationsNonStatutoryDeductions | View the non-statutory deductions for the associate payments allocations in payroll outputs. |
| AssociatePaymentsAllocationsStatutoryDeductions | View the statutory deductions for the associate payments allocations in payroll outputs. |
| AssociatePaymentsSummaryEarningsAndBenefits | View the AssociatePayments Earnings and Benefits in the payroll outputs. |
| AssociatePaymentsSummaryEarningsSections | View the associate payments earnings sections items in the payroll outputs. |
| AssociatePaymentsSummaryNonStatutoryDeductions | To view the non statutory deduction for the associate in payroll outputs. |
| AssociatePaymentsSummaryPayrollAccumulations | To View the associate payments payroll accumulations in the payroll outputs. |
| AssociatePaymentsSummaryStatutoryDeductions | View the statutory deduction for the associate in payroll outputs. |
| CostCenters | Returns all Cost number codes setup for the client. |
| DeductionInputCode | Returns deduction input code. |
| EarningInputCode | Returns earning input code. |
| GenerationAffixCode | Returns legal name generation affix code. |
| HighestEducationLevelCode | Returns highest education level code value. |
| JobApplications | Returns a list of job applications. |
| JobApplicationsCommunicationLandlines | Returns a list of job applications communication landlines. |
| JobApplicationsCommunicationMobiles | Returns a list of job applications communication mobiles. |
| jobRequisitions | Returns a list of job requisitions. |
| JobRequisitionsOrganizationalUnits | View the organizational unit entries in Job Requisitions. |
| MaritalStatusCode | Returns marital status codes. |
| OnboardingTemplate | Returns onboarding template. |
| PaidTimeOffBalances | Returns Paid TimeOff Balances. |
| PaidTimeOffRequestEntries | Returns PaidTimeOff Requests. |
| PaidTimeOffRequests | Returns PaidTimeOff Requests. |
| PayrollGroup | Returns payroll group. |
| PayrollMemos | View the payroll memos. |
| PersonalContacts | Personal emergency contacts. |
| QualificationAffixCode | Returns work assignement worker type codes. |
| ReimbursementInputCode | Returns reimbursement input code. |
| TeamTimeCards | View the Team Time Cards. |
| TeamTimeCardsAllTeams | View the Team Time Cards of all teams. |
| TeamTimeCardsDailyTotals | View the Team Time Cards daily totals aggregate. |
| TeamTimeCardsDayEntries | View the Team Time Cards daily totals aggregate with day entries. |
| TeamTimeCardsHomeLaborAllocations | View the Team Time Cards period totals aggregate. |
| TeamTimeCardsPeriodTotals | View the Team Time Cards period totals aggregate. |
| TimeCards | View the worker Time Cards. |
| TimeCardsAllActiveWorkers | View the Time Cards of all active workers. |
| TimeCardsDailyTotals | View the worker Time Cards daily totals aggregate. |
| TimeCardsPeriodTotals | View the worker Time Cards period totals aggregate. |
| WageLawCoverageCode | Returns wage law coverage codes. |
| WorkAssignmentCustomHistoryCustomGroupAmountFields | Work assignment CustomGroup amount. |
| WorkAssignmentCustomHistoryCustomGroupCodeFields | Work assignment CustomGroup code. |
| WorkAssignmentCustomHistoryCustomGroupDateFields | Work assignment CustomGroup date. |
| WorkAssignmentCustomHistoryCustomGroupDateTimeFields | Work assignment CustomGroup date time. |
| WorkAssignmentCustomHistoryCustomGroupIndicatorFields | Work assignment CustomGroup indicator. |
| WorkAssignmentCustomHistoryCustomGroupLinks | Work assignment CustomGroup links. |
| WorkAssignmentCustomHistoryCustomGroupNumberFields | Work assignment CustomGroup number. |
| WorkAssignmentCustomHistoryCustomGroupPercentFields | Work assignment CustomGroup percent. |
| WorkAssignmentCustomHistoryCustomGroupStringFields | Work assignment CustomGroup string. |
| WorkAssignmentCustomHistoryCustomGroupTelephoneFields | Work assignment CustomGroup telephone. |
| WorkAssignmentHistory | Work assignment history. |
| WorkAssignmentHistoryAdditionalRemunerations | Work assignment additionsla remunerations history. |
| WorkAssignmentHistoryAssignedOrganizationalUnits | Work assignment organization units history. |
| WorkAssignmentHistoryAssignedWorkLocations | Work assignment Assigned locations history. |
| WorkAssignmentHistoryCommunicationsEmails | Work assignment communication history mail. |
| WorkAssignmentHistoryCommunicationsFaxes | Work assignment communication Fax History. |
| WorkAssignmentHistoryCommunicationsInstantMessages | Work assignment communication message History. |
| WorkAssignmentHistoryCommunicationsInternetAddresses | Work assignment communication Internet address History. |
| WorkAssignmentHistoryCommunicationsLandlines | Work assignment communication landline history. |
| WorkAssignmentHistoryCommunicationsMobiles | Work assignment communication mobile History. |
| WorkAssignmentHistoryCommunicationsPagers | Work assignment communication Pager History. |
| WorkAssignmentHistoryCommunicationsSocialNetworks | Work assignment communication social network history. |
| WorkAssignmentHistoryHomeOrganizationalUnits | Work assignment Home organization history. |
| WorkAssignmentHistoryIndustryClassifications | Work assignment industry classification history. |
| WorkAssignmentHistoryOccupationalClassifications | Work assignment occupational classification history. |
| WorkAssignmentHistoryReport | Work assignment Report. |
| WorkAssignmentHistoryWorkerGroups | Work assignment group history. |
| WorkerDemographics | Returns a list of demographics for each worker in the organization. |
| WorkersBusinessCommunicationEmails | Returns workers business communication emails. |
| WorkersBusinessCommunicationFaxes | Returns workers business communication faxes. |
| WorkersBusinessCommunicationLandlines | Returns workers business communication landlines. |
| WorkersBusinessCommunicationMobiles | Returns workers business communication mobiles. |
| WorkersBusinessCommunicationPagers | Returns workers business communication pagers. |
| WorkersPersonBirthNamePreferredSalutations | Returns workers person birth name preferred salutations. |
| WorkersPersonBirthNameTitleAffixCodes | Returns workers person birth name title affix codes. |
| WorkersPersonBirthNameTitlePrefixCodes | Returns workers person birth name title prefix codes. |
| WorkersPersonGovernmentIDs | Returns workers person government IDs. |
| WorkersPersonLegalNamePreferredSalutations | Returns workers person legal name preferred salutations. |
| WorkersPersonLegalNameTitleAffixCodes | Returns workers person legal name title affix codes. |
| WorkersPersonLegalNameTitlePrefixCodes | Returns workers person legal name title prefix codes. |
| WorkersPersonMilitaryClassificationCodes | Returns workers person military classification codes. |
| WorkersPhotoLinks | Returns workers photo links. |
| WorkersPhotos | Returns workers photos. |
| WorkersWorkAssignmentReportsTo | Returns workers work assignment ReportsTo. |
| WorkersWorkAssignmentsAssignedOrganizationalUnits | Returns workers work assignments assigned organizational units. |
| WorkersWorkAssignmentsAssignedWorkLocations | Returns workers work assignments assigned work locations. |
| WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails | Returns workers work assignments assigned work locations communication emails. |
| WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes | Returns workers work assignments assigned work locations communication faxes. |
| WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines | Returns workers work assignments assigned work locations communication landlines. |
| WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles | Returns workers work assignments assigned work locations communication mobiles. |
| WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers | Returns workers work assignments assigned work locations communication pagers. |
| WorkersWorkAssignmentsHomeOrganizationalUnits | Returns workers work assignments home organizational units. |
| WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails | Returns workers work assignments home work location communication emails. |
| WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes | Returns workers work assignments home work location communication faxes. |
| WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines | Returns workers work assignments home work location communication landlines. |
| WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles | Returns workers work assignments home work location communication mobiles. |
| WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers | Returns workers work assignments home work location communication pagers. |
| WorkersWorkAssignmentsIndustryClassifications | Returns workers work assignments industry classifications. |
| WorkersWorkAssignmentsLinks | Returns workers work assignments links. |
| WorkersWorkAssignmentsOccupationalClassifications | Returns workers work assignments occupational classifications. |
| WorkersWorkAssignmentsWorkerGroups | Work assignments worker groups. |
| WorkerTypeCode | Work assignment worker type codes. |
| WorkSchedules | View the Work Schedules. |
| WorkSchedulesEntries | View the schedule days entries in Work Schedules. |
Additional remuneration name code.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String |
View the associate payment allocation earnings and benefits in the payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| payments | String |
View the earning sections for the associate payments allocations in payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| ConfigurationTags | String | ||
| EarningAmountValue | Double | ||
| EarningClassificationCodeValue | String | ||
| EarningClassificationCodeShortName | String | ||
| EarningIDDescription | String | ||
| EarningIDValue | String | ||
| PayRateBaseUnitCodeValue | String | ||
| PayRateBaseUnitCodeShortName | String | ||
| PayRateValue | Double | ||
| TimeWorkedQuantityValue | Double | ||
| TimeWorkedQuantityunitTimeCodeValue | String | ||
| TimeWorkedQuantityUnitTimeCodeShortName | String | ||
| DepartmentId | String |
View the non-statutory deductions for the associate payments allocations in payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | . | |
| SectionName | String | ||
| SectionCategory | String | ||
| AssociateDeductionTakenAmountValue | Double | ||
| DeductionIDDescription | String | ||
| DeductionIDValue | String | ||
| DepartmentId | String |
View the statutory deductions for the associate payments allocations in payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| SectionName | String | ||
| SectionCategory | String | ||
| AssociateDeductionTakenAmountValue | Double | ||
| AssociateTaxableAmountValue | Double | ||
| ConfigurationTags | String | ||
| EmployerPaidAmountValue | Double | ||
| EmployerTaxableAmountValue | Double | ||
| StatutoryDeductionTypeCodeValue | String | ||
| StatutoryDeductionTypeCodeShortName | String | ||
| StatutoryJurisdictionAdministrativeLevel1.codeValue | String | ||
| StatutoryJurisdictionWorkedInIndicator | Boolean | ||
| DepartmentId | String |
View the AssociatePayments Earnings and Benefits in the payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| Payments | String |
View the associate payments earnings sections items in the payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| ConfigurationTags | String | ||
| EarningAmountValue | Double | ||
| EarningClassificationCodeValue | String | ||
| EarningClassificationCodeShortName | String | ||
| EarningIDDescription | String | ||
| EarningIDValue | String | ||
| PayRateBaseUnitCodeValue | String | ||
| PayRateBaseUnitCodeShortName | String | ||
| PayRateRateValue | Double | ||
| PayrollAccumulations | String | ||
| TimeWorkedQuantityValue | Double | ||
| TimeWorkedQuantityUnitTimeCodeValue | String | ||
| TimeWorkedQuantityUnitTimeCodeName | String | ||
| DepartmentId | String |
To view the non statutory deduction for the associate in payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection |
| AssociateOID | String | ||
| SectionName | String | ||
| SectionCategory | String | ||
| AssociateDeductionAmountValue | Double | ||
| AssociateDeductionTakenAmountValue | Double | ||
| DeductionIDDescription | String | ||
| DeductionIDValue | String | ||
| PayrollAccumulations | String | ||
| DepartmentId | String |
To View the associate payments payroll accumulations in the payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| AccumulatedAmountValue | Double | ||
| AccumulatedTimeWorkedQuantityValue | Double | ||
| AccumulatedTimeWorkedQuantityUnitTimeCodeValue | String | ||
| AccumulatedTimeWorkedQuantityUnitTimeCodeShortName | String | ||
| AccumulatorCodeValue | String | ||
| AccumulatorCodeLongName | String | ||
| AccumulatorCodeShortName | String | ||
| AccumulatorDescription | String | ||
| AccumulatorTimeUnitCodeValue | String | ||
| AccumulatorTimeUnitCodeShortName | String | ||
| DepartmentId | String |
View the statutory deduction for the associate in payroll outputs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| SectionCategory | String | ||
| SectionName | String | ||
| AssociateDeductionAmountValue | Double | ||
| AssociateDeductionTakenAmountValue | Double | ||
| AssociateTaxableAmountValue | Double | ||
| ConfigurationTags | String | ||
| EmployerPaidAmountValue | Double | ||
| EmployerTaxableAmountValue | Double | ||
| PayrollAccumulations | String | ||
| StatutoryDeductionTypeCodeValue | String | ||
| StatutoryDeductionTypeCodeASortName | String | ||
| StatutoryJurisdictionAdministrativeLevel1CodeValue | String | ||
| StatutoryJurisdictionWorkedInIndicator | Boolean | ||
| DepartmentId | String |
Returns all Cost number codes setup for the client.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM CostCenters
| Name | Type | References | Description |
| Code | String | Code for the Cost Center. | |
| Description | String | Description for the Cost Center. | |
| CompanyCode | String | Payroll Group Code. | |
| Active | Boolean | It indicate if the department is still in use. |
Returns deduction input code.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String | ||
| Description | String |
Returns earning input code.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String | ||
| LongName | String | ||
| Description | String |
Returns legal name generation affix code.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String |
Returns highest education level code value.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String |
Returns a list of job applications.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM JobApplications
| Name | Type | References | Description |
| ItemID | String | ||
| RequisitionID | String | ||
| RequisitionTitle | String | ||
| ClientRequisitionID | String | ||
| InternalIndicator | Boolean | ||
| ExternalIndicator | Boolean | ||
| HiringManagerID | String | ||
| HiringManagerWorkerID | String | ||
| HiringManagerGivenName | String | ||
| HiringManagerFamilyName | String | ||
| HiringManagerFormattedName | String | ||
| ApplicationEffectiveDate | Date | ||
| ApplicationShortName | String | ||
| ApplicationCode | String | ||
| ApplicationPostingChannelID | String | ||
| ApplicationPostingChannelCode | String | ||
| ApplicationPostingChannelShortName | String | ||
| ApplicationSubmittedByAssociateOID | String | ||
| ApplicationSubmittedByGivenName | String | ||
| ApplicationSubmittedByFamilyName | String | ||
| ApplicationSubmittedDate | Date | ||
| ApplicantID | String | ||
| ApplicantInternalIndicator | Boolean | ||
| ApplicantWotcScreeningShortName | String | ||
| ApplicantWotcScreeningLongName | String | ||
| ApplicantWotcScreeningCode | String | ||
| ApplicantBackgroundScreeningLongName | String | ||
| ApplicantBackgroundScreeningCode | String | ||
| ApplicantCountryCode | String | ||
| ApplicantCityName | String | ||
| ApplicantCountrySubdivisionType | String | ||
| ApplicantCountrySubdivisionShortName | String | ||
| ApplicantCountrySubdivisionCode | String | ||
| ApplicantAddressLine1 | String | ||
| ApplicantPostalCode | String | ||
| CommunicationLandlines | String | ||
| CommunicationMobiles | String | ||
| ApplicantGivenName | String | ||
| ApplicantFamilyName | String | ||
| ApplicantFormattedName | String | ||
| AppliedLocationItemID | String | ||
| AppliedLocationCode | String | ||
| AppliedLocationShortName | String |
Returns a list of job applications communication landlines.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM JobApplicationsCommunicationLandlines
| Name | Type | References | Description |
| ApplicantID | String | ||
| ItemID | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| FormattedNumber | String | ||
| NameCodeValue | String |
Returns a list of job applications communication mobiles.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM JobApplicationsCommunicationMobiles
| Name | Type | References | Description |
| ApplicantID | String | ||
| ItemID | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| FormattedNumber | String | ||
| NameCodeValue | String |
Returns a list of job requisitions.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM JobRequisitions
| Name | Type | References | Description |
| ItemID | String | ||
| PostingInstructionsCode | String | ||
| PostingInstructionsLongName | String | ||
| PostingInstructionsInternalIndicator | Boolean | ||
| PostingChannelID | String | ||
| PostingChannelCode | String | ||
| PostingChannelShortName | String | ||
| PostingChannelLongName | String | ||
| PostingChannelInternetAddress | String | ||
| PostingChannelExternalIndicator | Boolean | ||
| PostingChannelDefaultIndicator | Boolean | ||
| PostingInstructionsExpireDate | Date | ||
| PostingInstructionsResumeRequiredIndicator | Boolean | ||
| PostingInstructionsValidityAttestationIndicator | Boolean | ||
| PostingInstructionsPostDate | Date | ||
| LinksHref | String | ||
| LinksRel | String | ||
| LinksTitle | String | ||
| SupportedLocaleCodes | String | ||
| OpeningsNewPositionQuantity | Integer | ||
| WorkedInCountry | String | ||
| WorkerTypeCode | String | ||
| WorkerTypeShortName | String | ||
| CompanyName | String | ||
| LocationVisibleIndicator | Boolean | ||
| CompensationVisibleIndicator | Boolean | ||
| OpeningsFilledQuantity | Integer | ||
| OrganizationalUnits | String | ||
| OpeningsQuantity | Integer | ||
| EvergreenIndicator | Boolean | ||
| ProjectedStartDate | Date | ||
| ExternalIndicator | Boolean | ||
| VisibleToJobSeekerIndicator | Boolean | ||
| LieDetectorAcknowledgementIndicator | Boolean | ||
| HiringManagerID | String | ||
| HiringManagerWorkerID | String | ||
| HiringManagerGivenName | String | ||
| HiringManagerFamilyName | String | ||
| HiringManagerFormattedName | String | ||
| ClientRequisitionID | String | ||
| RequisitionEffectiveDate | Date | ||
| RequisitionShortName | String | ||
| RequisitionCode | String | ||
| JobCode | String | ||
| JobShortName | String | ||
| JobTitle | String | ||
| OccupationalClassificationsCode | String | ||
| OccupationalClassificationsShortName | String | ||
| RequisitionLocationsID | String | ||
| RequisitionLocationsPostalCode | String | ||
| RequisitionLocationsCityName | String | ||
| RequisitionLocationsCountrySubdivisionLevel1Code | String | ||
| RequisitionLocationsAddressLine1 | String | ||
| RequisitionLocationsCountryCode | String | ||
| RequisitionLocationsCode | String | ||
| RequisitionLocationsShortName | String |
View the organizational unit entries in Job Requisitions.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following query is processed server side:
SELECT * FROM JobRequisitionsOrganizationalUnits
| Name | Type | References | Description |
| JobRequisitionID | String | ||
| OrganizationalUnitID | String | ||
| typeCodeValue | String | ||
| typeCodeShortName | String | ||
| nameCodeValue | String | ||
| nameCodeShortName | String |
Returns marital status codes.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String | ||
| Description | String |
Returns onboarding template.
| Name | Type | References | Description |
| ItemID | String | ||
| Code | String | ||
| Name | String |
Returns Paid TimeOff Balances.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM PaidTimeOffBalances WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String | ||
| BalanceTypeCode | String | ||
| BalanceTypeLabelName | String | ||
| TotalQuantityValueNumber | Double | ||
| TotalQuantityUnitTimeCode | String | ||
| TotalQuantityLabelName | String | ||
| TotalTime | String | ||
| AccrualBalances | String | ||
| PaidTimeOffEntries | String | ||
| PaidTimeOffPolicyCode | String | ||
| PaidTimeOffPolicyLabelName | String | ||
| AsOfDate | Date | ||
| PositionRefPositionID | String | ||
| PositionRefSchemeName | String | ||
| PositionRefSchemeAgencyName | String | ||
| PositionReftitle | String |
Returns PaidTimeOff Requests.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM PaidTimeOffRequestEntries WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String | ||
| RequestID | String | ||
| timeOffEntryID | String | ||
| paidTimeOffID | String | ||
| paidTimeOffPolicyCode | String | ||
| paidTimeOffPolicyLabelName | String | ||
| EntryStatusCode | String | ||
| EntryStatusLabelName | String | ||
| EarningTypeCode | String | ||
| EarningTypeName | String | ||
| StartDate | Date | ||
| EndDate | Date | ||
| startTime | String | ||
| TotalQuantityvalueNumber | String | ||
| TotalQuantityunitTimeCode | String | ||
| TotalQuantitylabelName | String | ||
| Meta | String |
Returns PaidTimeOff Requests.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM PaidTimeOffRequests WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String | ||
| RequestID | String | ||
| RequestStatusCode | String | ||
| RequestStatusLabelName | String | ||
| TotalQuantityvalueNumber | String | ||
| TotalQuantityunitTimeCode | String | ||
| TotalQuantitylabelName | String | ||
| TotalTime | String | ||
| paidTimeOffEntries | String | ||
| RequestURI | String | ||
| RequestDesc | String | ||
| RequestStartDate | Date | ||
| MetadataEntitlementCodes | String | ||
| MetaMultiPeriodRequestIndicator | Boolean | ||
| Actions | String | ||
| RequestorComment | String | ||
| ApprovalDueDate | Date | ||
| PositionRefPositionID | String | ||
| PositionRefSchemeName | String | ||
| PositionRefSchemeAgencyName | String | ||
| PositionReftitle | String |
Returns payroll group.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PayrollGroup WHERE Category = 'US'
| Name | Type | References | Description |
| Code | String | ||
| Name | String | ||
| Category | String |
View the payroll memos.
| Name | Type | References | Description |
| ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
| AssociateOID | String | ||
| MemoIDDescription | String | ||
| MemoIDValue | String | ||
| MemoIDAlternateDescriptions | String | ||
| MemoAmountValue | Double | ||
| ConfigurationTags | String |
Personal emergency contacts.
The Sync App uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM PersonalContacts WHERE AssociateOID = 'G3349PZGBADQY8H7'The rest of the filter is executed client-side within the Sync App.
| Name | Type | References | Description |
| PersonName | String | ||
| AddressLine1 | String | ||
| AddressLine2 | String | ||
| AddressLine3 | String | ||
| AddressCityName | String | ||
| AddressCountrySubdivisionLevel1SubdivisionType | String | ||
| AddressCountrySubdivisionLevel1Code | String | ||
| AddressCountrySubdivisionLevel1ShortName | String | ||
| AddressCountrySubdivisionLevel1LongName | String | ||
| AddressCountryCode | String | ||
| AddressPostalCode | String | ||
| CommunicationLandlines | String | ||
| CommunicationMobiles | String | ||
| CommunicationEmails | String | ||
| ContactTypeCode | String | ||
| ContactTypeCodeShortName | String | ||
| RelationshipTypeCode | String | ||
| RelationshipTypeCodeShortName | String | ||
| PrecedenceCode | String | ||
| PrecedenceCodeShortName | String | ||
| ItemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Returns work assignement worker type codes.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String | ||
| LongName | String | ||
| Description | String |
Returns reimbursement input code.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String | ||
| Description | String |
View the Team Time Cards.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TeamTimeCards WHERE ManagerOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| PersonLegalName | String | ||
| PersonLegalFamilyName1 | String | ||
| PersonLegalFormattedName | String | ||
| ProcessingStatusCodeValue | String | ||
| ProcessingStatusCodeShortName | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| periodCodeShortName | String | ||
| periodCodeLongName | String | ||
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String | ||
| TimePeriodPeriodStatus | String | ||
| PositionID | String | ||
| PeriodTotals | String | ||
| DailyTotals | String | ||
| TotalPeriodTimeDuration | String | ||
| HomeLaborAllocations | String | ||
| ExceptionsIndicator | Boolean | ||
| ManagerOID | String |
Workers.AssociateOID |
View the Team Time Cards of all teams.
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| PersonLegalName | String | ||
| PersonLegalFamilyName1 | String | ||
| PersonLegalFormattedName | String | ||
| ProcessingStatusCodeValue | String | ||
| ProcessingStatusCodeShortName | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| periodCodeShortName | String | ||
| periodCodeLongName | String | ||
| TimePeriodStartDate | Date | ||
| TimePeriodEndDate | Date | ||
| TimePeriodPeriodStatus | String | ||
| PositionID | String | ||
| PeriodTotals | String | ||
| DailyTotals | String | ||
| TotalPeriodTimeDuration | String | ||
| HomeLaborAllocations | String | ||
| ExceptionsIndicator | Boolean | ||
| ManagerOID | String |
Workers.AssociateOID |
View the Team Time Cards daily totals aggregate.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TeamTimeCardsDailyTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| EntryDate | Date | ||
| PayCodeCodeValue | String | ||
| RateBaseMultiplierValue | String | ||
| RateAmountValue | Double | ||
| RateCurrencyCode | String | ||
| TimeDuration | String | ||
| HomeLaborAllocations | String | ||
| DayEntries | String | ||
| ManagerOID | String |
Workers.AssociateOID | |
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String |
View the Team Time Cards daily totals aggregate with day entries.
The Sync App uses the ADP API to process WHERE clause conditions that are built with the following column and operator. The ManagerOID column is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TeamTimeCardsDayEntries WHERE ManagerOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| EntryDate | Date | ||
| TotalPeriodTimeDuration | String | ||
| TimeEntryID | String | ||
| TimeEntryTypeCode | String | ||
| TimeEntryStartPeriod | String | ||
| TimeEntryEndPeriod | String | ||
| TimeEntryLaborAllocations | String | ||
| TimeEntryExceptions | String | ||
| TimeEntryTimeDuration | String | ||
| TimeEntryActions | String | ||
| TimeEntryStatusCodeValue | String | ||
| TimeEntryStatusShortName | String | ||
| TimeEntryTotalsPayCodeValue | String | ||
| TimeEntryTotalsRateMultiplier | String | ||
| TimeEntryTotalsRateAmountValue | String | ||
| TimeEntryTotalsRateCurrencyCode | String | ||
| TimeEntryTotalsTimeDuration | String | ||
| ManagerOID | String |
Workers.AssociateOID | |
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String |
View the Team Time Cards period totals aggregate.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TeamTimeCardsHomeLaborAllocations WHERE ManagerOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| AllocationCode | String | ||
| AllocationTypeCodeValue | String | ||
| AllocationTypeCodeShortName | String | ||
| ManagerOID | String |
Workers.AssociateOID | |
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodEndDate | String |
View the Team Time Cards period totals aggregate.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TeamTimeCardsPeriodTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| payCodecodeValue | String | ||
| RateBaseMultiplierValue | String | ||
| RateAmountValue | Double | ||
| RateCurrencyCode | String | ||
| TimeDuration | String | ||
| ManagerOID | String |
Workers.AssociateOID | |
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String |
View the worker Time Cards.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TimeCards WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| PersonLegalName | String | ||
| PersonLegalFamilyName1 | String | ||
| PersonLegalFormattedName | String | ||
| ProcessingStatusCodeValue | String | ||
| ProcessingStatusCodeShortName | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| periodCodeShortName | String | ||
| periodCodeLongName | String | ||
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String | ||
| TimePeriodPeriodStatus | String | ||
| PositionID | String | ||
| ExceptionCounts | String | ||
| PeriodTotals | String | ||
| DailyTotals | String | ||
| TotalPeriodTimeDuration | String | ||
| HomeLaborAllocations | String | ||
| Actions | String |
View the Time Cards of all active workers.
| Name | Type | References | Description |
| AssociateOID [KEY] | String |
Workers.AssociateOID | |
| WorkerID [KEY] | String | ||
| TimeCardID [KEY] | String | ||
| PersonLegalName | String | ||
| PersonLegalFamilyName1 | String | ||
| PersonLegalFormattedName | String | ||
| ProcessingStatusCodeValue | String | ||
| ProcessingStatusCodeShortName | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| periodCodeShortName | String | ||
| periodCodeLongName | String | ||
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String | ||
| TimePeriodPeriodStatus | String | ||
| PositionID | String | ||
| ExceptionCounts | String | ||
| PeriodTotals | String | ||
| DailyTotals | String | ||
| TotalPeriodTimeDuration | String | ||
| HomeLaborAllocations | String | ||
| Actions | String |
View the worker Time Cards daily totals aggregate.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TimeCardsDailyTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| EntryDate | Date | ||
| PayCodeCodeValue | String | ||
| PayCodeShortName | String | ||
| RateBaseMultiplierValue | String | ||
| RateAmountValue | Double | ||
| RateCurrencyCode | String | ||
| TimeDuration | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String |
View the worker Time Cards period totals aggregate.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the Sync App.
SELECT * FROM TimeCardsPeriodTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String | ||
| TimeCardID | String | ||
| payCodecodeValue | String | ||
| payCodeshortName | String | ||
| RateBaseMultiplierValue | String | ||
| RateAmountValue | Double | ||
| RateCurrencyCode | String | ||
| TimeDuration | String | ||
| periodCodeValue | String | Supported values: current, next, previous, etc. | |
| TimePeriodStartDate | String | ||
| TimePeriodEndDate | String |
Returns wage law coverage codes.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String |
Work assignment CustomGroup amount.
| Name | Type | References | Description |
| AmountValue | Integer | ||
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| CurrencyCode | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup code.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| CodeValue | String | ||
| ItemID | String | ||
| LongName | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| ShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup date.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| DateValue | Date | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup date time.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| DateTimeValue | Datetime | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup indicator.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| IndicatorValue | Boolean | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup links.
| Name | Type | References | Description |
| EncType | String | ||
| Href | String | ||
| MediaType | String | ||
| Method | String | ||
| PayLoadArguments | String | ||
| Rel | String | ||
| Schema | String | ||
| TargetSchema | String | ||
| Title | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup number.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NumberValue | Integer | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup percent.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| PercentValue | Integer | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup string.
| Name | Type | References | Description |
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| StringValue | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup telephone.
| Name | Type | References | Description |
| Access | String | ||
| AreaDialing | String | ||
| CategoryCodeCodeValue | String | ||
| CategoryCodeLongName | String | ||
| CategoryCodeShortName | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment history.
| Name | Type | References | Description |
| PrimaryIndicator | Boolean | ||
| OfferExtensionDate | Date | ||
| OfferAcceptanceDate | Date | ||
| HireDate | Date | ||
| SeniorityDate | Date | ||
| ExpectedStartDate | Date | ||
| ActualStartDate | Date | ||
| TerminationDate | Date | ||
| AssignmentStatusCode | String | ||
| AssignmentStatusCodeValue | String | ||
| AssignmentStatusLongName | String | ||
| AssignmentStatusreasonCodeValue | String | ||
| AssignmentStatusreasonCodeShortName | String | ||
| AssignmentStatusreasonCodeLongName | String | ||
| AssignmentStatusEffectiveDate | Date | ||
| WorkerTypeCodeValue | String | ||
| WorkerTypeShortName | String | ||
| WorkerTypeLongName | String | ||
| AssignmentTermCodeValue | String | ||
| AssignmentTermCodeShortName | String | ||
| AssignmentTermCodeLongName | String | ||
| WorkLevelCodeValue | String | ||
| WorkLevelCodeShortName | String | ||
| WorkLevelCodeLongName | String | ||
| NationalityContextCodeValue | String | ||
| NationalityContextCodeShortName | String | ||
| NationalityContextCodeLongName | String | ||
| VipIndicator | Boolean | ||
| VipTypeCodeValue | String | ||
| VipTypeCodeShortName | String | ||
| VipTypeCodeLongName | String | ||
| ExecutiveIndicator | Boolean | ||
| ExecutiveTypeCodeValue | String | ||
| ExecutiveTypeCodeShortName | String | ||
| ExecutiveTypeCodeLongName | String | ||
| OfficerIndicator | Boolean | ||
| OfficerTypeCodeValue | String | ||
| OfficerTypeCodeShortName | String | ||
| OfficerTypeCodeLongName | String | ||
| ManagementPositionIndicator | Boolean | ||
| LegalEntityID | String | ||
| HighlyCompensatedIndicator | Boolean | ||
| HighlyCompensatedTypeCodeValue | String | ||
| HighlyCompensatedTypeCodeShortName | String | ||
| HighlyCompensatedTypeCodeLongName | String | ||
| StockOwnerIndicator | Boolean | ||
| StockOwnerPercentage | Double | ||
| JobCodeValue | String | ||
| JobCodeShortName | String | ||
| JobCodeLongName | String | ||
| JobTitle | String | ||
| WageLawCoverageCodeValue | String | ||
| WageLawCoverageCodeShortName | String | ||
| WageLawCoverageCodeLongName | String | ||
| WageLawCoverageLawNameCodeValue | String | ||
| WageLawCoverageLawNameCodeShortName | String | ||
| WageLawCoverageLawNameCodeLongName | String | ||
| PositionID | String | ||
| PositionTitle | String | ||
| LaborUnionCodeValue | String | ||
| LaborUnionshortName | String | ||
| LaborUnionlongName | String | ||
| LaborUnionSeniorityDate | Date | ||
| BargainingUnitCodeValue | String | ||
| BargainingUnitshortName | String | ||
| BargainingUnitlongName | String | ||
| BargainingUnitSeniorityDate | Date | ||
| WorkShiftCodeValue | String | ||
| WorkShiftCodeshortName | String | ||
| WorkShiftCodelongName | String | ||
| WorkArrangementCodeValue | String | ||
| WorkArrangementCodeshortName | String | ||
| WorkArrangementCodelongName | String | ||
| StandardHoursQuality | String | ||
| StandardHoursCodeValue | Integer | ||
| StandardHoursCodeshortName | String | ||
| StandardHoursCodelongName | String | ||
| FullTimeEquivalenceRatio | Integer | ||
| HomeWorkLocationCodeValue | String | ||
| HomeWorkLocationCodeshortName | String | ||
| HomeWorkLocationCodelongName | String | ||
| HomeWorkLocationAddressScriptCodeValue | String | ||
| HomeWorkLocationAddressScriptCodeshortName | String | ||
| HomeWorkLocationAddressScriptCodelongName | String | ||
| HomeWorkLocationAddresslineFour | String | ||
| HomeWorkLocationAddresslineFive | String | ||
| HomeWorkLocationAddressbuildingNumber | String | ||
| HomeWorkLocationAddressbuildingName | String | ||
| HomeWorkLocationAddressblockName | String | ||
| HomeWorkLocationAddressstreetName | String | ||
| HomeWorkLocationAddressstreetTypeCodeValue | String | ||
| HomeWorkLocationAddressstreetTypeCodeshortName | String | ||
| HomeWorkLocationAddressstreetTypeCodelongName | String | ||
| HomeWorkLocationAddressunit | String | ||
| HomeWorkLocationAddressfloor | String | ||
| HomeWorkLocationAddressstairCase | String | ||
| HomeWorkLocationAddressdoor | String | ||
| HomeWorkLocationAddresspostOfficeBox | String | ||
| HomeWorkLocationAddressdeliveryPoint | String | ||
| HomeWorkLocationAddressplotID | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel2Value | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel2shortName | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel2longName | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel2subdivisionType | String | ||
| HomeWorkLocationAddressnameCodeValue | String | ||
| HomeWorkLocationAddressnameCodeshortName | String | ||
| HomeWorkLocationAddressnameCodelongName | String | ||
| HomeWorkLocationAddressattentionOfName | String | ||
| HomeWorkLocationAddresscareOfName | String | ||
| HomeWorkLocationAddresslineOne | String | ||
| HomeWorkLocationAddresslineTwo | String | ||
| HomeWorkLocationAddresslineThree | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel1Value | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel1shortName | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel1longName | String | ||
| HomeWorkLocationAddresscountrySubdivisionLevel1subdivisionType | String | ||
| HomeWorkLocationAddresscountryCode | String | ||
| HomeWorkLocationAddresspostalCode | String | ||
| HomeWorkLocationAddressgeoCoordinateLatitude | Double | ||
| HomeWorkLocationAddressgeoCoordinateLongitude | Double | ||
| RemunerationBasisCodeValue | String | ||
| RemunerationBasisCodeshortName | String | ||
| RemunerationBasisCodelongName | String | ||
| PayCycleCodeValue | String | ||
| PayCycleCodeshortName | String | ||
| PayCycleCodelongName | String | ||
| StandardPayPeriodHourshoursQuantity | Integer | ||
| StandardPayPeriodHoursCodeValue | String | ||
| StandardPayPeriodHoursCodeshortName | String | ||
| StandardPayPeriodHoursCodelongName | String | ||
| BaseRemunerationhourlyRateAmountcodeValue | String | ||
| BaseRemunerationhourlyRateAmountshortName | String | ||
| BaseRemunerationhourlyRateAmountlongName | String | ||
| BaseRemunerationhourlyRateAmountValue | String | ||
| BaseRemunerationhourlyRateAmountCurrencyCode | String | ||
| BaseRemunerationdailyRateAmountcodeValue | String | ||
| BaseRemunerationdailyRateAmountshortName | String | ||
| BaseRemunerationdailyRateAmountlongName | String | ||
| BaseRemunerationdailyRateAmountValue | String | ||
| BaseRemunerationdailyRateAmountCurrencyCode | String | ||
| BaseRemunerationweeklyRateAmountcodeValue | String | ||
| BaseRemunerationweeklyRateAmountshortName | String | ||
| BaseRemunerationweeklyRateAmountlongName | String | ||
| BaseRemunerationweeklyRateAmountValue | String | ||
| BaseRemunerationweeklyRateAmountCurrencyCode | String | ||
| BaseRemunerationbiweeklyRateAmountcodeValue | String | ||
| BaseRemunerationbiweeklyRateAmountshortName | String | ||
| BaseRemunerationbiweeklyRateAmountlongName | String | ||
| BaseRemunerationbiweeklyRateAmountValue | String | ||
| BaseRemunerationbiweeklyRateAmountCurrencyCode | String | ||
| BaseRemunerationsemiMonthlyRateAmountcodeValue | String | ||
| BaseRemunerationsemiMonthlyRateAmountshortName | String | ||
| BaseRemunerationsemiMonthlyRateAmountlongName | String | ||
| BaseRemunerationsemiMonthlyRateAmountValue | String | ||
| BaseRemunerationsemiMonthlyRateAmountCurrencyCode | String | ||
| BaseRemunerationmonthlyRateAmountcodeValue | String | ||
| BaseRemunerationmonthlyRateAmountshortName | String | ||
| BaseRemunerationmonthlyRateAmountlongName | String | ||
| BaseRemunerationmonthlyRateAmountValue | String | ||
| BaseRemunerationmonthlyRateAmountCurrencyCode | String | ||
| BaseRemunerationannualRateAmountcodeValue | String | ||
| BaseRemunerationannualRateAmountshortName | String | ||
| BaseRemunerationannualRateAmountlongName | String | ||
| BaseRemunerationannualRateAmountValue | String | ||
| BaseRemunerationannualRateAmountCurrencyCode | String | ||
| BaseRemunerationpayPeriodRateAmountcodeValue | String | ||
| BaseRemunerationpayPeriodRateAmountshortName | String | ||
| BaseRemunerationpayPeriodRateAmountlongName | String | ||
| BaseRemunerationpayPeriodRateAmountValue | String | ||
| BaseRemunerationpayPeriodRateAmountCurrencyCode | String | ||
| BaseRemunerationcommissionRatePercentagecodeValue | String | ||
| BaseRemunerationcommissionRatePercentageshortName | String | ||
| BaseRemunerationcommissionRatePercentagelongName | String | ||
| BaseRemunerationcommissionRatePercentageValue | String | ||
| BaseRemunerationcommissionRatePercentagebaseUnitCodeValue | String | ||
| BaseRemunerationcommissionRatePercentageCurrencyCodeshortName | String | ||
| BaseRemunerationcommissionRatePercentageCurrencyCodelongName | String | ||
| BaseRemunerationeffectiveDate | Date | ||
| PayrollProcessingStatusCodecodeValue | String | ||
| PayrollProcessingStatusCodeshortName | String | ||
| PayrollProcessingStatusCodelongName | String | ||
| PayrollProcessingStatusCodeEffectiveDate | Date | ||
| PayrollGroupCode | String | ||
| PayrollFileNumber | String | ||
| PayrollRegionCode | String | ||
| PayScaleCodecodeValue | String | ||
| PayScaleCodeshortName | String | ||
| PayScaleCodelongName | String | ||
| PayGradeCodecodeValue | String | ||
| PayGradeCodeshortName | String | ||
| PayGradeCodelongName | String | ||
| PayGradePayRangeminimumRateamountValue | String | ||
| PayGradePayRangeminimumRatecurrencyCode | String | ||
| PayGradePayRangeminimumRateUnitCodeValue | String | ||
| PayGradePayRangeminimumRateUnitshortName | String | ||
| PayGradePayRangeminimumRateUnitlongName | String | ||
| PayGradePayRangeminimumRateBaseUnitCodeValue | String | ||
| PayGradePayRangeminimumRateBaseUnitshortName | String | ||
| PayGradePayRangeminimumRateBaseUnitlongName | String | ||
| PayGradePayRangeminimumRatebaseMultiplierValue | Integer | ||
| PayGradePayRangemedianRateamountValue | String | ||
| PayGradePayRangemedianRatecurrencyCode | String | ||
| PayGradePayRangemedianRateUnitCodeValue | String | ||
| PayGradePayRangemedianRateUnitshortName | String | ||
| PayGradePayRangemedianRateBaseUnitCodeValue | String | ||
| PayGradePayRangemedianRateBaseUnitshortName | String | ||
| PayGradePayRangemedianRateBaseUnitlongName | String | ||
| PayGradePayRangemedianRatebaseMultiplierValue | Integer | ||
| PayGradePayRangemaximumRateamountValue | String | ||
| PayGradePayRangemaximumRatecurrencyCode | String | ||
| PayGradePayRangemaximumRateUnitCodeValue | String | ||
| PayGradePayRangemaximumRateUnitshortName | String | ||
| PayGradePayRangemaximumRateUnitlongName | String | ||
| PayGradePayRangemaximumRateBaseUnitCodeValue | String | ||
| PayGradePayRangemaximumRateBaseUnitshortName | String | ||
| PayGradePayRangemaximumRateBaseUnitlongName | String | ||
| PayGradePayRangemaximumRatebaseMultiplierValue | Integer | ||
| CompaRatio | Double | ||
| PayGradeStepCodeValue | String | ||
| PayGradeStepshortName | String | ||
| PayGradeSteplongName | String | ||
| PayGradeStepPayRateamountValue | String | ||
| PayGradeStepPayRatecurrencyCode | String | ||
| PayGradeStepPayRateUnitCodeValue | String | ||
| PayGradeStepPayRateUnitshortName | String | ||
| PayGradeStepPayRateUnitlongName | String | ||
| PayGradeStepPayRateBaseUnitCodeValue | String | ||
| PayGradeStepPayRateBaseUnitshortName | String | ||
| PayGradeStepPayRateBaseUnitlongName | String | ||
| PayGradeStepPayRatebaseMultiplierValue | Integer | ||
| NextPayGradeStepDate | Date | ||
| MinimumPayGradeStepDuration | String | ||
| GeographicPayDifferentialCodeValue | String | ||
| GeographicPayDifferentialshortName | String | ||
| GeographicPayDifferentiallongName | String | ||
| GeographicPayDifferentialPercentage | Double | ||
| ItemID | String | ||
| EffectiveDate | Date | ||
| FromDate | Date | ||
| ThruDate | Date | ||
| HistoryEventID | String | ||
| HistoryEventNameCodeValue | String | ||
| HistoryEventNameshortName | String | ||
| HistoryEventNamelongName | String | ||
| HistoryReasonCodeValue | String | ||
| HistoryReasonshortName | String | ||
| HistoryReasonlongName | String | ||
| HistoryEventActorId | String | ||
| HistoryEventActorCodeValue | String | ||
| HistoryEventActorshortName | String | ||
| HistoryEventActorlongName | String | ||
| HistoryEventActorassociateOID | String | ||
| HistoryEventActorpersonOID | String | ||
| HistoryEventActorformattedName | String | ||
| HistoryEventActordeviceID | String | ||
| HistoryEventActorlatitude | Double | ||
| HistoryEventActorlongitude | Double | ||
| HistoryEventActordeviceUserAgentID | String | ||
| WorkAssignmentID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment additionsla remunerations history.
| Name | Type | References | Description |
| TypeCodeValue | String | ||
| TypeCodeCodeshortName | String | ||
| TypeCodeCodelongName | String | ||
| IntervalCodeCodeValue | String | ||
| IntervalCodeCodeCodeshortName | String | ||
| IntervalCodeCodeCodelongName | String | ||
| NameCodeCodeValue | String | ||
| NameCodeCodeCodeshortName | String | ||
| NameCodeCodeCodelongName | String | ||
| RateAmountValue | Integer | ||
| RateCurrencyCode | String | ||
| RateUnitCode | String | ||
| RateshortName | String | ||
| RateLongName | String | ||
| RateBaseUnitCode | String | ||
| RateBaseshortName | String | ||
| RateBaseLongName | String | ||
| BaseMultiplierValue | Integer | ||
| ItemID | String | ||
| EffectiveDate | Date | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment organization units history.
| Name | Type | References | Description |
| NameCodeValue | String | ||
| NameCodeshortName | String | ||
| NameCodelongName | String | ||
| TypeCodeValue | String | ||
| TypeCodeshortName | String | ||
| TypeCodelongName | String | ||
| itemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment Assigned locations history.
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| AddressScriptCode | String | ||
| AddressShortName | String | ||
| AddressLongName | String | ||
| AddressLineFour | String | ||
| AddressLineFive | String | ||
| AddressBuildingNumber | String | ||
| AddressBuildingName | String | ||
| AddressBlockName | String | ||
| AddressStreetName | String | ||
| AddressStreetTypeCode | String | ||
| AddressStreetTypeShortName | String | ||
| AddressStreetTypeLongName | String | ||
| AddressUnit | Integer | ||
| AddressFloor | String | ||
| AddressStairCase | String | ||
| AddressDoor | String | ||
| AddressPostOfficeBox | String | ||
| AddressDeliveryPoint | String | ||
| AddressPlotID | String | ||
| AddressCountrySubdivisionLevel2 | String | ||
| AddressCountrySubdivisionLevel2ShortName | String | ||
| AddressCountrySubdivisionLevel2LongName | String | ||
| AddressCountrySubdivisionLevel2Type | String | ||
| AddressCountrySubdivisionLevel1 | String | ||
| AddressCountrySubdivisionShortName | String | ||
| AddressCountrySubdivisionLongName | String | ||
| AddressCountrySubdivisionType | String | ||
| AddressNameCode | String | ||
| AddressNameShortName | String | ||
| AddressNameLongName | String | ||
| AddressAttentionOfName | String | ||
| AddressCareOfName | String | ||
| AddressLineOne | String | ||
| AddressLineTwo | String | ||
| AddressLineThree | String | ||
| AddressCityName | String | ||
| AddressCountryCode | String | ||
| AddressPostalCode | String | ||
| AddressLatitude | Double | ||
| AddressLongitude | Double | ||
| NameCode | String | ||
| NameShortName | String | ||
| NameLongName | String |
Work assignment communication history mail.
| Name | Type | References | Description |
| EmailUri | String | ||
| ItemID | String | ||
| NameCodeCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Fax History.
| Name | Type | References | Description |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication message History.
| Name | Type | References | Description |
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| Uri | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Internet address History.
| Name | Type | References | Description |
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| Uri | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication landline history.
| Name | Type | References | Description |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication mobile History.
| Name | Type | References | Description |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Pager History.
| Name | Type | References | Description |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment communication social network history.
| Name | Type | References | Description |
| ItemID | String | ||
| NameCode.codeValue | String | ||
| NameCode.longName | String | ||
| NameCode.shortName | String | ||
| Uri | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment Home organization history.
| Name | Type | References | Description |
| NameCodeValue | String | ||
| NameCodeshortName | String | ||
| NameCodelongName | String | ||
| TypeCodeValue | String | ||
| TypeCodeshortName | String | ||
| TypeCodelongName | String | ||
| itemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment industry classification history.
| Name | Type | References | Description |
| nameCodeValue | String | ||
| nameCodeshortName | String | ||
| nameCodelongName | String | ||
| classificationCodeValue | String | ||
| classificationCodeshortName | String | ||
| classificationCodelongName | String | ||
| itemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment occupational classification history.
| Name | Type | References | Description |
| nameCodeValue | String | ||
| nameCodeshortName | String | ||
| nameCodelongName | String | ||
| classificationCodeValue | String | ||
| classificationCodeshortName | String | ||
| classificationCodelongName | String | ||
| itemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Work assignment Report.
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerIDValue | String |
Workers.WorkerID | |
| WorkerIDschemeCode | String | ||
| WorkerIDShortName | String | ||
| WorkerIDLongName | String | ||
| WorkerGivenName | String | ||
| WorkerMiddleName | String | ||
| WorkerFamilyName1 | String | ||
| WorkerFamilyName2 | String | ||
| WorkerFormattedName | String | ||
| RelationshipCode | String | ||
| RelationshipShortName | String | ||
| RelationshipLongName | String | ||
| PositionID | String | ||
| PositionTitle | String | ||
| ItemID | String |
Work assignment group history.
| Name | Type | References | Description |
| nameCodeValue | String | ||
| nameCodeshortName | String | ||
| nameCodelongName | String | ||
| GroupCodeValue | String | ||
| GroupCodeshortName | String | ||
| GroupCodelongName | String | ||
| itemID | String | ||
| AssociateOID | String |
Workers.AssociateOID |
Returns a list of demographics for each worker in the organization.
The Sync App uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM WorkerDemographics WHERE AssociateOID = 'G3349PZGBADQY8H7'The rest of the filter is executed client-side within the Sync App.
| Name | Type | References | Description |
| AssociateOID [KEY] | String |
Workers.AssociateOID | Associate OID of Worker Demographics |
| WorkerID | String |
Workers.WorkerID | WorkerID of Worker Demographicsof Worker Demographics |
| GivenName | String | GivenName of Worker Demographics | |
| FamilyName | String | FamilyName of Worker Demographics | |
| AddressCode | String | AddressCode of Worker Demographics | |
| AddressShortName | String | AddressShortName of Worker Demographics | |
| AddressLineOne | String | AddressLineOne of Worker Demographics | |
| CityName | String | CityName of Worker Demographics | |
| CountrySubdivisionLevelCode | String | CountrySubdivisionLevelCode of Worker Demographics | |
| CountrySubdivisionType | String | CountrySubdivisionType of Worker Demographics | |
| CountrySubdivisionShortName | String | CountrySubdivisionShortName of Worker Demographics | |
| AddressCountryCode | String | AddressCountryCode of Worker Demographics | |
| AddressPostalCode | String | AddressPostalCode of Worker Demographics | |
| CommunicationLandlines | String | CommunicationLandlines of Worker Demographics | |
| CommunicationMobiles | String | CommunicationMobiles of Worker Demographics | |
| CommunicationFaxes | String | CommunicationFaxes of Worker Demographics | |
| CommunicationPagers | String | CommunicationPagers of Worker Demographics | |
| CommunicationEmails | String | CommunicationEmails of Worker Demographics | |
| GenderCode | String | GenderCode of Worker Demographics | |
| GenderCodeShortName | String | GenderCodeShortName of Worker Demographics | |
| MaritalStatusCode | String | MaritalStatusCode of Worker Demographics | |
| MaritalStatusShortName | String | MaritalStatusShortName of Worker Demographics | |
| DisabledIndicatior | Boolean | DisabledIndicatior of Worker Demographics | |
| BirthName | String | BirthName of Worker Demographics | |
| OtherPersonalAddresses | String | OtherPersonalAddresses of Worker Demographics | |
| RaceCodeIdentificationMethodCode | String | RaceCodeIdentificationMethodCode of Worker Demographics | |
| RaceCodeIdentificationMethodShortName | String | RaceCodeIdentificationMethodShortName of Worker Demographics | |
| RaceCodeShortName | String | RaceCodeShortName of Worker Demographics | |
| RaceCode | String | RaceCode of Worker Demographics | |
| HireDate | Date | HireDate of Worker Demographics | |
| WorkerStatusCode | String | WorkerStatusCode of Worker Demographics | |
| BusinessCommunicationLandlines | String | BusinessCommunicationLandlines of Worker Demographics | |
| BusinessCommunicationMobiles | String | BusinessCommunicationMobiles of Worker Demographics | |
| BusinessCommunicationFaxes | String | BusinessCommunicationFaxes of Worker Demographics | |
| BusinessCommunicationEmails | String | BusinessCommunicationEmails of Worker Demographics | |
| BusinessCommunicationPagers | String | BusinessCommunicationPagers of Worker Demographics | |
| WorkAssignments | String | WorkAssignments of Worker Demographics |
Returns workers business communication emails.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationEmails WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| EmailUri | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers business communication faxes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers business communication landlines.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers business communication mobiles.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers business communication pagers.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationPagers WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers person birth name preferred salutations.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| SalutationCode | String | ||
| SalutationLongName | String | ||
| SalutationShortName | String | ||
| SequenceNumber | Integer | ||
| TypeCode | String | ||
| TypeCodeLongName | String | ||
| TypeCodeShortName | String | ||
| AsOfDate | Date |
Returns workers person birth name title affix codes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| AffixCode | String | ||
| AffixCodeLongName | String | ||
| AffixCodeShortName | String | ||
| SequenceNumber | Integer | ||
| AsOfDate | Date |
Returns workers person birth name title prefix codes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| PrefixCode | String | ||
| PrefixCodeLongName | String | ||
| PrefixCodeShortName | String | ||
| SequenceNumber | Integer | ||
| AsOfDate | Date |
Returns workers person government IDs.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonGovernmentIDs WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonGovernmentIDs WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonGovernmentIDs WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| CountryCode | String | ||
| ExpirationDate | Date | ||
| IdValue | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| StatusCode | String | ||
| StatusCodeEffectiveDate | Date | ||
| StatusCodeLongName | String | ||
| StatusCodeShortName | String | ||
| AsOfDate | Date |
Returns workers person legal name preferred salutations.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| SalutationCode | String | ||
| SalutationCodeLongName | String | ||
| SalutationCodeShortName | String | ||
| SequenceNumber | Integer | ||
| TypeCode | String | ||
| TypeCodeLongName | String | ||
| TypeCodeShortName | String | ||
| AsOfDate | Date |
Returns workers person legal name title affix codes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| AffixCode | String | ||
| AffixCodeLongName | String | ||
| AffixCodeShortName | String | ||
| SequenceNumber | Integer | ||
| AsOfDate | Date |
Returns workers person legal name title prefix codes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| AffixCode | String | ||
| AffixCodeLongName | String | ||
| AffixCodeShortName | String | ||
| SequenceNumber | Integer | ||
| AsOfDate | Date |
Returns workers person military classification codes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| CodeValue | String | ||
| LongName | String | ||
| ShortName | String | ||
| AsOfDate | Date |
Returns workers photo links.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotoLinks WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPhotoLinks WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPhotoLinks WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| CanonicalUri | String | ||
| EncType | String | ||
| Href | String | ||
| MediaType | String | ||
| Method | String | ||
| PayLoadArguments | String | ||
| Rel | String | ||
| Schema | String | ||
| TargetSchema | String | ||
| Title | String | ||
| AsOfDate | Date |
Returns workers photos.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotos WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPhotos WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPhotos WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ItemID | String | ||
| Links | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AsOfDate | Date |
Returns workers work assignment ReportsTo.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentReportsTo WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ItemID | String | ||
| PositionID | String | ||
| ReportsToAssociateOID | String | ||
| ReportsToWorkerID | String | ||
| WorkerIDSchemeCode | String | ||
| WorkerIDSchemeCodeShortName | String | ||
| ReportsToWorkerNameFormattedName | String | ||
| AsOfDate | Date |
Returns workers work assignments assigned organizational units.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| TypeCode | String | ||
| TypeCodeLongName | String | ||
| TypeCodeShortName | String | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| AddressAttentionOfName | String | ||
| AddressBlockName | String | ||
| AddressBuildingName | String | ||
| AddressBuildingNumber | String | ||
| AddressCareOfName | String | ||
| AddressCityName | String | ||
| AddressCountryCode | String | ||
| AddressCountrySubdivisionLevel1CodeValue | String | ||
| AddressCountrySubdivisionLevel1LongName | String | ||
| AddressCountrySubdivisionLevel1ShortName | String | ||
| AddressCountrySubdivisionLevel1SubdivisionType | String | ||
| AddressCountrySubdivisionLevel2CodeValue | String | ||
| AddressCountrySubdivisionLevel2LongName | String | ||
| AddressCountrySubdivisionLevel2ShortName | String | ||
| AddressCountrySubdivisionLevel2SubdivisionType | String | ||
| AddressDeliveryPoint | String | ||
| AddressDoor | String | ||
| AddressFloor | String | ||
| AddressGeoCoordinateLatitude | Integer | ||
| AddressGeoCoordinateLongitude | Integer | ||
| AddressLineFive | String | ||
| AddressLineFour | String | ||
| AddressLineOne | String | ||
| AddressLineThree | String | ||
| AddressLineTwo | String | ||
| AddressNameCode | String | ||
| AddressNameCodeLongName | String | ||
| AddressNameCodeShortName | String | ||
| AddressPlotID | String | ||
| AddressPostalCode | String | ||
| AddressPostOfficeBox | String | ||
| AddressScriptCodeValue | String | ||
| AddressScriptCodeLongName | String | ||
| AddressScriptCodeShortName | String | ||
| AddressStairCase | String | ||
| AddressStreetName | String | ||
| AddressStreetTypeCode | String | ||
| AddressStreetTypeCodeLongName | String | ||
| AddressStreetTypeCodeShortName | String | ||
| addressUnit | String | ||
| CommunicationEmails | String | ||
| CommunicationFaxes | String | ||
| CommunicationLandlines | String | ||
| CommunicationMobiles | String | ||
| CommunicationPagers | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations communication emails.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| EmailUri | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations communication faxes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations communication landlines.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations communication mobiles.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments assigned work locations communication pagers.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments home organizational units.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ItemID | String | ||
| NameCodeValue | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| TypeCodeValue | String | ||
| TypeCodeLongName | String | ||
| TypeCodeShortName | String | ||
| AsOfDate | Date |
Returns workers work assignments home work location communication emails.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| EmailUri | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments home work location communication faxes.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationFaxes WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments home work location communication landlines.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments home work location communication mobiles.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments home work location communication pagers.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| Access | String | ||
| AreaDialing | String | ||
| CountryDialing | String | ||
| DialNumber | String | ||
| Extension | String | ||
| FormattedNumber | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| NotificationIndicator | Boolean | ||
| AsOfDate | Date |
Returns workers work assignments industry classifications.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ClassificationCode | String | ||
| ClassificationCodeLongName | String | ||
| ClassificationCodeShortName | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AsOfDate | Date |
Returns workers work assignments links.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsLinks WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsLinks WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsLinks WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| CanonicalUri | String | ||
| EncType | String | ||
| Href | String | ||
| MediaType | String | ||
| Method | String | ||
| PayLoadArguments | String | ||
| Rel | String | ||
| Schema | String | ||
| TargetSchema | String | ||
| Title | String | ||
| AsOfDate | Date |
Returns workers work assignments occupational classifications.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| ClassificationCode | String | ||
| ClassificationCodeShortName | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeShortName | String | ||
| AsOfDate | Date |
Work assignments worker groups.
The Sync App uses the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AsOfDate = '2020-01-01'
| Name | Type | References | Description |
| AssociateOID | String |
Workers.AssociateOID | |
| WorkerID | String |
Workers.WorkerID | |
| GroupCode | String | ||
| GroupCodeLongName | String | ||
| GroupCodeShortName | String | ||
| ItemID | String | ||
| NameCode | String | ||
| NameCodeLongName | String | ||
| NameCodeShortName | String | ||
| AsOfDate | Date |
Work assignment worker type codes.
| Name | Type | References | Description |
| CodeValue | String | ||
| ShortName | String |
View the Work Schedules.
| Name | Type | References | Description |
| AssociateOID | String | ||
| ScheduleID | String | ||
| WorkerName | String | ||
| WorkerFamilyName1 | String | ||
| WorkerFormattedName | String | ||
| workAssignmentID | String | ||
| schedulePeriodStartDate | Date | ||
| schedulePeriodEndDate | Date | ||
| scheduleDays | String |
View the schedule days entries in Work Schedules.
| Name | Type | References | Description |
| AssociateOID | String | ||
| ScheduleID | String | ||
| WorkerFormattedName | String | ||
| workAssignmentID | String | ||
| ScheduleEntryID | String | ||
| DaySequenceNumber | String | ||
| ScheduleDayDate | Date | ||
| Actions | String | ||
| categoryTypeCode | String | ||
| ShiftTypeCode | String | ||
| EarningAllocations | String | ||
| EntryComments | String | ||
| PayCodeValue | String | ||
| PayCodeShortName | String | ||
| EntryStatusCode | String | ||
| StateDateTimePeriod | Datetime | ||
| EndDateTimePeriod | Datetime | ||
| StartDatePeriod | Date | ||
| EndDatePeriod | Date | ||
| TotalTimeValue | String | ||
| TotalTimeNameCode | String | ||
| TotalTimeNameCodeShortName | String | ||
| ScheduledHoursQuantity | String |
| プロパティ | 説明 |
| UseUAT | Whether the connection should be made to an ADP UAT account. |
| MaskSensitiveData | To mask the sensitive data in the resultset. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| プロパティ | 説明 |
| SSLClientCert | The certificate provided by ADP during the registration process. |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PageSize | The maximum number of results to return per page from ADP. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| UseUAT | Whether the connection should be made to an ADP UAT account. |
| MaskSensitiveData | To mask the sensitive data in the resultset. |
Whether the connection should be made to an ADP UAT account.
To connect to a ADP UAT account, set UseUAT = true.
To mask the sensitive data in the resultset.
To mask the sensitive data in the resultset.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLClientCert | The certificate provided by ADP during the registration process. |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
The certificate provided by ADP during the registration process.
The certificate provided by ADP during the registration process. The Sync App requires a PFX or PFXBLOB type.
The type of key store containing the TLS/SSL client certificate.
This property can take one of the following values:
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。
証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がADP への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がADP への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がADP にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"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 接続プロパティは設定しないでください。 |
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 を参照してください。
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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\ADP 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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PageSize | The maximum number of results to return per page from ADP. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
The maximum number of rows to scan for the custom fields columns available in the table.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly.
A boolean indicating if you would like to include custom fields in the column listing.
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
Specifies the number of concurrent requests.
このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。
Set this to the maxinum number of concurrent threads that can be opened.
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
The maximum number of results to return per page from ADP.
The PageSize property affects the maximum number of results to return per page from ADP when executing a query. A higher value will return more results per page, but may also cause a timeout exception. The maximum pagesize is 100.
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API.
Set this to true may affect the performance of above views.
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Workers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。