Create Salesforce Industries (former Vlocity) context rules that run apex

To do that we need:

• A Custom Permission and a Permission Set

• An apex class

• A Vlocity_cmt__FunctionDefinition__mdt metadata entry (This tells the Vlocity Functions how to reach the class and what methods to call)

• A Vlocity Function (this will declare the class and method making them accessible to other Vlocity components)

• A context scope and context dimension (These components will run the Vlocity function and contain the result)

• A Rule and a Rule Set

1. Create the Custom Permission with the API name B2CPriceListAccess.

2. Create the Permission Set.

   A. Create the Permission Set with the API name B2CPriceListAccess.

   B. Add the Custom Permission B2CPriceListAccess. 

3. Create the apex class VL_ContextRuleFunctions:

   A. The inputs ('arguments') and outputs ('result') names must be respected.

4. Create a new entry in the vlocity_cmt__FunctionDefinition__mdt metadata:

5. Create a Function.

   A. In the Vlocity Product Console in the Rules section, click the plus icon ( + ) next to Function to create a new function.

   B. In the New Function dialog, enter the following information:

   C. Click Save.

   D. In the left sidebar, click the Function Arguments facet.

   E. Click New Argument to define the Output of the function.

   F. In the Function Arguments window on the right, enter the following information.

   G. Click Save.

   H. Click New Argument to define the Input of the function.

   I. In the Function Arguments window on the right, enter the following information.

   J. Click Save.

6. (Optional) Create a Context Scope if it doesn’t exist already.

The scope depends on the context of where the class should be executed. 

• If it should run only for Opportunity, Quote, Order, Asset, etc... then select a scope linked to the appropriate entity Object. 

• If it should always be executed (ex: checking user permissions), then use a scope for the Any Vlocity entity Object. 

• If the class should be run for the Vlocity Adjustment Data virtual Object, then choose the Vlocity Adjustment Data scope.

   A. In the Vlocity Product Console at the Rules section, click the plus icon ( + ) next to Context Scope to create a new function. 

   B. In the General Properties dialog, enter the following information:

Click Save.

Create a Context Dimension.

7. The Context Dimension is what will actually run and contain the results from the Vlocity Function declared earlier.

   A. In the Vlocity Product Console in the Rules section, click the plus icon ( + ) next to Context Dimension to create a new function. 

   B. In the New Context Dimension dialog, enter the following information.

   C. Click Save.

   D. On the left sidebar, click the Context Mappings facet.

   E. Click New Context Mapping.

   F. In the Context Mapping dialog, enter the following information.

   G. Click Save.

8. Create a Rule:

   A. In the Vlocity Product Console in the Rules section, click the plus icon ( + ) next to Rule to create a new function. 

   B. In the New Rule dialog, enter the following information.

C. Click Save.

   D.  In the left sidebar, click the Rule Conditions facet.

   E. Using the Add Condition dropdown menu, select Simple.

   F. In the Rule Condition window on the right, enter the following information.

   G. Click Save.

9. Create a Rule Set:

   A. In the Vlocity Product Console in the Rules section, click the plus icon ( + ) next to Rule Set to create a new function. 

   B. In the New Rule Set dialog, enter the following information.

   C. Click Save.

   D. Select Children Rules. Click New Children Rule.

   E. In the New Children Rule dialog, enter the following information.

   F. Save the Rule.

10. Apply the rule to the Vlocity component of choice, ex: Price Lists, Products, Promotions, Discounts, etc. In this example we will add to one Price List.

   A. In the Vlocity Product Console in the Pricing section create a new Price List:

   B. Click Save.

   C. Select Context Rules. Click Add Rule Set and select the Rule set.

   D. Click in the Button Add Rule Set.

   E. Search for the rule HasB2CAccess.

   F. Add the rule HasB2CAccess.

   G. Save the Rule.

11. Clean and repopulate Cache.

Context rules, rule conditions and rule sets are cached in the org cache of the CPQPartition platform cache. When troubleshooting, you will need to clear the cache for changes to be reflected at run time. 

   A. Go to the Vlocity CMT Administration tab.

   B. Click on Maintenance Jobs and click the Start button for the following jobs.

Results:

   1. User without the permission Set B2CPriceListAccess

   2. User with the permission Set B2CPriceListAccess

Summary

As we have seen this article explains how to create context rules with complex logic and use them for any SObject. We can leverage the power of apex and the ubiquity of Context rules to control the visibility of almost every component in the Vlocity cart: price lists and prices, product eligibility, promotions and discounts.

Additionally, creating Vlocity Functions this way, exposes them to DataRaptors and Integration Procedures formula fields with the added benefit of making them reusable.