abstract class Ens.Adapter
extends %RegisteredObject, Ens.Settings
Base class for adapters that communicate with external applications
This is the credentials object containing the values to be used to access the datasouce
as %Boolean [ InitialExpression = 0,Transient ];
Flag whether we have already warned about the class being recompiled
This is the ID name of the set of credentials values to be used to access the external system
as %Numeric [ InitialExpression = 0 ];
Frequency with which to wake up and call OnKeepalive() method
(not supported for InProc Operations)
ID of External Service Registry entry
Leave blank if you are not using the external registry
This will be used to find values to be applied to the Adapter and Host settings
classmethod ClearAllAppData(pConfigName As %String)
Clear both static and runtime App Data
classmethod ClearRuntimeAppData(pConfigName As %String)
Clear runtime data for a config item. This is normally used to store
adapter error status for input files, and is cleared automatically
each time the item restarts.
classmethod ClearStaticAppData(pConfigName As %String)
Clear static data for a config item. This is normally used to store
already-processed status for input files, and other persistent values related
to adapters, such as the %LastId for the SQL Inbound Adapter.
method CredentialsSet(pInVal As %String)
This is a Set accessor method for the Credentials property.
This user callback method is called just after %OnNew()
method OnKeepalive(pStatus As %Status = $$$OK)
This method is called from the Host.OnTask() method. It will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive().
This user callback method is called just before %OnClose()