Skip to main content

%pkg.isc.changehistory.abstract

abstract persistent class %pkg.isc.changehistory.abstract extends %Library.Persistent, %pkg.isc.json.adaptor

SQL Table Name: %pkg_isc_changehistory.abstract

Base abstract class to extend for configuration classes that want to be enabled for change history tracking.

Method Inventory

Parameters

parameter ChangeHistoryJsonExportMapping;
Override to specify a JSON mapping to use (leave empty for default mapping). This mapping will be used to serialize the object state into JSON for storage in the change history log.
This mapping MUST export all persistent properties as IDs to ensure diffs from related objects aren't included in change history for this object. If the mapping does not match this criteria, an error will be thrown during compilation.
If not using default json mapping for something else already, setting %JSONREFERENCE to 'ID' is recommended. @API.Overrideable

Methods

abstract classmethod CheckPermissionOnChangeHistoryFeature() as %Boolean
Checks if the current user has permission to view change history records for this configuration table. Subclasses implement this by checking the security resource(s) required to manage the configuration that this change history tracks. MUST be overridden in subclasses
Return 1 if the user has permission, 0 if not.
  ClassMethod CheckPermissionOnChangeHistoryFeature() As %Boolean
  {
      Return $System.Security.Check("%MyConfigManagement", "R")
  }
  
@API.Overrideable
abstract classmethod GetChangeHistoryFeatureName(pLocalize As %Boolean) as %String
Returns a unique human readable, name for the feature this persistent table represents. MUST be overriden in subclasses.
@Argument pLocalize When this is set to 1, the returned string should be localized vs 0 where it should not be localized so it can be used for indexing.

Triggers

trigger RecordChangeHistoryDelete (BEFORE event DELETE);
Add event to change history for delete events
trigger RecordChangeHistoryInsert (AFTER event INSERT);
Add event to change history for insert events
trigger RecordChangeHistoryUpdate (BEFORE event UPDATE);

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab