This article describes how to configure a client for the Ubiquity Deduction Feedback to PrismHR moov definition used for 360 integration. Each client configuration will vary based on their plan specification and will need to be configured accordingly.
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.
Create an SFTP Account in detamoov
Ubiquity will send the feedback file to detamoov via SFTP. To create an SFTP account, make sure you are logged in with an administrator level account. Click on your initials in the top right corner and select the Admin Console link.
Within the Admin Console, select the Settings tab and click on the SFTP row. Once the SFTP area expands, click the Add button to add a new SFTP account.
The side sheet will be where you'll enter information on your new SFTP account. All fields are required. Here's some information on each field:
- Username: required, cannot contain spaces and must be unique across all SFTP accounts.
- Password: required and must adhere to the standard detamoov password requirements.
- Confirmation password: required and must match the password field exactly (case sensitive).
- Description: required and used to describe why you're creating this account.
Once you've entered all the information above, click Save and your account will be created.
Provide Ubiquity with the SFTP credentials created above to allow them to send the feedback files for your client.
Host: sftp.prod.detamoov.com
Port: 22
Username: username created above
Password: password created above
After the PrismHR Premier Integration has been activated on your account and the SFTP account has been created, please add the Ubiquity Deduction Feedback to PrismHR moov to your account by following these steps.
Once the Ubiquity Deduction Feedback to PrismHR moov has been added to your account, access the moovs section on the left side menu and click on the Ubiquity Deduction Feedback to PrismHR moov.
The Ubiquity Deduction 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 - Deferrals_[your client's Ubiquity Plan ID]
File Name Contains -
Note: make sure that the File Name Starts with field matches as this can cause issues pulling the Ubiquity feedback file and updating PrismHR.
Click Next once you have completed the ID and source section.
The PrismHR Plan ID is required for detamoov to update changes via their API. A field override is required to provide this as Plan Number in Ubiquity 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 Ubiquity Deduction 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 Ubiquity Loan Number and the TPA Loan Identifier field in PrismHR.
If an employee makes a change to an existing loan in Ubiquity , the Ubiquity Loan Number 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.
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.
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.
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.
