Class Reference
EnsLib.SQL.Service.GenericService
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsLib] >  [SQL] >  [Service] >  [GenericService]
Private  Storage

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 5 3


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.SQL.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
AllowTruncating ArchiveIO BusinessPartner
GenerateSuperSessionID IOLogEntry InactivityTimeout
MessageClass OnlyWarnOnce TargetConfigNames
ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance NewIOLogEntry OnError
OnGenerateSuperSession OnGetConnections OnInit OnKeepalive
OnMonitor OnProcessInput OnProductionStart OnProductionStop
OnTearDown PopulateSuperSession QueueName SaveIOLogEntry
SendAlert SendDeferredResponse SendRequestAsync SendRequestSync

Subclasses
EnsLib.SQL.Service.ProcService

Parameters

• parameter ADAPTER = "EnsLib.SQL.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter SETTINGS;
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 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 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 TargetConfigNames as %String(MAXLEN=2000);
Configuration items to which to send Documents

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
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
• method OnProcessInput(pInput As %RegisteredObject, Output pOutput As %RegisteredObject) as %Status
pInput is an EnsLib.SQL.Snapshot


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.