User-Based Access to Loan Quick Menu
Overview
With the Platinum release, you can now see or use the Loan Quick Menu items on the contract page only if you have the necessary permissions to see or use it. The Loan Quick Menu items are rendered based on the permissions assigned to the user. If you use a global method to perform any Loan Quick Menu actions, the system notifies you of any error messages if there are insufficient permissions for that menu.
For more information on the error messages, see the Error Messages or Exceptions subsection of the User-Based Access to UI Elements section of this guide.
What are the APIs that can be used to check if the user has the access to run a feature?
The following APIs can be used to check if the user has access to run a feature:
isAuthorizedToUseFeature
This global method validates if a user has access to run a feature. It takes the custom permission name as an input parameter and returns the Result object with hasAuthorization and exceptionMessage set.
For more information, see the SecureUIAndInvocation section in the Q2 Loan Servicing Global Methods guide.
Custom Permission Names with Quick Menu Names
The following table lists the quick menu names that can be checked for user access with the help of their corresponding custom permission names:
Quick Menu Name | Custom Permission Name |
---|---|
Loan Pay Off | Payoff_A_Loan |
New Loan Payment Transaction | Create_Manual_Payments |
View Amortization Schedule | View_Amortization_Schedules |
View Consolidated Amortization Schedule | View_Amortization_Schedules |
Extension/Payment Deferral | Payment_Deferral |
Calculator | Amortization_Calculator |
Regenerate Principal and Interest Payment | Regenerate_Principal_and_Interest |
Regenerate Schedule | Regenerate_Schedules |
One Time ACH | Setup_One_Time_ACH |
Recurring ACH | Setup_Recurring_ACH |
Payment Plan | Delinquent_Amount_Spread |
Credit Limit Change | Credit_Limit_Change |
Waiver Action |
|
Capitalization Action | Interest_Capitalization_Manual |
Change Due Da | Change_Due_Day |
Rate Change | Contract_Interest_Rate_Change |
Cancel/Stop ACH | Cancel_Stop_ACH |
Term Extension | Term_Extension |
Principal Adjustment | Principal_Adjustment |
Refund | Borrower_Refund |
Reschedule | Reschedule |
Loan Amount Adjustment | Loan_Amount_Adjustment |
Payment Amount Change | Payment_Amount_Change |
Loan Cancellation | LOAN_CANCELLATION |
Add Remove Collateral | Add_Remove_Collateral |
Deposit to Loan Transfer | Deposit_To_Loan_Transfer |
Promotion Change | Promotion_Change |
Payment Tolerance Change | Change_Payment_Tolerance |
Deposit Transfer | Deposit_Transfer |
Manual Closure | Loan_Closure_Manual |
Transaction Summary | View_Transaction_Statements |
Download Account Statement | View_Transaction_Statements |
Loan Transaction Statement | View_Transaction_Statements |
New Payoff Quote | Payoff_Quote_New |
hasAccessToFeatureInvocation
This web service checks if the permissions are granted for the features. It takes a comma-separated list of feature names as input and returns JSON representation of feature name to permission result map.
For more information, see the SecureUIAndInvocationWebService section in the Q2 Loan Servicing Global Methods guide.
Update the User's Access Permissions to the Menu Items of the Loan Quick Menu
Prerequisite
Before updating the user-based access for Loan Quick Menu, ensure that the following prerequisite is met:
-
Restrict Actions Based On Permissions flag is enabled in Setup > Custom Settings > User Access Setting.
Note:For more information, see the User Access Setting section of the Q2 Loan Servicing Administration Guide.
Steps
You can update the user-based access permissions in the following two ways:
Update Permissions by Updating Custom Permissions of the Profile.
Update the permissions by updating the Permission Sets and then assigning the user to it.
Update Permissions by Updating Custom Permissions of the Profile
To assign the Custom Permissions to the Profile of the user for access to the menu items of the Loan Quick Menu:
Log in to your Salesforce Account.
Go to (Setup) > Setup.
In the Quick Find box, search for Profile and then click it.
Click the required profile, and then click Custom Permissions.
Click Edit.
-
Add the required permission by selecting the item in the Available Custom Permissions box and then clicking Add.
-
Click Save.
This adds the required permissions to the profile and the menu will be visible in the Loan Quick Menu.
Update the permissions by updating the Permission Sets and then assigning the user to it
If the required profile is to be given access to a certain functionality only, then all the UI elements of only that particular functionality need to be enabled for the profile. To do this:
Step 1: Create a Permission Set for that functionality
Step 2: Add custom permissions to the created Permission Set.
Step 3: Assign the user to the Permission Set.
Step 1: Create a Permission Set for that functionality
Go to (Setup) > Setup.
-
In the Quick Find box, search for Permission Sets, and then click it.
Click New.
-
Provide the details as described in the following table, and then click Save:
Note:You can refer to the Create New Permission Set image as an example.
Field Action and Description Label Provide a label name for the object to correctly identify the function of the permission set to be created. This field is mandatory. API Name This field gets updated automatically, but you can update it too.
Note:This is a unique name used by the API. This name must begin with a letter and use only alphanumeric characters and underscores. It can't include spaces, end with an underscore, or have two consecutive underscores.
Description Provide a description to explain the usage of this permission set. The newly created Permission Set for Redraw is added to the list of Permissions Sets.
-
Click Permission Set for Redraw.
Step 2: Add custom permissions to the created Permission Set
-
After clicking the preceding created Permission Set, scroll down and click Custom Permissions.
Permission Sets > Custom Permissions
Click Edit.
-
Select all the Available Custom Permissions for the Redraw-related functionality, and then click Add.
Click Save.
Step 3: Assign the user to the Permission Set
-
After adding the Custom Permissions to the Permission Set in the preceding step, click Manage Assignments.
Click Add Assignments.
Select the user to assign this permission set to, and then click Assign.
-
Click Done.
This enables the user of the profile to use only the Redraw-related UI menu as highlighted in the following image, however, the user does not have the permissions to use any other UI menu items of the Loan Quick Menu:
Note:Even if the user does not have permission to use the menu in Custom Permissions, but if the user has been assigned to the permission set, then the menu is available for the user.