This topic describes the updates to HR Import 2.0 to support Enhanced Employee Gender functionality.
Before You Begin: HR Import 1.0 isn’t supported because it being retired for Dayforce Release 2025.1.0.
- For information about updating HR Import 2.0 to use Enhanced Employee Gender, see Migrate HR Import 2.0.
- For information about backward compatibility for HR Import 2.0, see HR Import 2.0 and Backward Compatibility.
HR Import 2.0 before Dayforce Release 2025.1.0
Before Dayforce Release 2025.1.0, the following Employee tokens were the only supported way to import gender and gender identity information for employees:
Token | Required Field | Purpose |
---|---|---|
Gender | No | Gender information for an employee |
GenderIdentityXrefCode | No | Gender identity information for an employee |
HR Import 2.0 Starting with Dayforce Release 2025.1.0
Now, with Dayforce Release 2025.1.0, the EmployeeAssignedSexandGenderIdentity entity was added and the following tokens are now supported for importing gender information:
Token | Required Field | Purpose |
---|---|---|
CountryCode |
Yes, if a record is being imported. No, if a record isn’t being imported. |
Country information for the employee’s gender record. |
StateCode | Country dependent | State or province information for US or Canadian employees. |
GenderIdentityXrefCode | Configuration dependent | Dayforce reference code for the employee’s assigned sex value. |
EffectiveStart | Configuration dependent | Effective start date for a record if effective dating is enabled. |
EffectiveEnd | Configuration dependent | Effective end date for the record if effective dating is enabled. |
isFederal | Country dependent |
A flag to indicate whether a value is a federal country record. Used only for employees adding US or Canada records. |
HR Import 2.0 Tokens and Validations
CountryCode
The CountryCode token is mandatory when gender records are imported. This token accepts and uses the three-character country codes defined in Dayforce. For example:
- CAN (Canada)
- USA (United States)
- DEU (Germany)
- GBR ( United Kingdom)
It’s recommended that all employees have a gender record that matches the country for the pay group they belong to. For example, if an employee’s pay group country is Germany, then they should have a gender record for Germany.
StateCode
The StateCode token is used only when you’re importing a CountryCode for the United States or Canada because state and province options are available for only these two countries. StateCode accepts and uses the two-character state codes defined in Dayforce. For example:
- AL (Alabama)
- CO (Colorado)
- HI (Hawaii)
- MD (Maryland)
It’s recommended that all employees have a gender record that matches the state they live or work in. For example, if an employee lives or works in California, then they should have a gender record for California.
AssignedSexXrefCode
The AssignedSexXrefCode token is used to provide the employee’s assigned sex (previously gender) value. This token shouldn't be confused with the overall gender record.
By default, the following options are available to this token:
- Mandatory: Yes
- Values: M (Male), F (Female)
However, if updates are made to the Gender administration screen in HR Admin > Employee Gender Admin, other options will be available to a particular country, state, or province as per system configuration.
- Importable: Yes or No (configuration dependent on Collect Assigned Sex Information option)
- Mandatory: Yes or No (configuration dependent on Make Assigned Sex Mandatory option)
- Values: M (male), F (female), and configuration-dependent custom values
GenderIdentityXrefCode
The GenderIdentityXrefCode token is used to provide the employee’s gender identity value. This token shouldn’t be confused with the overall gender record, or the assigned sex value.
By default, the following options are available for this token:
- Mandatory: No
- Values: MALE (Male), FEMALE (Female)
- This token isn’t applicable when importing federal records.
However, if updates are made to the Gender administration screen (in HR Admin > Employee Gender Admin), other options will be available to a particular country, state, or province as per system configuration:
- Importable: Yes or No (configuration dependent on the Enable Gender Identity option)
- Values: MALE (male), FEMALE (female), and configuration-dependent custom values
EffectiveStart/EffectiveEnd
The EffectiveStart and EffectiveEnd tokens are usable only when the Display Enhanced Gender Last Modification Information and Effective Dating client property is enabled. See Enabling the Display Enhanced Gender Last Modification and Effective Dating Client Property.
If the Display Enhanced Gender Last Modification Information and Effective Dating client property isn’t enabled and a customer provides data for these fields, they’ll be ignored. Default behavior is that Effective Start is today’s date (the date of the import) and Effective End is NULL.
If the Display Enhanced Gender Last Modification Information and Effective Dating client property is enabled, the following behavior is observed:
- If no gender records exist for an employee in any country, state or province: The record is imported with the effective dates provided.
- If one or more gender record exists for an employee, but the new record is for another country, state, or province: The record is imported with the effective dates provided.
- If one or more gender record exists for an employee, and the new record has a matching country, state, or province combination: The record is updated with the effective dates provided, and set an effective end (if applicable) on any other records.
- Effective dating on federal records: Federal records aren’t subject to effective dating information. Effective dates are ignored, with only the assigned sex value adjusted, if provided.
isFederal
The isFederal token is applicable only to employees providing gender records for the United States or Canada. This token is used to provide information on whether an imported gender record should be used as a federal record.
Federal Event and HR Import
This information is applicable only for employees providing gender records for the United States or Canada.
For the HR Import, customers will have different options when importing records for employees providing information for the United States or Canada. These options are broken down into whether an employee already has a federal country record for the United States or Canada, and whether they’re being provided one or more records:
Employee already has a federal record
If an employee already has a federal record, created via the federal event, for the United States and the employee is providing state values, then no action will be taken.
Singular Record Imports
You’re importing a single gender record for an employee:
Import Scenario | Result | Action |
---|---|---|
An employee is being provided with a binary (Male/Female) state or province assigned sex record. |
Imported |
No action needed. Federal record is created automatically. |
An employee is being provided with a NULL (blank) state or province assigned sex record. |
Validation error |
A binary (male/female) federal record needs to be imported alongside this NULL (blank) state or province assigned sex record. |
An employee is being provided a custom (NOT Male/Female) state or province assigned sex record. | Validation error | A binary (male/female) federal record needs to be imported alongside this custom (NOT male/female) state or province assigned sex record. |
Note: Providing custom non-binary assigned sex options for a particular country, US state, or Canadian province is only possible if you are making configuration changes in HR Admin > Employee Gender Admin > Gender.
Multiple Record Imports
Import Scenario | Result | Action |
---|---|---|
An employee is being provided two or more binary (male/female) state or province records, all of which are consistently binary (all male or all female). |
Imported |
No action needed. Federal record is created automatically. |
An employee is being provided two or more binary (male/female) state or province records, but they aren’t consistently binary (all male or all female). |
Validation error |
A binary (male/female) federal record needs to be imported alongside these state or province assigned sex records. |
An employee is being provided two or more state or province records, but at least one record is NULL (blank). | Validation error | A binary (male/female) federal record needs to be imported alongside these state or province assigned sex records. |
An employee is being provided two or more non-binary (male/female) state or province records. |
Validation error | A binary (male/female) federal record needs to be imported alongside these state or province assigned sex records. |
Importing the Federal Record
For the validation errors in the previous section, the federal record should be provided in the following format:
Token | Value |
---|---|
CountryCode | USA or CAN |
StateCode | NULL (blank) |
AssignedSexXrefCode | M or F |
GenderIdentityXrefCode |
N/A (don’t provide) |
isFederal | 1 (true) |
EffectiveStart |
Can be provided, but might be updated by the internal Gender API based on other existing records. |
EffectiveEnd | Can’t be provided. Will be omitted when the import runs. |