User-Based Access to Buttons

  • Updated

User-Based Access to Buttons

Overview

With the Platinum release, you can now see or use the buttons on the contract page only if you have the necessary permissions to see or use it.

For every button on the CL Contract page, the system checks the permissions, based on which the button is either visible or hidden. This is achieved through Javascript that checks the button API name and invokes the API to check the permissions.

The custom buttons are hidden if permissions are not granted in the profile or the permission set. However, the standard buttons, such as New Loan Disbursal Transaction, New Loan Payment Transaction, are visible, but on clicking them, the system displays an error message on the page if the user does not have permission to use them.

Note:

For more information on exceptions and error messages, see the Error Messages or Exceptions section of the User-Based Access to UI Elements section in 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.

Note:

For more information, see the SecureUIAndInvocation section in the Q2 Loan Servicing Global Methods guide.

Custom Permission Names with Button Names

The following table lists the buttons that can be checked for user access with the help of their corresponding custom permission names:

ButtonCustom Permission Name
Standard Buttons
New Loan Disbursement TransactionNew_Loan_Disbursement
New Loan Payment TransactionCreate_Manual_Payments
Custom Buttons
Calculate TDSCalculate_TDS
Change Credit LimitCredit_Limit_Change
Change Payment AmountPayment_Amount_Change
Payment PlanDelinquent_Amount_Spread
Event ReversalOut_of_Order_Event_Reversal
Edit Additional ParametersManage_Additional_Parameter
Loan Amount AdjustmentLoan_Amount_Adjustment
One Time ACHSetup_One_Time_ACH
Payment Tolerance ChangeChange_Payment_Tolerance
Principal AdjustmentPrincipal_Adjustment
Print Repayment ScheduleView_Amortization_Schedules
Recurring ACHSetup_Recurring_ACH
Reforecast StreamsReforecast
RefundBorrower_Refund
Regenerate Amortization ScheduleRegenerate_Schedules
Regenerate ScheduleRegenerate_Schedules
RescheduleReschedule
Setup Automated PaymentAutomated_Payment_Setup
Suspend FeesSuspend_Fees
Transaction SummaryView_Transaction_Statements
Accrual HistoryView_Accrual_History
Populate FeesPopulate_Pre_paid_Fees
ExtensionTerm_Extension
Additional RepaymentAdd_Extra_Installment_Payment
Regenerate Principal and Interest PaymentRegenerate_Principal_and_Interest
Investment Order Initial SetupInvestment_Order_Setup
Investment Order MaintenanceInvestment_Order_Setup
Loan Pay OffPayoff_A_Loan
Create New ChargeCharge_Creation_Manual

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.

Note:

For more information, see the SecureUIAndInvocationWebService section in the Q2 Loan Servicing Global Methods guide.

Update the User-Based Access to Buttons

Prerequisite

Before updating the user-based access to buttons, ensure that the following prerequisite is met:

  • Restrict Actions Based On Permissions flag is enabled in Setup > Custom Setting > 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

To update the access permissions to the buttons:

  1. Log in to your Salesforce Account.

  2. Go to (Setup) > Setup.

  3. In the Quick Find box, search for Profile and then click it.

  4. Click the required profile, and then click Custom Permissions.

  5. Click Edit.

  6. Add the required permission by selecting the item in the Available Custom Permissions box and then clicking Add.

    For example, if you want to update the permissions for the Reschedule button, then select loan.Reschedule in the Available Custom Permissions, and then click Add.

    Adding Permissions for Reschedule

    Reschedule added in Enabled Custom Permissions

  7. Click Save.

    This adds the required permissions to the profile and the Reschedule button is visible to the user of this profile on the CL Contract page.

    Reschedule Button

Update the Permissions by Updating the Permission Sets and then Assigning the User to it

If the required user 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 user. 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

To create a Permission Set:

  1. Log in to your Salesforce Account.

  2. Go to (Setup) > Setup.

  3. In the Quick Find box, search for Permission Sets and then click it.

  4. Click New.

  5. 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. The steps are explained with the help of this example.

    FieldAction and Description
    LabelProvide 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.

    DescriptionProvide a description to explain the usage of this permission set.

    Note:

    In the preceding image, as an example, we have created a Permission Set for Reschedule to enable the user to use the rescheduling-related button on the contract page.The permission set for rescheduling is added to the list of Permissions Sets.

    Permission Set for Reschedule

Step 2: Add Custom Permissions to the created Permission Set

To add Custom Permissions to the created Permission Set:

  1. In the preceding created Permission Set, scroll down and click Custom Permissions.

    Custom Permissions of a Permission Set

  2. Click Edit.

    Edit Custom Permissions of Permissions Set for Reschedule

  3. Select the Available Custom Permissions for the rescheduling-related functionality, and then click Add.

    Add Available Custom Permissions

  4. Click Save.

Step 3: Assign the user to the Permission Set

  1. After adding the Custom Permissions to the Permission Set in the preceding step, click Manage Assignments.

    Permission Set with Custom Permissions

  2. Click Add Assignments.

    Add User to the Permission Set

  3. Select the user to assign this permission set to, and then click Assign.

  4. Click Done.

    User Assigned to the Permission Set

    This enables the user to use only the Reschedule-related UI button as highlighted in the following image, however, the user does not have the permissions to use any other UI buttons of the CL Contract page.

    Note:

    If the profile of the user does not have permission to use the button in custom permissions, but if the user has been assigned to the permission set that has the custom permissions to use it, then the button is still available for the user.

    Rescheduling-Related Buttons on the CL Contract Page

In This Article