EnsLib.RecordMap.Service.Standard
abstract class EnsLib.RecordMap.Service.Standard extends EnsLib.RecordMap.Service.Base
Base class for Business Services which process streams containing data mapped to RecordMaps.Property Inventory
Method Inventory
Parameters
parameter SETTINGS = UseSingleSession,HeaderCount;
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 HeaderCount as %Integer [ InitialExpression = 0 ];
Number of prefix lines to ignore in incoming documents to permit parsing of
reports and CSV exports with column headers.
Property methods: HeaderCountDisplayToLogical(), HeaderCountGet(), HeaderCountIsValid(), HeaderCountLogicalToDisplay(), HeaderCountNormalize(), HeaderCountSet()
property RecordLength as %Integer;
If HeaderCount is non-zero and the RecordMap is fixed-width,
this property is used when calling the chunkRecord method of EnsLib.RecordMap.RecordMap
from ReadHeaders()().
Property methods: RecordLengthDisplayToLogical(), RecordLengthGet(), RecordLengthIsValid(), RecordLengthLogicalToDisplay(), RecordLengthNormalize(), RecordLengthSet()
property RecordTerminator as %String;
The Record Terminator to use if HeaderCount is non-zero.
The property is used when calling the chunkRecord method of EnsLib.RecordMap.RecordMap
from ReadHeaders()().
Property methods: RecordTerminatorDisplayToLogical(), RecordTerminatorGet(), RecordTerminatorIsValid(), RecordTerminatorLogicalToDisplay(), RecordTerminatorLogicalToOdbc(), RecordTerminatorNormalize(), RecordTerminatorSet()
property UseSingleSession as %Boolean [ InitialExpression = 0 ];
Control whether all requests from a single input source should be sent in the same session.
The default behaviour is to have each new message in its own session.
Property methods: UseSingleSessionDisplayToLogical(), UseSingleSessionGet(), UseSingleSessionIsValid(), UseSingleSessionLogicalToDisplay(), UseSingleSessionNormalize(), UseSingleSessionSet()
Methods
method OnInit() as %Status
If HeaderCount is non-zero, ensure that we correctly
initialise the RecordTerminator and RecordLength
properties for use in ReadHeaders()().
method ReadHeaders(pIOStream As %IO.DeviceStream, pTimeout As %Numeric = -1) as %Status
Method to read a certain number of header records from an incoming stream before creating objects.
method SendRequest(pRequest As %Persistent, pAsync As %Boolean = 1, Output pResponse As %ListOfObjects) as %Status
Send the generated object to the requested targets.
Inherited Members
Inherited Properties
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %OutsideCreated
- %PreserveSession
- %ProcessInputCalled
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %SuperSessionCreatedBeforeSession
- %WaitForNextCallInterval
- %WarnedLatest
- %isShadow
- Adapter
- AlertGracePeriod
- AlertGroups
- AlertOnError
- ArchiveIO
- BusinessPartner
- GenerateSuperSessionID
- IOLogEntry
- InactivityTimeout
- RecordMap
- SynchronousSend
- TargetConfigNames
- ThrottleDelay
Inherited 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()
- GetObject()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- NewIOLogEntry()
- OnError()
- OnGenerateSuperSession()
- OnGetConnections()
- OnKeepalive()
- OnMonitor()
- OnProcessInput()
- OnProductionStart()
- OnProductionStop()
- OnTearDown()
- PopulateSuperSession()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()