Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

How to report on Custom Fields

Updated on September 20, 2019


Custom Fields are an array of properties comprising a name and value pair that you can add to rules to help identify them for specific development purposes such as indicating a theme, a change order number, a person who requested the change, and so on. You can associate Custom Fields with any unlocked rule and later search for rules that contain a specified name and value pair.

Process Commander provides a wizard that enables you to search for rule instances by Custom Field names and to create a list view report. You access the wizard by selecting the menu item View > Rules > Find by a Custom Field. By default, the wizard searches rule types that belong in the Decision category. The report displays the list of items categorized by class.

To meet your specific reporting requirements, you can also use instances of the list view rules in the Index-CustomFields class to create and customize reports of Custom Fields. Instances of Custom Rule properties correspond to instances of the Index-CustomFields class within the pr_index_customfields database table. For reporting purposes, you must expose properties as columns when you create Custom Rules.

This article presents an example that shows how to create Custom Field properties, expose them in the pr_index_customfields table, and create a list view report.



Suggested Approach

In this example, you will do the following:

  1. Create a Custom Field property called ProjectID and add it to a rule.
  2. Expose the new Custom Field property as a column in the table pr_index_customfields.
  3. Create a list view rule for Custom Fields, configure the rule, and run the report


To create a Custom Field and add it to a rule:

    1. Open a rule instance to which you want to add your Custom Field.
    2. On the History tab, click the Update button. The Custom Fields editor appears as shown here:

    1. Click Add Field. The New Field section appears.
    2. Enter “ProjectID” in the Name field  and enter a “1” in the Value field as shown here:


    1. Click Add. The Custom Field and its value appear in the editor.
    2. Click Apply in the editor. The field name and value appear in the rule form as shown here:

  1. Save the rule instance. Process Commander automatically creates instances of properties Embed-CustomFields and Index-CustomFields using the key ProjectID.
  2. Use the History tab and Custom Fields editor as described above to add ProjectID to other rules. Note that you can select ProjectID from the Name pull-down list in the editor.


To expose the ProjectID property:

    1. Select menu item Tools > Database > Modify Database Schema to open the View/Modify Database Schema wizard.
    2. In the Select a Database step, select the PegaRULES database and click Next.
    3. In the Select a Table step, select pr_index_customfields from the drop-down list and click Next.
    4. In the View Table step, select the number of properties link in the Set to be visible field as shown here:


    1. In the View Properties step, check the ProjectID property as shown here:

    1. Select Generate SQL Code (if a database administrator must make the table change) or Generate Database Columns (if you can make the change) and click Create selected columns.

When you generate the database columns, a confirmation appears

  1. Click Close.

To create a list view rule for Custom Fields and run the report:

    1. Create a list view rule with Index-CustomFields as the Applies To key part.   Set the second key part to a name of your choice.  Typically, set the third key part to “All”.  The List View rule form appears.
    2. Enter the criteria you want to use to configure your report. In this example, you want to:
  • Include ProjectIDs with values of 2 through 5
  • Include, for each item, the RuleSet, version, class, rule instance key, operator who created the instance, and update date and time
  • Categorize the report by ProjectID

Here is the

Display Field

    1. s tab in which you specify the fields and labels that are displayed in the report:


    1. Here is the


    1. tab in which you specify the range of Project IDs and the report content:


    1. Here is the Categorize By array on the


    1. tab in which you specify ProjectID as the report category:


    1. When you finish configuring the list view rule, save it.
    2. Click the Run toolbar tool to execute the list view report . Here is the report:


Pega Platform 7.1.1 - 7.4 Reporting Financial Services Healthcare and Life Sciences Insurance Communications and Media Government Healthcare and Life Sciences Consumer Services Consumer Services Manufacturing Consumer Services

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us