Skip to main content


persistent class HS.Util.HSDebug extends %Library.Persistent

SQL Table Name: HS_Util.HSDebug

Class to log debug information throughout HealthShare. Activate by setting macro HSDebug in

Property Inventory

Method Inventory


property Component as %String (MAXLEN = 200);
Component where it occurred (eg class name)
Property methods: ComponentDisplayToLogical(), ComponentGet(), ComponentGetStored(), ComponentIsValid(), ComponentLogicalToDisplay(), ComponentLogicalToOdbc(), ComponentNormalize(), ComponentSet()
property DateTime as %TimeStamp;
Property methods: DateTimeDisplayToLogical(), DateTimeGet(), DateTimeGetStored(), DateTimeIsValid(), DateTimeLogicalToDisplay(), DateTimeNormalize(), DateTimeOdbcToLogical(), DateTimeSet()
property FileName as %String (MAXLEN = 200);
The file containing the stream, if any
Property methods: FileNameDisplayToLogical(), FileNameGet(), FileNameGetStored(), FileNameIsValid(), FileNameLogicalToDisplay(), FileNameLogicalToOdbc(), FileNameNormalize(), FileNameSet()
property Message as %String (MAXLEN = 200);
The message id (if any) (or oref text string like 17@User.Test)
Property methods: MessageDisplayToLogical(), MessageGet(), MessageGetStored(), MessageIsValid(), MessageLogicalToDisplay(), MessageLogicalToOdbc(), MessageNormalize(), MessageSet()
property Place as %String (MAXLEN = 200);
Description of where the log occurred (eg label + offset)
Property methods: PlaceDisplayToLogical(), PlaceGet(), PlaceGetStored(), PlaceIsValid(), PlaceLogicalToDisplay(), PlaceLogicalToOdbc(), PlaceNormalize(), PlaceSet()
property Text as %String);
The debug text, if any
Property methods: TextDisplayToLogical(), TextGet(), TextGetStored(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextSet()


classmethod %OnDelete(oid As %ObjectIdentity) as %Status
[Previously private]
classmethod Debug(Place As %String, Component As %String, Type As %String, Text As %String = "", Message As EnsLib.HL7.Message = "", Stream As %GlobalCharacterStream = "")
Place = location inside component, often label or method name Component = full name of component, e.g. "HS.Hub.HubOperataions" Type = Currently only used to provide extension for stream file Text = text to log. if >30 chars will be written to a file HSDebug.txt Message (optional) = oref of message object, if body logs the header else logs the message content as xml file Stream (optional) = oref of %CharacterStream will save the stream as file HSDebug.
classmethod Show(Device)
Display HSDebug Device="" or 0 : Display on terminal, 80-chars wide Device=: Output to with wider columns


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Util.HSDebug)

FeedbackOpens in a new tab