Salesforce Docs Portal

Customize the Eligibility Framework (Managed Package)

As your business processes change and evolve, the checks that you need to perform to validate if an action should be allowed might also change. The eligibility framework allows you to update the checks performed for any workflow, without having to update the core components used in the workflow.

Managed Package Icon This feature is part of the Communications Cloud managed package.

To update the validity checks, ensure that the individual Integration Procedures that the eligibility framework uses exist. If the required Integration Procedures don't exist, create them first. Then update the Calculation Matrix to add those Integration Procedures to the rule for the required combination of journey and check. You can apply a rule to multiple workflows by adding a row to the Calculation Matrix for each workflow.

To customize the eligibility framework, follow these instructions:

  • Extend an Eligibility Rule in Multiplay Subscription Management
    Consider a scenario where you already have an eligibility rule defined for a given workflow. In addition to the existing validation, you want to check for an additional parameter.
  • Create a New Check for a Workflow in Multiplay Subscription Management
    Consider a scenario where you want to check for additional parameters in one or more workflows. For example, your business processes now require that you check if a subscriber's account is suspended or if the parent account is suspended before you proceed with certain actions. The eligibility framework allows you to define this rule in the calculation matrix so that it applies to multiple workflows without having to modify any of the workflows themselves.
  • Create a Rule for a New Workflow in Multiplay Subscription Management
    Consider a scenario where you want to use the eligibility framework to run various eligibility checks for a new workflow. In this scenario, assume that you already have the individual Integration Procedures that will be used to implement the checks.

Extend an Eligibility Rule in Multiplay Subscription Management

Consider a scenario where you already have an eligibility rule defined for a given workflow. In addition to the existing validation, you want to check for an additional parameter.

For example, consider the workflow Manage Features. You already have an eligibility rule that checks various criteria, but you want to additionally check that the subscription is active and is not suspended.

  1. Ensure that you have an Integration Procedure that implements this check. If you don't have the appropriate Integration Procedure in your org, create or import the relevant Integration Procedure.
  2. Go to the App Launcher. Under All Items, click Vlocity Calculation Matrices.
  3. Click SFI-EligibilityMatrix.
  4. Click the version that you want to update.
  5. Click Download CSV.
  6. In the downloaded CSV file, go to the row that has the combination of journey and check for which you want to update the rule. In the Rule column, enter he logical condition and the name of the Integration Procedure that you want to call to run the additional eligibility check.
  7. Save the file.
  8. Upload the file to a new version of the Calculation Matrix.
    1. On the SFI-EligibilityMatrix page, click Related.
    2. Click New.
    3. Enter a name and a version and click Save.
    4. Under Table, click Upload CSV and select the CSV file that you just updated.
    5. When the file has been uploaded, click Close.
  9. Map the Process and Check columns to Header Type Input and map the Rule column to Header Type Output.
  10. Click Save Data and then click Update JSON.
  11. In the Details section, click an Edit icon.
  12. Click Enabled.
  13. Set a priority.
  14. Click Save.

Create a New Check for a Workflow in Multiplay Subscription Management

Consider a scenario where you want to check for additional parameters in one or more workflows. For example, your business processes now require that you check if a subscriber's account is suspended or if the parent account is suspended before you proceed with certain actions. The eligibility framework allows you to define this rule in the calculation matrix so that it applies to multiple workflows without having to modify any of the workflows themselves.

In the eligibility framework, the input in the calculation matrix consists of two parameters called process and check. While process name corresponds to the name of the workflow, check doesn't correspond to any specific entity. You can define a specific check to correspond to a given set of Integration Procedures used in a rule. For example, a check called RoleEligibilityCheck could be used to refer to a set of Integration Procedures that are used together to determine if the current user has the appropriate role to perform the specified action.

The Integration Procedures specified in the Rule column of the Calculation Matrix will now be called by the eligibility framework whenever the Calculation Matrix is called with the corresponding combination of journey and check as input.

  1. Ensure that the Integration Procedures required to implement the checks already exist in your org. If you don't have the appropriate Integration Procedure in your org, create or import the relevant Integration Procedures.
  2. Go to the App Launcher. Under All Items, click Vlocity Calculation Matrices.
  3. Click SFI-EligibilityMatrix.
  4. Click the version that you want to update.
  5. Click Download CSV.
  6. Update the downloaded CSV file as required.
    1. In a new row, in the Process column, enter the name of the workflow where you want to add the new eligibility check.
    2. In the Check column, enter a name for the new eligibility check.
    3. In the Rule column, enter the names of the Integration Procedures that you want to use for the additional eligibility check, along with the relevant logical conditions.
    4. Add additional rows if you want to use the new eligibility check in multiple workflows.
  7. Save the file.
  8. Upload the file to a new version of the Calculation Matrix.
    1. On the SFI-EligibilityMatrix page, click Related.
    2. Click New.
    3. Enter a name and a version and click Save.
    4. Under Table, click Upload CSV and select the CSV file that you just updated.
    5. When the file has been uploaded, click Close.
  9. Map the Process and Check columns to Header Type Input and map the Rule column to Header Type Output.
  10. Click Save Data and then click Update JSON.
  11. In the Details section, click an Edit icon.
  12. Click Enabled.
  13. Set a priority.
  14. Click Save.

Create a Rule for a New Workflow in Multiplay Subscription Management

Consider a scenario where you want to use the eligibility framework to run various eligibility checks for a new workflow. In this scenario, assume that you already have the individual Integration Procedures that will be used to implement the checks.

  1. Follow the steps for Create a New Check for a Workflow in Multiplay Subscription Management.
  2. Call the eligibility framework from an OmniScript or an Integration Procedure in the new workflow.

    Pass the journey and check values as input to the eligibility framework. Also use the additional input option to pass the input required by the individual Integration Procedures to implement the eligibility checks.

The eligibility framework returns the result from the entire set of Integration Procedures specified in the Rule for a given combination of input. If the validation fails, the eligibility framework also returns all the reasons for the failure. Use the VPL-DisplayIneligibilityReasons UI template to display the reasons in your workflow.