human-readable-change-history
Web icon

Human Readable Change History

Stable version 2.0.10 (Compatible with OutSystems 11)
Other versions available for 10 and Older
Uploaded on 7 Jul by 
4.6
 (24 ratings)
human-readable-change-history

Human Readable Change History

Documentation
2.0.9

Create human-readable audits by simply supplying the changed record(s). Example: Name changed from 'John' to 'Peter' Age defined to '32' Country changed from 'England' to Portugal'


Table of Contents

  • Scenarios
  • Modules
  • Extensions
  • Actions
  • Site Properties
  • Translations


Scenarios

  • Audit records must be kept which identify changes to entities.
  • Two entities of the same type must be compared to identify differences.


Modules

DiffEntityDataToText exposes the RecordDifferences action which identifies the changes between two entities of the same type.


Extensions

AutoEntityDiff is an extension internal to this component which performs the comparison between entities.


Actions

RecordDifferences

Provides a textual description of changes to a record, with entity reference introspection.

In Parameters

OriginalRecord (Object) The entity prior to a change. Use ToObject(TheEntity). Must be an entity, may not be a structure. (Starting in version 2.0.3) When creating an entity, set this parameter to NullObject().

ChangedRecord (Object) The entity prior to a change. Use ToObject(TheEntity). Must be of the same type as OriginalRecord. (Starting in version 2.0.3) When deleting an entity, set this parameter to NullObject().

AttributesToIgnore (Text) Comma-separated list of entity attributes to be ignored (audit fields, for example)

EntityNameToTranslate (Text) When only 1 entity, the EntityNameToTranslate must be filled in.

IsIgnoreIdAttribute (Boolean) Does the ID attribute needs to be ignored? Default value: True

EntityLabelsList (Text) List of entity labels, to use in ENTITY translation, in the format ENTITY:EntityLabel,ENTITY2:EntityLabel2

Locale (Text) The locale used for translating the log lines (now only pt-PT or it will be english)

Out Parameters

WhatChangedText (Text) The HTML description of what changed.  Values are highlighted with <b></b> HTML tags. Each change description is separated by a <br /> HTML tag.

eg Name changed from <b>'John'</b> to <b>'Peter'</b><br />Age defined to <b>'32'<b><br />Country changed from <b>'England'</b> to <b>'Portugal'</b>


Site Properties

CacheInvalidated (DateTime)

IdentificationEntityAttributes_Exceptions (Text) Attributes which can be used to identify the referenced record, for special cases, which is evaluated before other options

Defaults to "".

IdentificationEntityAttributes_First (Text) Attributes which can be used to identify the referenced record.

Defaults to "nome,name,Nome,Name,NOME,NAME"

IdentificationEntityAttributes_Second (Text) Attributes which can be used to identify the referenced record.

Defaults to "descricao,description,Descricao,Description,DESCRICAO,DESCRIPTION"

IdentificationEntityAttributes_Third (Text) Attributes which can be used to identify the referenced record.

Defaults to "codigo,code,Codigo,Code,CODIGO,CODE"


Translations

Note that specifying a translation other than the default will reduce performance.

English (default)

Portuguese, Portugal (pt-PT)