This article describes how to configure the Principal Deduction Feedback Split by Payroll Site moov for PrismHR integration. This moov is intended for Principal plans that have more than one Payroll Site. If your client's plan only has one Payroll Site, use the Principal Loan Feedback to PrismHR moov instead.
PrismHR - Configure a Web Service/API User
Before detamoov can update deductions in PrismHR, the Allowed Methods for Retirement Providers to PrismHR Integrations (known as "360") must be added to the Web Service/API User. These methods can be found in the Configuring a Web Service/API User in PrismHR article.
To adopt the Principal Loan Feedback Split by Payroll Site moov, click on the moovs option on the left and click the New button in the upper right.
Then expand the 'Retirement - Retirement to Payroll' section, click on the 'Principal Deduction Feedback Split by Payroll Site' moov and click USE THIS MOOV by scrolling down to the bottom of the right sidenav.
In the moov configuration section, click the Add button to add a new client to the moov.
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 - C[Your client's 6-digit Principal Contract Number]
File Name Contains - LOAN
Note: make sure that the File Name Starts With and File Name Contains fields are correct as this can cause issues pulling the Principal loan feedback file and updating the payroll platform.
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 deduction 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.
Before you configure the moov for each location, scroll through the moov steps and set each Queue moov step's Skip Step setting to 'Skip step if no data to process'. This needs to be set for the following steps:
- Step 6
- Step 11
- Step 16
- Step 21
- Step 26
- Step 31
Overrides for Filter Step for each Payroll Site
To properly split the Principal Deduction Feedback file by Payroll Site, you will need to provide filter overrides for each location. For example, if our client's Principal plan has three Payroll Sites that we expect in the feedback file, then we need to set filter overrides for the first three filter steps. If there are four Payroll Sites, then four filter overrides are needed, and so on.
To set a filter override, click on the Filter Overrides panel, click the ADD button.
Then select Filter 1: Payroll Site and click ADD OVERRIDE.
The default filter is set to filter out any record where the value is not 9999. You will need to replace the value 9999 with the Payroll Site you expect and click OK.
If you do not know the Payroll Site values for your client's plan, please contact Principal.
The above filter override will need to be repeated for each Payroll Site you expect in the feedback file. Any other Filter steps beyond the number of Payroll Sites you expect should not be changed.
Here is a table showing the step(s) that need a filter override based on the number of Payroll Sites expected in the feedback file:
| # of Payroll Sites | Filter Steps to Override |
|---|---|
| 2 | Step 3, 8 |
| 3 | Step 3, 8, 13 |
| 4 | Step 3, 8, 13, 18 |
| 5 | Step 3, 8, 13, 18, 23 |
| 6 | Step 3, 8, 13, 18, 23, 28 |
Once you have provided a filter override for each Payroll Site, scroll to the bottom of the page and Click Next. Then click Save on the summary page.
Configuring a client for the Principal Loan Feedback to PrismHR moov
Each client Payroll Site will need to be separately configured for the Principal Loan Feedback moov. To configure the Payroll Sites, please add the Principal Loans Feedback to PrismHR moov to your account by following these steps.
Once the Principal Loans Feedback to PrismHR moov has been added to your account, access the moovs section on the left side menu and click on the Principal Loans Feedback to PrismHR moov.
The Principal Loans Feedback to PrismHR moov provides a notification once the moov is complete with a summary of the retirement plan and loan changes that were made in PrismHR. 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.
In the moov configuration section, click the Add button to add a new client to the moov.
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 - [Payroll Site]-[Contract Number]
File Name Contains - loan
When adding a new client configuration, it is important to understand the naming convention used in the Principal Deduction Feedback Split by Payroll Site moov. Each Payroll Site file is renamed using the naming convention:
[Payroll Site]-[Contract Number]-loan.csv
To ensure that the each Payroll Site file is associated with the correct client configuration, the File Name Starts with and File Name Contains fields must be correct. For example, if we provided a Filter Override for Payroll Site 0000001 and Contract Number 512345, our ID and Source would look like this:
Note: make sure that the File Name Starts With and File Name Contains fields are correct as this can cause issues updating the PrismHR.
Important: The SFTP Pull Data Trigger section should NOT be configured when you are using the Principal Deduction Feedback Split by Payroll Site moov.
The PrismHR Plan ID is required for detamoov to update changes via their API. A field override is required to provide this as the Contract Number in Principal may be different from the Plan ID in PrismHR .
The PrismHR Plan ID can be found in Benefit Plan Maintenance/Retirement Plans:
To create a field override locate step 4 Action Transform and expand the Field Overrides section.
NOTE: There are 3 separate Transform steps on the Principal Loans Feedback to PrismHR moov. Make sure are you creating the field override on step 4 - Action Transform.
Then click the ADD button and select field 8: Plan ID and enter you the PrismHR Plan ID in the Override value field.
If detamoov receives a Loan in the feedback file, it is important to understand the relationship between the Principal Loan ID and the TPA Loan Identifier field in PrismHR.
If an employee makes a change to an existing loan in Principal, the Principal Loan ID passed in the feedback file must match the TPA Loan Identifier fields in PrismHR. If these don't match, a new loan will be created for this employee instead of an update to the existing loan.
Skip Step - PrismHR Retirement 360
Principal will send deduction feedback files even if no deductions or loan changes were made. This will result it a blank deduction feedback file. When this occurs, detamoov can skip the PrismHR Retirement 360 step. To activate the skip step, locate the Action - PrismHR Retirement 360 step and select "Skip step if no data to process" from the Skip Step dropdown.
Configure the PrismHR Retirement 360 Step
To configure the PrismHR Retirement 360 step for you client, locate the Action - PrismHR Retirement 360 step, expand the PrismHR API panel and click ADD.
On the side panel that appears, select your PrismHR Premier Integration and enter in the Client Id that is associated with the Payroll Site. In our example above, our Payroll Site is 0000001 and that is associated with Client Id 106 in PrismHR.
Optionally, you can toggle the 'Skip Employee Retirement Plan ID Validation' switch on. This is applicable when your client has multiple retirement plans inside PrismHR and you don't want detamoov to validate the Plan ID field for each employee. If this option is toggled on, detamoov will skip the validation of the employee retirement plan ID when updating existing deferrals and loans. Since most situations require retirement plan ID validation, this option is toggled off by default.
You can also enter in one or more email addresses in the Error Messages Email. If left blank, all detamoov users on your account with administrator rights will receive emails if the PrismHR Retirement 360 step fails.
Click OK to complete the PrismHR Retirement 360 configuration.
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 or loan changes were made. This will result in a blank deduction 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.
