JDBC Driver for ADP

Build 22.0.8462

Workers

Returns workers details.

Table Specific Information

Select

The driver will use 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 driver.

  • AssociateOID supports the '=' comparison.
  • WorkerID supports the '=' comparison.
  • AsOfDate supports the '=' comparison.

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'

Insert

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')

Update

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'

Columns

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

WorkerIDSchemeCode String True

WorkerIDSchemeLongName String True

WorkerIDSchemeShortName String 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

PersonBirthDate Date False

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

The allowed values are 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

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

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

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462