Skip to main content


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

The extension point for field-level auditing

Updated on June 14, 2022

You can override the extension point for field-level auditing to facilitate reporting. For example, you can include the index keys of the audited properties in the audit table.

The extension point that you can use for field-level auditing in Pega Platform version 8.4 and later is the pySave activity from the FLAudit- class.

To learn how you can benefit from modifying the extension point for field-level auditing, see the following article with a sample use case:

Displaying the index keys of properties in the field-level auditing layout

Increase the readability of the field-level auditing layout by adding a column that displays the index keys of your audited properties of the Page List and Page Group types. When you expose the index column inside the section that is displayed for a property of the Page List and Page Group type, you can differentiate between the list items more conveniently.

  1. Create and configure a property to represent the key of audited properties:
    1. Create a property with the IndexKey name and of the Text date type in the FLAudit- class in any of the application rulesets.
    2. On the new property form, in the Additional configuration options section, select the Optimize for reporting and Optimize for reporting on descendant classes checkboxes.
    For more information, see Optimize a property from the user interface and the Optimizing properties for report performance challenge on Pega Academy.
    Result: The IndexKey property is now configured to support a new column for presenting key values:
    The IndexKey property
    The IndexKey property configuration.
  2. Override an extension activity to set the IndexKey property:
    1. Expand the Technical category, and then click Activity.
    2. Find and open the pySave activity from the FLAudit- class.
    3. On the activity form, click Save As.
    4. On the new activity form, in the Apply to (class) field, select the class that you created for the case type in the FLAudit- class.
    5. In the Add to ruleset field, select the application ruleset that contains the selected class.
    6. Click Create and open.
    7. On the Steps tab, in the Method field, select a method, and then click Expand to see method parameters.
      The activity references Param.ContextPage as the work page and the FLA record as the step page.
      For example: For the Property-Set method, in the Method Parameters section, in the PropertiesName field, select .IndexKey, and then, in the PropertiesValue field provide a temporary string value, as shown in the following figure:
      The pySave activity configured to enable setting the IndexKey property value
      The pySave activity configured to enable setting the key value.
    8. Click Save.
  3. Override a report definition that derives records from the FLAudit table:
    1. Expand the Reports category, and then click Report Definition.
    2. Find and open the pyGetRecordsByContext report definition from the FLAudit- class.
    3. On the report definition form, click Save As.
    4. On the new report definition form, in the Apply to (class) field, select the class that you created for the case type in the FLAudit- class.
    5. In the Add to ruleset field, select the application ruleset that contains the selected class.
    6. Click Create and open.
    7. On the Query tab, click Add column, and then in the Column source field, enter .IndexKey.
    8. Click Save.
      Result: The following figure shows the .IndexKey property added to the overridden report definition:
      The overriden pyGetRecordsByContext report definition
      The overriden pyGetRecordsByContext report definition.
  4. Include the new property in the table section that displays the FLA records:
    1. Expand the User Interface category, and then click Section.
    2. Find and open the pyFieldGroupHistory section from the @baseclass class.
    3. On the section form, click Save As.
    4. On the new section form, in the Apply to (class) field, select the class that you created for the case type in the FLAudit- class.
    5. In the Add to ruleset field, select the application ruleset that contains the selected class.
    6. Click Create and open.
    7. On the Design tab, in the table area, click a table column, and then click Insert column after selected or Insert column before selected.
    8. Next to the new column's label area, click View properties, and then, in the Cell properties pane, in the Value field, provide the name for the column. For example, enter key.
    9. Click Submit.
    10. Next to the new column's field area, click View properties, and then, in the Cell properties pane, in the Property field, enter .IndexKey.
    11. Click Submit.
      Result:
      The .IndexKey property added to the table
      The .IndexKey property added to the table.
Result: The new property can be exposed and captured as part of field-level auditing. In the presented example, the screen captures the IndexKey value and displays the value in the field-level auditing table.
  • Previous topic Packaging rules and data that contain field-level auditing information
  • Next topic Sharing data between parent and child cases

Tags

Pega Platform 8.7 Case Management

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

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