Home > Class Reference > ENSLIB namespace > EnsLib.MsgRouter.VDocRoutingEngine

EnsLib.MsgRouter.VDocRoutingEngine

persistent class EnsLib.MsgRouter.VDocRoutingEngine extends EnsLib.MsgRouter.RoutingEngine

SQL Table Name: EnsLib_MsgRouter.VDocRoutingEngine

Parameters

parameter SETTINGS = Validation:Basic;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property DocName as %String) [ Transient ];
Property methods: DocNameDisplayToLogical(), DocNameGet(), DocNameIsValid(), DocNameLogicalToDisplay(), DocNameLogicalToOdbc(), DocNameNormalize(), DocNameSet()
property DocType as %String (MAXLEN = 128) [ Transient ];
Property methods: DocTypeDisplayToLogical(), DocTypeGet(), DocTypeIsValid(), DocTypeLogicalToDisplay(), DocTypeLogicalToOdbc(), DocTypeNormalize(), DocTypeSet()
property Validation as %String (MAXLEN = 20) [ InitialExpression = "m" , Transient ];
String specifying types of Validation to perform

Set to 1 to block documents that don't pass default validation. Default validation checks for DocType assignment and successful BuildMapStatus.

This is equivalent to 'dm'
'd' - require DocType
'm' - require successful BuildMap status

Property methods: ValidationDisplayToLogical(), ValidationGet(), ValidationIsValid(), ValidationLogicalToDisplay(), ValidationLogicalToOdbc(), ValidationNormalize(), ValidationSet()

Methods

classmethod GetRequestClassList() as %String
classmethod GetResponseClassList(pRequest As %String = "") as %String
method OnConstructReply(Output pReplyDoc As Ens.VDoc.Interface, pOriginalDoc As Ens.VDoc.Interface, ByRef pSC As %Status) as %Status
Override this method to construct a customized reply document. Inputs are the original document and the status code that the framework produced in processing the original document. If you change the status code but do not construct a reply document, the framework will use the new value to construct a standard reply document.
method OnPrepareReply(request As %Persistent, ByRef response As %Persistent)
method OnRequest(request As %Persistent, Output response As %Persistent) as %Status
Inherited description: Handle a 'Request'
method OnValidate(pDoc As %Persistent, pValSpec As %String, Output pStatus As %Status = $$$OK) as %Boolean
Override this method to implement your own method for validating a Document Return non-zero to prevent default validation of the message(if any); return an error code in pStatus to indicate a validation failure.

Inherited Methods

%AddToSaveSet() %NormalizeObject() EnumerateSettingsFetch()
%AddToSyncSet() %ObjectIsNull() GenerateSuperSession()
%BMEBuilt() %ObjectModified() GetDeferredResponseToken()
%CheckConstraints() %Oid() GetDelegateConnections()
%CheckConstraintsForExtent() %OnBeforeAddToSync() GetProductionSettingValue()
%ClassIsLatestVersion() %OnClose() GetProductionSettings()
%ClassName() %OnDetermineClass() GetPropertyConnections()
%ComposeOid() %OnNew() GetSettings()
%ConstructClone() %Open() GetShadowInstance()
%Delete() %OpenId() IsErrorResponse()
%DeleteExtent() %OriginalNamespace() IsResponsePending()
%DeleteId() %PackageName() OnComplete()
%DispatchClassMethod() %PhysicalAddress() OnError()
%DispatchGetModified() %PurgeIndices() OnFailureTimeout()
%DispatchGetProperty() %Reload() OnGenerateSuperSession()
%DispatchMethod() %RemoveFromSaveSet() OnGetConnections()
%DispatchSetModified() %ResolveConcurrencyConflict() OnGetReplyAction()
%DispatchSetMultidimProperty() %RollBack() OnInit()
%DispatchSetProperty() %Save() OnKeepalive()
%Exists() %SaveDirect() OnMonitor()
%ExistsId() %SaveIndices() OnProductionStart()
%Extends() %SerializeObject() OnProductionStop()
%GUID()