Skip to main content


abstract class EnsLib.RecordMap.Base

Abstract base class for classes generated to contain data fields mapped from external record formats. This is predominantly to allow for simple listing of those objects, but users may extend this class if they wish to map external data to existing classes. If the existing data is intended for inclusion in a Batch object and RECORDMAPGENERATED is set to 0, the class must define a one-to-many relationship called %ParentBatch with an inverse of Records AND an index on this property to conform to the standard Batch structures. See the documentation for the RECORDMAPGENERATED parameter for more information.

Property Inventory

Method Inventory


Parameter to indicate whether a Record class has been generated by EnsLib.RecordMap.Generator. If users wish to map data to existing classes, or ensure that the Generator does not overwrite their existing class, this parameter should be left as 0. Classes which have the parameter set to 1 are subject to updates by the RecordMap framework.
parameter XMLIGNORENULL = 0;
Ensure RecordMap classes use the default XMLIGNORENULL behaviour for XML import and export. This parameter is set to 1 in Ens.MessageBody.


property %Source as %String (MAXLEN = 2000, XMLPROJECTION = "NONE");
Name of source document or connection from which this record was created.
Property methods: %SourceDisplayToLogical(), %SourceGet(), %SourceIsValid(), %SourceLogicalToDisplay(), %SourceLogicalToOdbc(), %SourceNormalize(), %SourceSet()


method %ForceId() as %String
Returns the same value as %Id()(), but will force a new ID value if an ID hasn't been assigned yet AND the class hasn't specified a different IdKey.
FeedbackOpens in a new tab