Employee Garnishments HRPAPI Import Mappings

The PrismHR API can import employee garnishments data from PrismHR when the PrismHR Import Initial and PrismHR Import Ongoing scheduled processes run.

The following procedures provide details for viewing the import mappings and dataform properties used to configure the import:

  • Employee Garnishments HRPAPI mappings for the PrismHR API Garnishments import.

  • Dataform properties for the Garnishments dataform.

Note: The Garnishments dataform is where imported garnishments information is stored and viewed via an Action Center link on the Employee dataform. It cannot be edited by users but can be used to trigger helpful workflows in ClientSpace.

Import Mappings

To view the mappings:

1. Go to System Admin > Advanced > Configure Import.

The Import Map Header Search dashboard opens. There is an initial and an ongoing mapping.

• HRPAPI_initial_garnishment*.csv
• HRPAPI_garnishment*.csv
2. Locate each mapping. Search for Dataform = Garnishments to locate the two mapping files.
3. Click (Jump) to open a header detail record.

The Import Map Header Detail form opens.

The following image represents the Import Map Header Detail for HRPAPI_initial_garnishment*.csv used for the initial import of garnishments:

Employee Benefits Import Map Header for Ongoing Imports

The following image represents the Import Map Header Detail for HRPAPI_garnishment*.csv used for ongoing import of garnishments.

Employee Benefits Import Map Header for Ongoing Imports

4. To view the fields, click Fields.

The Import Map Search list displays the Garnishments dataform fields. (See Viewing Employee Garnishments for field definitions.)

Dataform Properties

To view the Garnishment Dataform properties:

1. Go to System Admin > Advanced > Dataform Admin.

The Dataform Admin dashboard opens.

2. Locate Garnishments and click (Jump).

The Dataform Properties: Garnishments window opens.

3. To view the fields, in the Action Center, click Fields.
4. To view field details, double-click the field or select the field and then click (Jump).

Field configuration details display.

The following image shows the Docket Number field details. Note that you can optionally set the Triggerable flag on a field as we have done here so that the field can be used in workflows.

Triggerable Skill Code Field

Can Use in Workflows

With the ClientSpace PrismHR HRPAPI, you can import Employee Garnishments data from the of the Employee record in the PrismHR application and then create workflows in ClientSpace. For instance, you can trigger notifications to follow up when an employee is rehired to check their garnishment status.

Any dataform field that is marked as Triggerable on the Dataform Properties window can be used in a workflow (as shown in the screenshot above).  

See Adding Dataform Fields.