Skip to main content

EnsLib.SQL.Service.GenericService

class EnsLib.SQL.Service.GenericService extends Ens.BusinessService

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = EnsLib.SQL.InboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter SETTINGS;
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 AllowTruncating as %Boolean [ InitialExpression = 0 ];
If the incoming data is longer than the MAXLEN of the property into which it is being set, truncate it to the MAXLEN. If set to false, an error will be thrown when the incoming data exceeds the MAXLEN of its associated property.
This is only relevant when MessageClass is set because json streams do
Property methods: AllowTruncatingDisplayToLogical(), AllowTruncatingGet(), AllowTruncatingIsValid(), AllowTruncatingLogicalToDisplay(), AllowTruncatingNormalize(), AllowTruncatingSet()
property MessageClass as %String (MAXLEN = 1000);
Message class to use in generating the request message. If this is set and the query returns a result set, query results will be set into the corresponding properties of the request message. If no MessageClass is specified, then the request message will take the form of an Ens.StreamContainer message with the Stream property containing a json string (eg. {"ID":"1","Name":"John Smith"})
Property methods: MessageClassDisplayToLogical(), MessageClassGet(), MessageClassIsValid(), MessageClassLogicalToDisplay(), MessageClassLogicalToOdbc(), MessageClassNormalize(), MessageClassSet()
property OnlyWarnOnce as %Boolean [ InitialExpression = 1 ];
Limit warnings about truncated data.
Give a warning the first time the value for a property must be truncated, but do not repeat the warning if any subsequent messages also have that same property to be truncated. This is only relevant when AllowTruncating is true and ResponseClass is set.
Property methods: OnlyWarnOnceDisplayToLogical(), OnlyWarnOnceGet(), OnlyWarnOnceIsValid(), OnlyWarnOnceLogicalToDisplay(), OnlyWarnOnceNormalize(), OnlyWarnOnceSet()
property TargetConfigNames as %String (MAXLEN = 2000);
Configuration items to which to send Documents
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()

Methods

classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Return an array of connections for drawing lines on the config diagram
method OnInit() as %Status
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pInput As %Library.RegisteredObject, Output pOutput As %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status
pInput is an EnsLib.SQL.Snapshot

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab