Load a Card Component for US Involuntary Deductions

This topic provides general guidance on how to create a Card Component for an Involuntary Deduction.

All Involuntary Deductions are created as individual card components on the same Involuntary Deduction card. An employee will only have one Involuntary Deduction card.

This topic provides general guidance on how to create a Card Component for an Involuntary Deduction. Also review the topic for the specific type of involuntary deduction you are loading.

The general card component hierarchy for an Involuntary:

Deduction: The general card component hierarchy for an Involuntary Deduction:

The card component name is defined by the element configuration, as are the value definitions which are supplied using the Calculation Value Definition and Enterable Calculation Value record types.

The flexfield contexts to load depend on the involuntary deduction type and the element configuration.

Card Component Attributes

The Card Component uses these attributes:

HCM Data Loader Attribute	Alternative User Key Attributes	Functional Description
SourceSystemOwner	N/A	The name of the source system owner used to generate the source system ID.
SourceSystemId	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName	A unique identifier for the involuntary deductioncard component. For new card components supply the source key attributes. You can also identify card components with the user key attributes.
LegislativeDataGroupName	N/A	The name of the legislative data group for the card component definition.
DirCardId(SourceSystemId)	CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName	The parent Involuntary Deductions calculation card should be identified by using the same key type used to identify the calculation card. When using source keys, supply this attribute with the value supplied for the calculation card’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent calculation card
EffectiveStartDate	N/A	The start date of the card component, typically the employee’s start date. This must be the same as the EffectiveStartDate on the Involuntary Deduction calculation card. If updating an existing involuntary deductioncard component, the effective start date must be the original start date of the component.
EffectiveEndDate	N/A	The end date is optional for the card component
DirCardCompDefName	N/A	The component definition name. Specify the name of the element as generated by the element template.
ComponentSequence	N/A	The number to uniquely identify this card component when multiple card components with the same DirCardCompDefName exist. Not required when source keys are used.
Context1	N/A	The value to supply varies depending on the involuntary deduction type. Refer to the example topic of the relevant involuntary deduction type you’re loading.
Context2	N/A	The value to supply varies depending on the involuntary deduction type. Refer to the example topic of the relevant involuntary deduction type you’re loading.
Subpriority	N/A	An optional value to override the default priority generated.

Component Detail Attributes

The component detail record type enables you to upload data into flexfield segments.

In addition to the attributes defined here, include the necessary flexfield segment attribute values for the flexfield context specific to the Involuntary Deduction type.

Core attributes for Component Details:

HCM Data Loader Attribute	Alternative User Key Attributes	Functional Description
SourceSystemOwner	N/A	The name of the source system owner used to generate the source system ID.
SourceSystemId	CardSequence, ComponentSequence, DirInformationCategory, LegislativeDataGroupName, AssignmentNumber, DirCardDefinitionName, DirCardCompDefName	A unique identifier for the component detail. For new component detail records supply the source key attributes. You can also identify card components with the user key attributes.
LegislativeDataGroupName	N/A	The name of the legislative data group for the card component definition.
DirCardCompId(SourceSystemId)	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName	The parent involuntary deduction card component should be referenced using the same key type used to identify the parent record. When using source keys, supply this attribute with the value supplied for the card component’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card component.
EffectiveStartDate	N/A	The start date of the component detail, or update to the component detail if you are providing date-effective history. This must be after or equal to the EffectiveStartDate provided for the involuntary deduction card component.
EffectiveEndDate	N/A	The optional end date of the component detail, or if you are providing date-effective history the last day of the date-effective changes.
DirCardCompDefName	N/A	The name of the card component this detail is for. This is used to identify the flexfield context and should be supplied even when a source key is used to identify the parent card component.
DirInformationCategory	N/A	The code for the flexfield context, such as ‘INVLN_DEDN_PAYEE_DETAILS’. Flexfield context codes are visible on the Flexfield Attributes tab of the View Business Objects task.
FLEX:Deduction DeveloperDF	N/A	Supply the same value as for the DirInformationCategory attribute.

Involuntary Deduction Component Detail Flexfield Contexts

These four flexfields are applicable to all Involuntary Deduction types:

Involuntary Deduction Payment Details (INVLN_DEDN_PAYEE_DETAILS)

Involuntary Deduction Rules (INVLN_DEDN_SUPPORT_DATA)

US Involuntary Deduction Data (HRX_US_INV_DEDN_DATA)

US Involuntary Deduction Contact Information (HRX_US_INV_DEDN_CONTACT_INFO_DATA)

Note: The US Involuntary Deduction Contact Information (HRX_US_INV_DEDN_CONTACT_INFO_DATA) flexfield is optional.

For Child Support, Spousal Support and Alimony involuntary deductions, a fifth flexfield context is available:

US Involuntary Deduction Child Data (HRX_US_INV_DEDN_CHILD_DATA)

You can find the flexfield segment attribute names on the Flexfield Attributes tab of the View Business Objects task.

Search for the Calculation Card business object and click the object name.
Click Component Details in the object hierarchy.
Select the Flexfield Attributes tab.
Search for each flexfield context in turn to review the list attribute names and the validation set used for attribute validation.

Note: To supply third party payee details on the Involuntary Deduction Payment Details flexfield context, refer to the Cloud Customer Connect HCM Integrations Resource Sharing Center topic Template: BI Publisher Report: Third Party Payees. This report downloads the third-party names and party IDs for the country, legislation and payee type specified.

Flexfield Segment Lookup Validated Attributes

Take a look at these lookup types that are used by the flexfield attributes for the US Involuntary Deductions card:

FLEX:Deduction DeveloperDF	Attribute Name	Lookup Type
HRX_US_INV_DEDN_DATA	_Filing_Status	ORA_HRX_US_INVOL_FILING_STATUS
HRX_US_INV_DEDN_DATA	involDedEarnType	ORA_HRX_US_INVOL_EARN_TYPE
INVLN_DEDN_SUPPORT_DATA	frequency	PAY_PROC_PERIOD_TYPE

Supply the lookup code value to these attributes.

Calculation Value Definition Attributes

Involuntary Deduction card component use value definitions to supply override values.

The value definitions to supply are determined by the element used for the card component. Refer to the Cloud Customer Connect topic Template: BI Publisher Report: United States - Involuntary Deduction Value Definitions.

The Calculation Value Definition record type specifies the name of the value definition you are supplying an override value for.

The Calculation Value Definition record type uses these attributes:

HCM Data Loader Attribute	Alternative User Key Attributes	Functional Description
SourceSystemOwner	N/A	The name of the source system owner used to generate the source system ID.
SourceSystemId	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName	A unique identifier for the calculation value definition record. For new records supply the source key attributes. You can also identify calculation value definition records with the user key attributes.
LegislativeDataGroupName	N/A	The name of the legislative data group for the card component definition.
SourceId(SourceSystemId)	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName	The parent involuntary deduction card component should be referenced by using the same key type used to identify the card component. When using source keys, supply this attribute with the value supplied for the card component’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent card component.
EffectiveStartDate	N/A	The start date of the parent involuntary deduction card component. Or, the date the calculation value definition starts, if it’s a later date.
DirCardCompDefName	N/A	The definition name of the parent involuntary deduction card component.
ValueDefinitionName	N/A	The name of the value being overridden. The list of value definitions applicable to this card component are listed listed in the Template: BI Publisher Report: United States - Involuntary Deduction Value Definitions Cloud Customer Connect topic.
ValueType	N/A	The optional type of the value definition, such as Rate or Total amount. Supply a code from the lookup type PAY_DED_OVERRIDE_TYPE.

These attributes are supplied against the CalculationValueDefinition file discriminator and must be supplied along with a CardComponent record for the parent involuntary deduction card component and a CalculationCard record for the owning Involuntary Deductions card.

Enterable Calculation Value Attributes

The Enterable Calculation Value provides the override value for the value definition. It references the Calculation Value Definition record which defines the Value Definition being overridden.

The Enterable Calculation Value record type uses these attributes:

HCM Data Loader Attribute	Alternative User Key Attributes	Functional Description
SourceSystemId	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName	A unique identifier for the enterable calculation value record. For new records supply the source key attributes. You can also identify calculation value definition records with the user key attributes.
SourceSystemOwner	N/A	The name of the source system owner used to generate the source system ID.
LegislativeDataGroupName	N/A	The name of the legislative data group for the override value.
ValueDefnIdSourceSystemId)	CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName, ValueDefinitionName	Identify the parent Calculation Value Definition record using the same key type used to identify the calculation value definition. When using source keys, supply this attribute with the value supplied for the calculation value definition’s SourceSystemId attribute. Otherwise, supply the user key attributes with the same values as the parent record.
EffectiveStartDate	N/A	The effective start date of the parent calculation value definition record, or the update to the override value if supplying date-effective history.
EffectiveEndDate	N/A	The optional end date of the override value, or if you are providing date-effective history, the last day of the date-effective changes
Value1	N/A	The value for the value definition identified by the parent calculation value definition record.

These attributes are supplied against the EnterableValueDefinition file discriminator. You must supply an EnterableValueDefinition record for each CalculationValueDefinition record supplied.