Rule Action parameter in the History-Add Method
Hello.
So I've been trying to use the History-Add Method to add custom entries in the audit trail.
And I'm wondering about the Rule Action parameter defined for this Method: what's the use of that?
I can specify a value here that I was expecting to be able to retrieve later on in the properties of the history/audit trail entries found in the results of the D_pyWorkHistory Data Page. But... no luck here.
There is indeed a pxRuleAction Property defined in the History- class so I was expecting to get my values back there.
But:
- the Report Definition(s) feeding the D_pyWorkHistory Data Page are not listing this Property in the Columns
- and additionnaly it seems this Property is not even exposed... while there is no blob definedf for the History- classes.
So what? The vlaues are lost because there is nowhere to store them?
Then what's the use having this Property? And having this parameter in the History-Add Method to begin with?
I guess I'm missing something here... Help anyone.
Thanks.
Updated: 16 Mar 2023 8:35 EDT
NCS Pte. Ltd
SG
Hi @POCHF: Firstly, this will work only for Rule-, Data-, Link- instances based on documentation (this). So if you are trying for a Work- instance, this value is of no use.
Even for Data- instances this seems not working in the latest version whereas it works fine in version 7. I feel this is something PEGA for look into. If you use Save activity for data class, it will work. Not because of History-Add method but because of the new saveDeferred api method of implementation.
Dear Moderators: Can this be checked internally?
Thanks.
Pegasystems Inc.
GB
@POCHF I have checked internally through our support archives. Many thanks @ArulDevan for your input here.
The snapshots for history add was indeed removed . It was turned off as a product decision. From 8.2 and later versions History-Add method won't save history snapshots. Snapshotting now only occurs during the actual save of the BLOB instead during History-Add, and this is now controlled at the Class Definition for Data classes (Rules are always snapshotted, and Work behavior remains unchanged – no snapshotting). The History-Add capability allows the user to provide a Note, but will no longer snapshot (since the BLOB doesn’t change).
Below is the response we got from product team:
Snapshotting now only occurs during the actual save of the BLOB instead during History-Add, and this is now controlled at the Class Definition for Data classes (Rules are always snapshotted, and Work behavior remains unchanged – no snapshotting).
The History-Add capability allows the user to provide a Note, but will no longer snapshot (since the BLOB doesn’t change).
https://docs.pega.com/application-development/86/omitting-history-snapshots-data-types
Q: Is it possible to store history snapshot with custom memo?
A: No, a creating a memo no longer takes a snapshot.
@POCHF I have checked internally through our support archives. Many thanks @ArulDevan for your input here.
The snapshots for history add was indeed removed . It was turned off as a product decision. From 8.2 and later versions History-Add method won't save history snapshots. Snapshotting now only occurs during the actual save of the BLOB instead during History-Add, and this is now controlled at the Class Definition for Data classes (Rules are always snapshotted, and Work behavior remains unchanged – no snapshotting). The History-Add capability allows the user to provide a Note, but will no longer snapshot (since the BLOB doesn’t change).
Below is the response we got from product team:
Snapshotting now only occurs during the actual save of the BLOB instead during History-Add, and this is now controlled at the Class Definition for Data classes (Rules are always snapshotted, and Work behavior remains unchanged – no snapshotting).
The History-Add capability allows the user to provide a Note, but will no longer snapshot (since the BLOB doesn’t change).
https://docs.pega.com/application-development/86/omitting-history-snapshots-data-types
Q: Is it possible to store history snapshot with custom memo?
A: No, a creating a memo no longer takes a snapshot.
If you wish to request a product enhancement I suggest that you contact the relevant Engineering team internally to discuss this further with a view of logging a new Discussion tagged as an 'Idea'.
NCS Pte. Ltd
SG
Thanks @MarijeSchillern.
Pegasystems Inc.
FR
@MarijeSchillern OK... it's no really about the snapshot. I was just expecting the RuleAction parameter would allow me to set a value in pxRuleAction for an audit trail entry created on a Work- so I can easily filter things out based on this value.
I'm sorry I have to say the documentation is not clear. It is NOT specifically saying that the RuleAction parameter is only avialaible when creating entries on Data-, Rule- and Liknk- and NOT on Work-. It's only saying for these first threes only a few values should be used. As it's not explicitly saying it's not relevant for Work-, one does expect for it to be actually relevant.
One other thing that is not clear: the documentation seems to imply that EITHER HistoryMemo OR Category/MesageKey (thus identifying a Field Value rule) can be used but not both. And actually you can use both: one is valuing pyMemo the other pyMessageKey.
Coforge
IN
RuleAction Parameter is used to characterize the action for which history audit is recorded.
For example: Save, New, Save As, Delete etc. (These can be seen in the "view full history" in history tab of a rule)
You are correct the value of this param get stored in pxRuleAction property of History-Class.
You can refer its use case in the pega OOTB activities like "DeleteRule". You can run the RD from History-Rule class to check the value in pxRuleAction