How to enable field-level auditing for a Constellation based application

User Experience Knowledge Share
, , , , , , , ,
1

Important Note: Field-level auditing is included automatically in 24.1 or higher and these changes described below are no longer needed - see one of the reply below for more details: FLA support in 24.1 - see Field-level auditing in Constellation and documentation update: Enabling field-level auditing.

Field-level auditing is an important feature of a typical workflow application - Field-level auditing is done in the case management layer and records any changes applied to a certain set of properties.

For more details on field-level auditing Pegasystems Documentation

demo.png
demo.png1466×888 112 KB

This functionality is available for Traditional UI on Theme Cosmos or UI-Kit and uses a drill down approach to view the embedded data properties that have changed - While the UI is intuitive to use, it does not offer the ability to easily group and filter by property name when you have a lot of embedded data.

demo fla in theme cosmos.png
demo fla in theme cosmos.png1685×834 121 KB

The document showcases how to add similar functionality on a Pega 8.8 application running on Constellation UI. The RAP attached to this document contains a ruleset FLA-Audit:01-01 that will provide a data page called D_FieldHistory to get the field-level changes and 2 views (FLAList and FLATimeline) to use in your case view.

FLAAudit rules.png
FLAAudit rules.png1421×280 18.9 KB

The ruleset also contains 7 properties set as relevant record at the FLAudit- class

flaaudit product.png
flaaudit product.png653×676 31.1 KB

For more details on how the functionality works in Theme-Cosmos and how to enable it in Constellation UI - you can watch the embedded video

Here is a screenshot of the functionality in Constellation UI

FLA audit product.png
FLA audit product.png1883×874 139 KB

Note: In the video - the table is refreshed using a browser refresh but it is possible to provide a ‘click to refresh’ action that will let the user know that the data are outdated and the list view needs to be refreshed - to enable this functionality - you need to call the activity ‘pxC11NPublishDatapageUpdate’ in the FLAudit-.Save activity.

refresh field history.png
refresh field history.png1313×453 39.9 KB

For more details on how to notify users to refresh an outdated List View in Constellation UI - How to notify users to refresh an outdated List View in Constellation UI | Support Center

History:

  • 1.0 - 9/2023 - Initial version of the functionality

  • 1.1 - 1/3/2024 - Fix bug with embedded page - condition on step 9.2 of the GetFieldGroupHistory has a typo on the condition for page

  • 1.2 - 2/15/2024 - Updated the zip file RAP to also include the 7 relevant record properties needed at FLAudit-

FLAudit.zip (55.6 KB)

2

@RichardMarsot very nice article.

3

@RichardMarsot very nice one.

4

@RichardMarsot This is great, many thanks for providing this asset!

5

Note that this feature is now included OOB in 24.1 or higher and this ruleset are no longer needed. see Field-level auditing in Constellation and documentation update: Enabling field-level auditing.

To enable FLA in Constellation

1/ Enable FLA in the case settings - set the fields to track

2/ Add the view ‘Field history’ to the history view

FLA view.jpg
FLA view.jpg1030×1144 106 KB

3/ You should see the FLA at runtime grouped by field name

grouped FLA.png
grouped FLA.png3696×1858 601 KB

6

@RichardMarsot This is great, much helpful.