Load Involuntary Deduction Cards for Canada
A Calculation Card record needs to be created for every employee for whom you are maintaining involuntary deductions.
Even if you are updating an existing calculation card and the calculation card itself is not being updated, still include the calculation card record to group other related data supplied in the file.
Involuntary Deductions Calculation Card Attributes
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | A unique identifier for the Involuntary Deductions calculation card. For new calculation card supply the source key attributes. You can also identify calculation cards 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 calculation card. |
| DirCardDefinitionName | N/A | The name of the card definition. Specify ‘Involuntary Deductions’ |
| CardSeqeunce | N/A | Specify ‘1’. Not required when source keys are used. |
| AssignmentId(SourceSystemId) | AssignmentNumber | Either supply the source system ID, or assignment number that identifies the employee assignment this calculation card is for. |
| EffectiveStartDate | N/A | The start date of the calculation card. Format YYYY/MM/DD. |
These attributes are supplied against the CalculationCard file discriminator.
Loading a Card Component for Involuntary Deductions
Each Involuntary Deduction element is created as an individual card component on the same Involuntary Deduction card for each employee. An employee will only have one Involuntary Deduction card.
This topic provides the 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 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.
Use the Canadian Involuntary Deductions BI Publisher report to extract the value definitions applicable for the element. Refer to the Cloud Customer Connect topic: BI Publisher Report: Canada - Involuntary Deductions Value Definitions for this report.
Card Component Attributes for Involuntary Deductions
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| SourceSystemId | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | A unique identifier for the Involuntary Deduction card component. For new card components, supply the source key attributes. You can also identify card components 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 card component definition. |
| DirCardId(SourceSystemId) | CardSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName | The parent Involuntary Deduction 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 Involuntary Deduction card 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
defined for the involuntary deduction. Element names can also be found in the list of values for the Element parameter on the Canada Involuntary Deduction Value Definitions report. |
| ComponentSequence | N/A | The number to uniquely identify this card component when multiple card components with the same DirCardCompDefName exist. Specify ‘1’ if using user keys. Not required when source keys are used. |
| Context1 | N/A | A reference code that uniquely identifies the order. An employee can have more than one order of the same deduction element. You can enter a court order number, remittance identifier, or other identifier provided by the issuing authority. |
These attributes are supplied against the CardComponent file discriminator and must be supplied along with a CalculationCard record for the parent Involuntary Deductions card.
Component Detail Attributes for Involuntary Deductions
The component detail record type lets you to upload data into flexfield segments.
| Card Component | Flexfield Context Code |
|---|---|
| Involuntary Deduction Rules | INVLN_DEDN_SUPPORT_DATA |
| Involuntary Deduction Payment Details | INVLN_DEDN_PAYEE_DETAILS |
| Canada Involuntary Deduction Data | ORA_HRX_CA_INV_DEDN_DATA |
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| 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. |
| 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 card component definition. |
| DirCardCompId(SourceSystemId) | CardSequence, ComponentSequence, AssignmentNumber, DirCardDefinitionName, LegislativeDataGroupName, DirCardCompDefName | The parent 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. |
| 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 applicable to the card component. These are listed above this table. For example, supply ‘INVLN_DEDN_SUPPORT_DATA’ for the Involuntary Deduction Rules card component. |
| FLEX:Deduction DeveloperDF | N/A | Supply the same value as for the DirInformationCategory attribute. |
| 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 parent 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. |
The attributes used to populate the flexfield segments differ depending on the flexfield context.
You can find the current flexfield segment attribute names for each flexfield context using the View Business Objects task.
Refer to the Cloud Customer Connect topic BI Publisher Report:Third Party Payees for Involuntary Deduction Cards for a report that extracts your third-party payees and their surrogate IDs, which can be supplied to the Order Amount Payee flexfield segment.
Calculation Value Definition Attributes
Involuntary Deductions card components use value definitions to supply values or override values.
The value definitions to supply are determined by the element used for the card component. Use the Canada Involuntary Deductions Value Definitions BI publisher report to extract the list of value definitions applicable to your element. Refer to Cloud Customer Connect topic: BI Publisher Report: Canada - Involuntary Deductions Value Definitions.
The Calculation Value Definition record type specifies the name of the value definition that you are supplying an override value for.
| HCM Data Loader Attribute | Alternative User Key Attributes | Functional Description |
|---|---|---|
| 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. |
| 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 card component definition. |
| SourceId(SourceSystemId) | CardSequence, ComponentSequence, PayrollRelationshipNumber, 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 later. |
| DirCardCompDefName | N/A | The definition name of the parent involuntary deduction card component. |
| ValueDefinitionName | N/A | The name of the value being overridden. For example, for a Garnishment, this can be “Court Order Amount”. |
| 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 value for the value definition. It references the Calculation Value Definition record, which defines the Value Definition being overridden.
| 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. You can enter an amount,
percent, or a Boolean value. Note: If defining a percent, enter the
value as a decimal. For example, enter ‘.50’ for 50%. For the
Boolean value, enter a ‘Y’ for yes, and a ‘N’ for
No. |
These attributes are supplied against the EnterableValueDefinition file discriminator. You must supply an EnterableValueDefinition record for each CalculationValueDefinition record supplied.