Skip to main content


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

Enabling field-level auditing

Updated on May 11, 2022

Maintain case compliance and follow progress in your case types by enabling field-level auditing. When you enable fields for auditing, users of your application can conveniently track how values have changed, such as an estimated end date, so that they can plan and process work more efficiently.

Before you begin: Mark as relevant properties that are required for auditing. For more information, see Marking a record as relevant.
When you enable field-level auditing, your application tracks changes that users make to fields in the data model that your case contains. Users of your application can then check previous and current field values, the last user to change the values, and the time of their modification.

For relevant training materials, see the Tracking and auditing changes to data module and Auditing changes to the value of fields challenge on Pega Academy.

Note: Only standard Pega Platform applications support field-level auditing. Applications that you build on Cosmos React do not support this feature.
  1. In the navigation pane of App Studio, click Case types, and then click the case type that you want to open.
  2. In the case working area, click the Settings tab.
  3. In the settings pane, click Auditing.
  4. In the Auditing window, turn on the Enable field audit switch.
  5. In the Fields column, select the checkboxes next to the fields that you want to enable for auditing.
    Note: Field-level auditing does not support data reference, page group, value group, and value list field types.
    Note: If an application tracks changes in an embedded data field and the scope of the changes is greater than 66%, the application recognizes the changes as delete an add actions, and displays relevant audit information.
  6. If you want to enable fields in an embedded data field, click the name of the field, and then repeat step 5.
  7. Click Save.
Result: At run time, when users process the case, they see the changes to the fields on the Audit tab.
What to do next:
  • Maintain the good quality of field-level auditing and troubleshoot errors by checking the pzStandardProcessor queue processor in Admin Studio.
  • Continue working on your field-level auditing data after you deploy your application on another system by packaging the appropriate rules and data. For more information, see Packaging rules and data that contain field-level auditing information.

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us