Back Forward Working with the rule History Details display

The  History Details   button on the History tab of a rule form displays the history of the rule. The system converts dates and times from the internal UTC format to your time zone.

Field and Property

Description

Pencil When present, indicates that an earlier version of this rule is available.
Time
pxTimeCreated
Date and time of the history event.
Memo
pyMemo
Text describing the event for this history line. Optionally, the security text can be generated by the security audit feature.
Updated By
pxAddedbyID
Operator ID of the person who added this history event. Click this link to view, in a new window, the reporting structure of this operator (as defined by the Reports to field on the Operator tab of the Operator ID form).
 Add Memo  

Click to access a free-form text field. The text you enter becomes part of the history.

History for All Versions  

Click to see the history of this rule and also of lower-numbered and higher-numbered versions. The display shows the history of this rule and the history of other lower or higher versions in which this rule exists (with the same name, RuleSet, and circumstance qualification if any.)

After you click this button, the button label changes to let you return to the original display, showing the history of only one version. For example, if the History Details window is initially opened for a rule in version 05-01-05, the label on the button becomes "History of Version 05-01-05".

This button does not appear for Class rules (Rule-Obj-Class rule type) and a few other rule types. Class rules have an associated version field, but do not belong to a single specific RuleSet version.

 History of Version NN-NN-NN  

Click to return to the original display, showing only the history of this open rule.

Reviewing the saved history of this rule

To review the saved history for this rule, click  History For All Versions  . The History section of the pop-up window refreshes and identifies the version number associated with each rule. This display includes the history of this rule plus the history of lower- and higher-numbered versions.

For qualified rules, the display shows all versions of rules that also match the qualifications of this rule (circumstance property, circumstance date, start date, and end date).

Adding a memo

Enter text in the Add Memo field, then click  Add Memo   to add the text to the memo area in the top part of the form. This text becomes part of the history.

Restoring an older version (for RuleSets that use check-out)

If the check-out capability applies to the RuleSet containing this rule instance, click the pencil icon (Pencil) in the row below the history line of interest to see an older, historical copy of this rule instance. If required, you can then use the Restore toolbar button (Restore) to make the older copy become the current copy. This accomplishes a type of "undo." See How to restore an earlier copy of a rule after check-in.

Security audit feature

If your application implements the optional security audit feature, the History Details display can identify which values were added, updated, or removed from a rule or data object. See How to enable security auditing for rule or data changes.

Notes

If this rule was imported from another Process Commander system using the Import Archive facility, the history details display reflects only those changes made after the imported rule arrived in this Process Commander system.

The system saves rule history details as instances of the History-Rule class. By default, instances of the History-Rule class correspond to rows in the pr4_history_rule database table.

Related topics How to complete and use the History tab of a rule form
How to enable security auditing for rule or data changes

UpDeveloper portal basics