You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Home > moovs > How to configure a moov - Retirement to Payroll > Retirement to PrismHCM > How to configure the Principal Deduction Feedback to PrismHCM moov
How to configure the Principal Deduction Feedback to PrismHCM moov
print icon

This article describes how to configure a client for the Principal Deduction Feedback to PrismHCM moov definition used for 360 integration.  Each client configuration will vary based on their plan specification and will need to be configured accordingly.

 

Adopt the moov


To configure your client for the Principal Deduction Feedback to PrismHCM moov, please add the moov to your account by following these steps.

 

Once the Principal Deduction Feedback to PrismHCM moov has been added to your account, access the moovs section on the left side menu and click on the Principal Deduction Feedback to PrismHCM moov.

 

 

Send File Settings

 

The Principal Deduction Feedback to PrismHCM moov provides a notification once the moov is complete with a summary of the retirement plan changes that were made in PrismHCM. The notification can be sent to any email address you wish and can also be configured to send to multiple email addresses. 

 

To edit the send file step, click on the cog icon under the Action - Send File step on the left.  Then toggle the "Use default parameters" off and enter in the email addresses you would like to receive the notification.  If you would like to enter multiple email addresses, separate them with a comma.  A Reply to email is also required in the event that a recipient of the notification replies to the email.

 

 

Note: these settings apply to any client configuration you set up for this specific moov.  You also have the ability to configure the send file step for each client configuration if you wish to add or remove email addresses per client.

 

To save your parameters click on the Save Changes button.

 

Configure a client

 

In the moov configuration section, click the Add button to add a new client to the moov.

 

 

Complete the ID and source

 

Client/Entity - either select an existing client or click the + sign to create a new client. 

Status - Set to Active

Expected Frequency - the client's payroll frequency

File Name Starts With - Principal files for your client with be in the naming convention of C[Prefix][Contract Number]_DFRL_[CCYYMMDD].  This field should be the C[Prefix][Contract Number] part of the file name

File Name Contains - DFRL

 

Note: make sure that the File Name Starts with field matches as this can cause issues pulling the Principal feedback file and updating PrismHCM.

 

 

Click Next once you have completed the ID and source section.

 

Configure the SFTP Schedule

 

To automate the 360 integration, configure the SFTP schedule.  Click the SFTP banner under the Trigger - SFTP Pull Data Trigger step and click Add.

 

 

On the New SFTP Configuration section on the right, select the SFTP Pull option from the Premier Integration menu.  Then select either "Every X weeks" or "On certain days of the month", depending on how often you would like detamoov to check for new feedback files.  We recommend that you check for feedback files at least twice a week. In the example below, we have set up a schedule to check for files twice a week on Tuesdays and Fridays. 

 

 

Click OK once you have created your SFTP configuration.

 

Field Overrides

 

The clientId field is required to properly update the client in PrismHCM.  To provide the clientId, locate step 6: Action - Transform, click the File Overrides panel and then click the ADD button.

 

NOTE: There are three separate Transform steps on the Principal Deduction Feedback to PrismHCM moov.  Make sure are you creating the field override on step 6: Action - Transform.

 

 

Then select field 2: clientId and enter in the client ID in the Override Value field.

 

 

Transformation Overrides - Contribution Codes

 

The table below shows the Principal deduction code for the employee, the code detamoov maps the Principal code to by default, and the associated PrismHCM Deduction Field:

 

 Principal Code            detamoov Code         PrismHCM  Deduction Field
 0001  401k   8: employeePreTaxContributionCode
 0021  401k Roth  24: employeeRothContributionCode
 0041  401k Roth Catch Up   29: employeeRothCatchupContributionCode 
 0017  401k Catch Up  34: employeeCatchupContributionCode

 

Each PrismHCM deduction code is client specific and must be provided for each type of contribution.  For example, if your client's deduction code for PreTax is 401k-1, then an override is required for field 8: employeePreTaxContributionCode. 

 

To provide the deduction code for your client, locate step 6: Action - Transform, click the Transformation Overrides panel and click the ADD button.

 

NOTE: There are three separate Transform steps on the Principal Deduction Feedback to PrismHCM moov.  Make sure are you creating the transformation override on step 6: Action - Transform.

 

 

Then select field 8: employeePreTaxContributionCode and click the ADD OVERRIDE button.

 

 

On the override page, enter in your client's deduction code in the 'With' field for the Replace/Remove String Transformation Rule and click OK.  For our example, the value '401k-1' is entered.

 

 

Repeat the transformation override for each of your client's PrismHCM deduction codes.

 

 

Principal will send deduction feedback files even if no deductions changes were made.  This will result in a blank feedback file.  When this occurs, detamoov can skip the PrismHCM Generic Import.  To activate the skip step, locate the Action - PrismHCM Generic Import and select "Skip step if no data to process" from the Skip Step dropdown.

 

 

Configure the PrismHCM Generic Import step

 

The PrismHCM Generic Import step uses your PrismHCM API credentials to update the specified client Id. To configure the PrismHCM Generic Import step for you client, locate the Action - PrismHCM Generic Import step, expand the PrismHCM API panel and click ADD.

 

 

On the side panel that appears, select your PrismHCM Premier Integration, enter in the Client Id and click OK.

 

You can also enter in one or more email addresses in the Error Messages Email field.  If left blank, all detamoov users on your account will receive emails if the PrismHCM API import fails.

 

 

Send File Step Override

 

At the beginning of this article you configured the send file step for the moov to send a notification once the moov had completed.  You also have the ability to configure the send file step for each client configuration if you wish to add or remove email addresses per client. 


To override the send file step, locate the Action - Send File step and toggle the "Use default parameters" off and enter/remove email addresses from Email Address and Reply To fields. If you would like to enter multiple email addresses, separate them with a comma.

 

 

 

Principal will send deduction feedback files even if no deductions changes were made.  This will result in a blank feedback file.  When this occurs, detamoov can skip the Send File step.  To activate the skip step, locate the Action - Send File step and select "Skip step if no data to process" from the Skip Step dropdown.

 

 

To complete the configuration for your client, click the Next button at the bottom of the page and then the Save button on the moov summary page.

 

Plans with Principal Loans

 

Principal sends the updates to loans in a separate file and requires that you configure the Principal Loan Feedback to PrismHCM moov.  If your client's plan has loans, please see the How to configure the Principal Loan Feedback to PrismHCM moov article.

scroll to top icon