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 PrismHR > How to configure the KTrade Deduction Feedback to PrismHR moov
How to configure the KTrade Deduction Feedback to PrismHR moov
print icon

This article describes how to configure a client for the KTrade 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.

 

Adopt the moov

 

After the PrismHR Premier Integration has been activated on your account, please add the KTrade Deduction Feedback to PrismHR moov to your account by following these steps.

 

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

 

 

Send File Settings

 

The KTrade 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.

 

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 - [your client's KTrade Plan ID]-ktrade

File Name Contains - csv

 

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

 

 

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 PrismHR Plan ID is required for detamoov to update changes via their API.  A field override is required to provide this as the Plan ID in KTrade 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 KTrade 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.

 

 

TPA Loan Identifier

 

If detamoov receives a Loan in the feedback file, it is important to understand the relationship between the KTrade LoanNumber and the TPA Loan Identifier field in PrismHR.

 

If an employee makes a change to an existing loan in KTrade, the KTrade LoanNumber 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.

 

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.

 

 

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.

scroll to top icon