Commerce Filter Rules

Overview

Filter Rules are used to exclude irrelevant Line Item Grid items. Filter rules are only available for Commerce sub-documents.

Note: Commerce Filter Rules are only applicable to the JET Transaction UI, this functionality is not available for the legacy Transaction UI.

Administrators can define sub-document Commerce Filter rules that use Commerce attributes for simple or Advanced BML conditions to filter out items that are not relevant to the current user.

For example: The Line Item Grid in the Transaction UI shows all the BOM items as a result of the BOM Mapping Rules. A subset of the BOM items in this list, though useful for downstream fulfillment systems, are considered internal to the customer and not relevant for the sales users.

Buyside items not filtered example

After the Filter rule is saved and deployed, all "Internal" type parts are excluded from the Line item Grid.

Buyside items filtered example

Parent Filtering and Rolling Up Children

Note: When using the Firefox browser, the Filter Rule icon appears in the main document Commerce Rule UI if an administrator opens the main document Commerce Rule UI after opening the sub-document Commerce Rule UI. The Filter Rule icon can be removed by refreshing the browser page.

Administration

Create a Sub-Document Filter Rule

Complete the following steps to define a Commerce Filter rule for the transaction line items.

Navigate to the Rule Editor page for the applicable Commerce sub-document.

Admin > Commerce and Documents > Process Definition > Documents > Rules
Select Filter from the Add drop-down menu.
Enter the rule Properties.
- Name - Enter the name of the rule in this section. This is a required field.
- Variable Name - The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only.This is a required field.
- Description - Enter a description, if desired. Only viewable by FullAccess users, use this field to describe how the rule functions so that other FullAccess users can easily understand the purpose of the rule.
- Status - Determine the status of the rule:
  - Active - The rule is fired when the condition is met.
  - Inactive - The rule is not fired even if the condition is met. Inactive rules are displayed in italics in the rules list in the left panel.
Define rule Condition.

Select the Condition Type

Always True - The rule will fire automatically, every time, because a specific condition does not need to be met.

Simple - Use the rule editor to define condition attribute values.
- Select an attribute from the drop-down menu.
- Select an Operator and enter the Value.
  
  For example: The following filter will hide all "Internal" type parts from the Line Item Grid.
Advanced - Define advanced conditions using BML.
- Click Define Function to open the BML Editor.
- Select the applicable variables and functions, then click Next.
- Enter the BML function, then click Save and Close.
Click Save.

To prevent inaccessible line items administrators should avoid using modifiable attributes in filter rule conditions that can directly affect line item visibility.

Enable Parent Filtering and Rolling Up Children

Notes

NULL and blank Integer values are treated as separate values:
- NULL= 0
- Blank = ""
Using NULL as an attribute value is strongly discouraged.
If you use logic that tests for NULL values in rule conditions or BML, confirm that the logic takes this difference into account.

Custom Variable Name Conventions

In Oracle CPQ 23D, CPQ adopted Oracle CX Sales variable naming conventions for custom items. When an administrator creates a new custom Commerce item, the "_c" suffix is appended to the variable name. The new naming convention for custom variable names provides more consistency for integrations with Oracle Sales.

Beginning in Oracle CPQ 24C, customers can submit a service request to disable the "_c" suffix on variable names for custom Commerce entities (Actions, Analytics, Attributes, Data Columns, Integrations, Library Functions, Rules, Steps, etc.). The "_c" suffix is enabled by default for standard and legacy Commerce processes.

Customers can submit a Service Request (SR) on My Oracle Support to disable the "_c" suffix on variable names for custom Commerce entities
When the "_c" is disabled, the "_c" variable name suffix will not be required for newly created custom Commerce entities.
Disabling the "_c" variable name suffix for custom Commerce entities will not change existing variable names.
The "_c" suffix setting will not impact existing variable names when cloning a Commerce process or migrating Commerce items. Target variable names will be the same as the variable names from the source Commerce process.

Notes:

Oracle CPQ 23B introduces the Standard Process which provide a converged set of generic rules sourced from existing Oracle CPQ reference applications. The Standard Process rules cannot be deleted or modified, but they can be inactivated. For Validation type rules Linked Actions can be updated.
Test performance early and often – AJAX enabled constraint and access rules might make the Transaction page slow depending on the number of attributes, rules, use of advanced function, and so on. Performance tests are a must!

Commerce Filter Rules

Overview

Administration

Notes

Related Topics