Workers

The table that returns detailed information for all workers in the organization. This table includes core employee Ids, employment status, and work assignment references. This table serves as the foundation for Human Resources (HR), payroll, and reporting integration.

Table Specific Information

Select

The connector 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 connector.

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		The unique identifier (Id) that represents the associate in the HR system. This field is used to link worker records to other HR data entities and transactions.
WorkerID	String	True		The Id that represents the worker within the HR system. This field is used to uniquely identify an individual across payroll, benefits, and compliance processes.
WorkAssignments	String	False		The collection of work assignment records that are associated with the worker. This field includes position history, job details, and related employment data.
WorkerAcquisitionDate	Date	True		The date when the worker was first acquired or onboarded by the organization. This field is used for workforce analytics and service tracking.
WorkerAdjustedServiceDate	Date	True		The date that reflects the worker's adjusted service calculation, including breaks in service or rehire adjustments. This field supports benefits eligibility and seniority tracking.
WorkerExpectedTerminationDate	Date	True		The anticipated date of the worker's termination, if applicable. This field supports workforce planning and HR forecasting.
WorkerOriginalHireDate	Date	False		The original date when the worker was first hired by the organization. This field is used for service recognition, benefits, and compliance reporting.
WorkerRehireDate	Date	True		The date when the worker was rehired after a separation from employment. This field is used to track re-employment history and eligibility for benefits.
WorkerRetirementDate	Date	True		The date when the worker officially retired from active employment. This field supports retirement processing and benefits administration.
WorkerTerminationDate	Date	True		The date when the worker's employment was officially terminated. This field supports offboarding, compliance reporting, and payroll closure.
WorkerStatusEffectiveDate	Date	True		The date when the worker's current employment status became effective. This field is used for timeline tracking and HR record accuracy.
WorkerStatusReasonCode	String	True		The code that identifies the reason for the worker's current employment status (for example, Leave of Absence, Active, or Terminated). This field supports compliance and workforce analytics.
WorkerStatusReasonLongName	String	True		The full descriptive name of the worker status reason code. This field provides the complete label that appears in HR documentation and reporting.
WorkerStatusReasonShortName	String	True		The abbreviated name that corresponds to the worker status reason code. This field provides a concise label for dashboards and HR reports.
WorkerStatusStatusCode	String	True		The code that identifies the worker's current status (for example, Active, On Leave, or Terminated). This field supports workforce management and payroll processing.
WorkerStatusStatusLongName	String	True		The full descriptive name of the worker status code. This field provides the complete label used in HR documentation and compliance reporting.
WorkerStatusStatusShortName	String	True		The abbreviated name that corresponds to the worker status code. This field provides a short label for HR dashboards and analytics.
Photos	String	True		The collection of photo records that are associated with the worker. This field stores or references identification photos for HR and security purposes.
BusinessCommunicationEmails	String	False		The business email addresses that are assigned to the worker. This field supports internal communication, authentication, and directory listings.
BusinessCommunicationFaxes	String	False		The business fax numbers that are associated with the worker. This field supports official communication and document transmission tracking.
BusinessCommunicationLandlines	String	False		The business landline-telephone numbers that are assigned to the worker. This field supports office contact and telecommunication management.
BusinessCommunicationMobiles	String	False		The business mobile-telephone numbers that are associated with the worker. This field supports contact availability, messaging, and on-call management.
BusinessCommunicationPagers	String	False		The business pager numbers that are associated with the worker. This field supports legacy communication channels where paging devices are still in use.
PersonAlternatePreferredNames	String	True		The alternate preferred names that are associated with the worker's record. This field supports cultural, linguistic, or personal name preferences used across HR systems.
PersonCommunicationEmails	String	False		The personal email addresses that are associated with the worker. This field supports non-business correspondence and optional contact verification.
PersonCommunicationFaxes	String	False		The personal fax numbers that are associated with the worker. This field supports communication through non-business fax channels where applicable.
PersonCommunicationLandlines	String	False		The personal landline-telephone numbers that are associated with the worker. This field supports alternate contact options and address verification.
PersonCommunicationMobiles	String	False		The personal mobile numbers that are associated with the worker. This field supports direct communication for HR outreach and notifications.
PersonCommunicationPagers	String	False		The personal pager numbers that are associated with the worker. This field supports alternate or legacy communication methods maintained in the worker record.
PersonDeathDate	Date	True		The date of the worker's death, if applicable. This field is used for record finalization, benefits closure, and compliance reporting in the HR system.
PersonDeceasedIndicator	Boolean	True		The indicator that specifies whether the worker is deceased. This field is used to manage survivor benefits, payroll termination, and record archival.
PersonDisabilityIdentificationDeclinedIndicator	Boolean	True		The indicator that specifies whether the worker has declined to identify their disability status. This field supports compliance with Equal Employment Opportunity (EEO) and HR data privacy standards.
PersonDisabilityPercentage	Integer	True		The percentage value that represents the worker's level of disability as defined by medical or legal documentation. This field supports compliance tracking and reasonable accommodation processes.
PersonDisabilityTypeCodes	String	False		The codes that identify the worker's disability type classifications (for example, visual impairment, hearing impairment, or mobility limitation). This field supports compliance reporting and accommodation tracking.
PersonDisabledIndicator	Boolean	False		The indicator that specifies whether the worker has self-identified as a person with a disability. This field supports workforce diversity analytics and HR compliance programs.
PersonGenderCode	String	False		The code that identifies the worker's gender (for example, Female, Male, or Nonbinary). This field supports demographic reporting and diversity compliance. The allowed values are M, F, N.
PersonGenderLongName	String	True		The full descriptive name that corresponds to the worker's gender code. This field provides the complete label that appears in HR documentation and workforce analytics.
PersonGenderShortName	String	True		The abbreviated name that corresponds to the worker's gender code. This field provides a concise label for reports and dashboards.
PersonGovernmentIDs	String	False		The collection of government-issued identifiers (for example, Social Security Number, National ID, or Taxpayer ID). This field supports legal and payroll compliance processes.
PersonHighestEducationLevelCode	String	False	HighestEducationLevelCode.CodeValue	The code that identifies the highest level of education completed by the worker (for example, High School, Bachelor's, or Master's). This field supports HR analytics and qualification verification.
PersonHighestEducationLevelLongName	String	True		The full descriptive name of the highest education level code. This field provides the complete label that appears in HR records and reporting systems.
PersonHighestEducationLevelShortName	String	True		The abbreviated name that corresponds to the highest education-level code. This field provides a short label for dashboards and analytics.
PersonIdentityDocuments	String	True		The identity documents that are associated with the worker (for example, driver's license, national ID card, or passport). This field supports verification and regulatory compliance.
PersonImmigrationDocuments	String	True		The immigration-related documents that are associated with the worker (for example, visa, residency card, or work permit). This field supports employment eligibility and legal compliance.
PersonLegalAddressCityName	String	False		The name of the city where the worker's legal address is located. This field supports address validation and HR correspondence.
PersonLegalAddressCountryCode	String	False		The two-letter ISO code that represents the country for the worker's legal address. This field supports localization and international reporting.
PersonLegalAddressCountrySubdivisionLevel1Code	String	False		The code that identifies the first-level administrative subdivision of the country (for example, state, province, or region). This field supports tax and compliance reporting.
PersonLegalAddressCountrySubdivisionLevel1LongName	String	False		The full descriptive name of the first-level administrative subdivision code. This field provides the complete label that appears in HR and payroll documentation.
PersonLegalAddressCountrySubdivisionLevel1ShortName	String	False		The abbreviated name that corresponds to the first-level subdivision code. This field provides a concise label for reports and analytics.
PersonLegalAddressCountrySubdivisionLevel1SubdivisionType	String	False		The type of the first-level administrative subdivision (for example, State, Province, or Region). This field defines the jurisdictional structure used in HR records.
PersonLegalAddressCountrySubdivisionLevel2Code	String	False		The code that identifies the second-level administrative subdivision of the country (for example, county, district, or municipality). This field supports payroll and tax region mapping.
PersonLegalAddressCountrySubdivisionLevel2LongName	String	False		The full descriptive name of the second-level administrative subdivision code. This field provides the complete label that appears in HR records and correspondence.
PersonLegalAddressCountrySubdivisionLevel2ShortName	String	False		The abbreviated name that corresponds to the second-level subdivision code. This field provides a short label for reports and summaries.
PersonLegalAddressCountrySubdivisionLevel2SubdivisionType	String	False		The type of the second-level administrative subdivision (for example, County, District, or Municipality). This field defines the local administrative structure for HR data alignment.
PersonLegalAddressDeliveryPoint	String	False		The delivery point that identifies the physical location for mail delivery. This field supports postal validation and HR correspondence accuracy.
PersonLegalAddressLineOne	String	False		The first address line of the worker's legal address. This field typically includes the building number and street name for postal and HR correspondence.
PersonLegalAddressLineTwo	String	False		The second address line of the worker's legal address. This field is used for additional location details such as apartment number, suite, or unit.
PersonLegalAddressLineThree	String	False		The third address line of the worker's legal address. This field is used for extended address information such as complex, floor, or secondary routing details.
PersonLegalAddressNameCodeValue	String	False		The code that identifies the name element associated with the worker's legal address (for example, home, mailing, or registered). This field defines address categorization within HR systems.
PersonLegalAddressNameCodeLongName	String	True		The full descriptive name of the code that identifies the worker's legal address type (for example, Home, Mailing, or Registered). This field provides the complete label that appears in HR documentation and correspondence.
PersonLegalAddressNameCodeShortName	String	False		The abbreviated name that corresponds to the legal address name code. This field provides a concise label for HR dashboards and address management reports.
PersonLegalAddressPostalCode	String	False		The postal code that identifies the worker's legal address for mail delivery. This field supports postal validation, compliance reporting, and HR correspondence.
PersonLegalAddressSameAsAddressIndicator	Boolean	False		The indicator that specifies whether the worker's legal address is the same as their primary residential address. This field helps prevent duplication in HR systems.
PersonLegalAddressSameAsAddressLinkCanonicalUri	String	False		The canonical uniform resource identifier (URI) that defines the reference link to the related address record. This field is used for record linkage and system integration within HR data models.
PersonLegalAddressSameAsAddressLinkEncType	String	False		The encoding type that is used for the linked address reference. This field supports secure data transmission between HR systems.
PersonLegalAddressSameAsAddressLinkHref	String	False		The hyperlink reference (href) that identifies the related address record. This field supports navigation between address entities in HR systems.
PersonLegalAddressSameAsAddressLinkMediaType	String	False		The media type that defines the format of the linked address resource (for example, application/json or application/xml). This field ensures compatibility across HR system integrations.
PersonLegalAddressSameAsAddressLinkMethod	String	False		The HTTP method that is used to access the linked address resource (for example, GET, POST, or PUT). This field defines how the HR system interacts with the linked data.
PersonLegalAddressSameAsAddressLinkPayLoadArguments	String	False		The payload arguments that are used in the linked address request. This field supports data validation and transfer within HR integrations.
PersonLegalAddressSameAsAddressLinkRel	String	False		The relationship type (rel) that defines the connection between the legal address record and its related address. This field helps describe contextual data relationships.
PersonLegalAddressSameAsAddressLinkSchema	String	False		The schema that defines the data structure for the linked address record. This field ensures consistency in HR data exchange formats.
PersonLegalAddressSameAsAddressLinkTargetSchema	String	False		The schema that defines the data model for the target address record. This field is used to align data across HR integrations and APIs.
PersonLegalAddressSameAsAddressLinkTitle	String	False		The title that describes the purpose or name of the linked address record. This field provides user-friendly context within HR systems and documentation.
PersonLegalNameFamilyName1	String	False		The first family (last) name that is associated with the worker's legal name. This field represents the primary surname in HR and legal documentation.
PersonLegalNameFamilyName1Prefix	String	False		The prefix that appears before the first family name (for example, De, Van, or O'). This field supports accurate name formatting in multilingual and multicultural contexts.
PersonLegalNameFamilyName2	String	False		The second family (last) name that is associated with the worker's legal name, if applicable. This field supports jurisdictions where dual surnames are used.
PersonLegalNameFamilyName2Prefix	String	False		The prefix that appears before the second family name (for example, La, D', or Von). This field supports full representation of the worker's legal name in HR systems.
PersonLegalNameFormattedName	String	False		The fully formatted version of the worker's legal name. This field combines all name components in the correct cultural or jurisdictional order for HR correspondence and identification.
PersonLegalNameGenerationAffixCode	String	False	GenerationAffixCode.CodeValue	The code that identifies the generation affix associated with the worker's legal name (for example, Jr., Sr., or III). This field supports consistent name usage across HR and payroll systems.
PersonLegalNameGenerationAffixLongName	String	True		The full descriptive name of the generation affix code for the worker's legal name. This field provides the complete label that appears in HR and legal records.
PersonLegalNameGenerationAffixShortName	String	True		The abbreviated name that corresponds to the generation affix code for the worker's legal name. This field provides a concise label for reports and employee directories.
PersonLegalNameGivenName	String	False		The given (first) name that is part of the worker's legal name. This field is used for formal identification and HR documentation.
PersonLegalNameInitials	String	False		The initials that represent the worker's legal name. This field supports document signatures, employee badges, and internal identifiers.
PersonLegalNameMiddleName	String	False		The middle name that is part of the worker's legal name. This field supports complete identification and distinguishes between workers with similar names.
PersonLegalNameCode	String	False		The code that identifies the worker's legal name record. This field is used to maintain and track multiple legal name variations within HR systems.
PersonLegalNameLongName	String	True		The full descriptive name of the legal name record. This field provides the complete label that appears in HR documentation and reporting.
PersonLegalNameShortName	String	False		The abbreviated name that corresponds to the legal name record. This field provides a short label for dashboards and HR analytics.
PersonLegalNameNickName	String	False		The nickname or informal name that is associated with the worker's legal name. This field supports communication preferences and HR personalization.
PersonLegalNamePreferredSalutations	String	False		The preferred salutations that are associated with the worker's legal name (for example, Mr., Ms., or Dr.). This field defines how the worker is formally addressed in HR correspondence.
PersonLegalNameQualificationAffixCode	String	False	QualificationAffixCode.CodeValue	The code that identifies the qualification affix associated with the worker's legal name (for example, CPA, MD, or PhD). This field supports credential display and professional recognition.
PersonLegalNameQualificationAffixLongName	String	False		The full descriptive name of the qualification affix code for the worker's legal name. This field provides the complete label that appears in HR and credential verification reports.
PersonLegalNameQualificationAffixShortName	String	False		The abbreviated name that corresponds to the qualification affix code for the worker's legal name. This field provides a concise label for dashboards and HR reporting tools.
PersonLinks	String	True		The set of hyperlinks that connect the worker's personal record to other HR data entities. This field supports record linkage, navigation, and cross-module reporting.
PersonMaritalStatusCode	String	False	MaritalStatusCode.CodeValue	The code that identifies the worker's marital status (for example, Single, Married, or Divorced). This field supports benefits eligibility and demographic reporting.
PersonMaritalStatusEffectiveDateTime	Datetime	False		The date and time when the worker's current marital status became effective. This field supports accurate benefits administration and compliance reporting in HR systems.
PersonMaritalStatusLongName	String	True		The full descriptive name of the code for the worker's marital status. This field provides the complete label that appears in HR documentation and benefits eligibility reports.
PersonMaritalStatusShortName	String	False	MaritalStatusCode.ShortName	The abbreviated name that corresponds to the code for the worker's marital status. This field provides a concise label for HR dashboards and workforce analytics.
PersonMilitaryClassificationCodes	String	False		The codes that identify the worker's military classifications. Supported values include Disabled Veteran, Active Duty Wartime or Campaign Badge Veteran, Armed Forces Service Medal Veteran, and Recently Separated Veteran. This field supports compliance reporting and government reporting obligations.
PersonMilitaryDischargeDate	Date	False		The date when the worker was formally discharged from military service. This field supports verification of veteran status, benefits processing, and compliance with employment regulations.
PersonMilitaryStatusCode	String	False		The code that identifies the worker's military status (for example, Active Duty, Reserve, or Veteran). This field supports HR reporting and regulatory tracking.
PersonMilitaryStatusEffectiveDate	Datetime	True		The date and time when the worker's military status became effective. This field supports accurate recordkeeping for compliance and veteran classification.
PersonMilitaryStatusLongName	String	True		The full descriptive name of the code for the worker's military status. This field provides the complete label that appears in HR documentation and veteran-related reports.
PersonMilitaryStatusShortName	String	False		The abbreviated name that corresponds to the code for the worker's military status. This field provides a concise label for HR dashboards and workforce analytics.
PersonOtherPersonalAddresses	String	False		The additional personal addresses that are associated with the worker. This field supports correspondence, alternate contact management, and legal documentation.
PersonPassports	String	False		The passport details that are associated with the worker. This field supports identity verification, immigration compliance, and international employment tracking.
PersonPreferredNameFamilyName1	String	True		The first family (last) name that is part of the worker's preferred name. This field supports personalization and communication preferences in HR records.
PersonPreferredNameFamilyName1Prefix	String	True		The prefix that appears before the first family name (for example, De, Van, or O'). This field supports accurate cultural and linguistic representation in HR systems.
PersonPreferredNameFamilyName2	String	True		The second family (last) name that is part of the worker's preferred name, if applicable. This field supports naming conventions where dual surnames are used.
PersonPreferredNameFamilyName2Prefix	String	True		The prefix that appears before the second family name (for example, La, D', or Von). This field ensures accurate display of multi-part family names in HR records.
PersonPreferredNameFormattedName	String	True		The fully formatted version of the worker's preferred name. This field displays how the name should appear in communication systems, identification badges, and HR directories.
PersonPreferredNameGenerationAffixCode	String	True		The code that identifies the generation affix associated with the worker's preferred name (for example, Jr., Sr., or III). This field supports standardized name formatting in HR and payroll systems.
PersonPreferredNameGenerationAffixLongName	String	True		The full descriptive name of the generation affix code for the worker's preferred name. This field provides the complete label that appears in HR documentation and communication systems.
PersonPreferredNameGenerationAffixShortName	String	True		The abbreviated name that corresponds to the generation affix code for the worker's preferred name. This field provides a concise label for reports and employee directories.
PersonPreferredNameGivenName	String	True		The given (first) name that is part of the worker's preferred name. This field supports personalization and communication preferences in HR systems.
PersonPreferredNameInitials	String	True		The initials that represent the worker's preferred name. This field supports use in employee badges, reports, and communication identifiers.
PersonPreferredNameMiddleName	String	True		The middle name that is part of the worker's preferred name. This field supports complete identification and personalization in HR records.
PersonPreferredNameCode	String	True		The code that identifies the preferred name record associated with the worker. This field supports management of preferred name variations and change tracking.
PersonPreferredNameLongName	String	True		The full descriptive name of the preferred name record. This field provides the complete label that appears in HR documentation and employee directories.
PersonPreferredNameShortName	String	True		The abbreviated name that corresponds to the preferred name record. This field provides a concise label for dashboards and HR reports.
PersonPreferredNameNickName	String	True		The nickname or informal name that is associated with the worker's preferred name. This field supports internal communication preferences and workforce personalization.
PersonPreferredNamePreferredSalutations	String	True		The preferred salutations that are associated with the worker's preferred name (for example, Mr., Ms., or Dr.). This field defines how the worker is addressed in preferred or informal contexts.
PersonPreferredNameQualificationAffixCode	String	True		The code that identifies the qualification affix associated with the worker's preferred name (for example, CPA, MBA, or PhD). This field supports credential display and professional recognition.
PersonPreferredNameQualificationAffixLongName	String	True		The full descriptive name of the code for the qualification affix of the worker's preferred name. This field provides the complete label that appears in HR and credential verification systems.
PersonPreferredNameQualificationAffixShortName	String	True		The abbreviated name that corresponds to code of the qualification affix of the worker's preferred name. This field provides a concise label for dashboards and workforce analytics.
PersonPreferredNameScriptCode	String	True		The code that identifies the script that is used to display the worker's preferred name (for example, Latin, Cyrillic, or Kanji). This field supports multilingual HR systems and international employee records.
PersonPreferredNameScriptLongName	String	True		The full descriptive name of the script code that is used to display the worker's preferred name. This field provides the complete label that appears in HR documentation and international employee records.
PersonPreferredNameScriptShortName	String	True		The abbreviated name that corresponds to the script code for the worker's preferred name. This field provides a concise label for dashboards, multilingual directories, and HR reports.
PersonPreferredNameTitleAffixCodes	String	True		The title affix codes that are associated with the worker's preferred name (for example, Dr., Prof., or Hon.). This field supports accurate name formatting for professional and formal communication.
PersonPreferredNameTitlePrefixCodes	String	True		The title prefix codes that are associated with the worker's preferred name (for example, Mr., Ms., or Rev.). This field defines how the worker's preferred name is presented in correspondence and records.
PersonReligionCode	String	True		The code that identifies the worker's religion or belief system as voluntarily disclosed. This field supports diversity, inclusion, and compliance initiatives in HR systems.
PersonReligionLongName	String	True		The full descriptive name of the religion code. This field provides the complete label that appears in HR documentation, inclusion analytics, and workforce diversity reports.
PersonReligionShortName	String	True		The abbreviated name that corresponds to the religion code. This field provides a concise label for dashboards, reports, and HR analytics.
PersonResidencyCountryCodes	String	True		The list of country codes that identify the countries where the worker holds legal residency. This field supports immigration tracking, payroll compliance, and tax jurisdiction reporting.
PersonSexualOrientationCode	String	True		The code that identifies the worker's sexual orientation as voluntarily disclosed. This field supports inclusion, diversity analytics, and HR compliance reporting.
PersonSexualOrientationLongName	String	True		The full descriptive name of the sexual orientation code. This field provides the complete label that appears in HR documentation and diversity reports.
PersonSexualOrientationShortName	String	True		The abbreviated name that corresponds to the sexual orientation code. This field provides a concise label for dashboards, workforce analytics, and compliance summaries.
PersonSocialInsurancePrograms	String	True		The list of social insurance programs that are associated with the worker (for example, Social Security, Unemployment Insurance, or Pension Plan). This field supports benefits administration and government compliance reporting.
PersonStudentIndicator	Boolean	True		The indicator that specifies whether the worker is currently a student. This field supports benefits eligibility, tax status verification, and workforce analytics.
PersonStudentStatusCode	String	True		The code that identifies the worker's student status (for example, Full-Time, Part-Time, or Graduate). This field supports payroll taxation and compliance reporting.
PersonStudentStatusEffectiveDate	Date	True		The date when the worker's student status became effective. This field supports accurate recordkeeping for benefits and educational assistance programs.
PersonStudentStatusLongName	String	True		The full descriptive name of the worker's student-status code. This field provides the complete label that appears in HR documentation and workforce analytics.
PersonStudentStatusShortName	String	True		The abbreviated name that corresponds to the worker's student-status code. This field provides a concise label for dashboards, reports, and HR analytics.
PersonTobaccoUserIndicator	Boolean	True		The indicator that specifies whether the worker has self-identified as a tobacco user. This field supports health benefits eligibility and wellness program administration.
PersonWorkAuthorizationDocuments	String	True		The set of work authorization documents that are associated with the worker (for example, Employment Authorization Card, Visa, or Residency Permit). This field supports eligibility verification and compliance with labor regulations.
Links	String	True		The collection of hyperlinks that connect this worker record to related HR data entities. This field supports record linkage, navigation, and integration across HR modules.
AsOfDate	Date	True		The effective date that defines when the worker's record information is valid. This field supports point-in-time reporting and compliance audits.

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	The code that identifies the payroll group to which the worker belongs. This field is used during record insertion to assign payroll configuration settings.
OnboardingTemplateCode	String	The code that identifies the onboarding template that is assigned to the worker. This field is used during record insertion to initiate the correct onboarding workflow.
OnboardingTemplateCodeName	String	The name of the onboarding template that is assigned to the worker. This field provides descriptive context during onboarding record creation.
OnboardingStatusCode	String	The code that identifies the worker's onboarding status (for example, Pending, Completed, or Canceled). This field is used during record insertion to reflect onboarding progress.
OnboardingStatusCodeName	String	The name of the onboarding-status code that is assigned to the worker. This field provides a descriptive label for hire status tracking during record insertion.
HireReasonCode	String	The code that identifies the reason for hiring the worker (for example, New Hire, Rehire, or Internal Transfer). This field is used during record insertion to document HR process activity.
HireReasonCodeName	String	The name of the hire-reason code that is assigned to the worker. This field provides a descriptive label for the corresponding hire action during record insertion.