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

class EnsLib.RecordMap.Service.FileService extends EnsLib.RecordMap.Service.Standard

Business Service to consume data from files using the RecordMap parsing framework.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 2 1


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.File.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BusinessPartner FatalErrors
GenerateSuperSessionID HeaderCount IOLogEntry
InactivityTimeout RecordLength RecordMap
RecordTerminator SkipRecordParsingErrors SynchronousSend
TargetConfigNames ThrottleDelay UseSingleSession

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 GetObject GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance NewIOLogEntry
OnError OnGenerateSuperSession OnGetConnections OnInit
OnKeepalive OnMonitor OnProcessInput OnProductionStart
OnProductionStop OnTearDown PopulateSuperSession QueueName
ReadHeaders SaveIOLogEntry SendAlert SendDeferredResponse
SendRequest SendRequestAsync SendRequestSync

Subclasses
EnsLib.RecordMap.Service.FTPService

Parameters

• parameter ADAPTER = "EnsLib.File.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter SETTINGS = "FatalErrors,SkipRecordParsingErrors";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property FatalErrors as %String(VALUELIST=",Any,ParseOnly") [ InitialExpression = "Any" ];
An error saving an individual Record, such as a validation error, will be treated as fatal and end the processing of the message when the setting is "Any".
If "ParseOnly" is selected, errors when saving individual Records will not be treated as fatal, and parsing of the message will continue after logging an error log and skipping the errored record.
If AlertOnError is enabled, an alert will be sent for a save error when "ParseOnly" is selected.
The default is "Any".
• property SkipRecordParsingErrors as %Boolean [ InitialExpression = 0 ];
By default errors parsing data into a record such as ErrQuoteCharMismatch will be treated as fatal and end the processing of the message.
These parsing errors are those detected before the record is saved.
If this setting is enabled, errors when parsing the data into a record before saving is attempted will not be treated as fatal, no attempt will be made to try to save the record and parsing of the message will continue.
Note the record data may become out of alignment.
If this setting is enabled and AlertOnError is enabled, an alert will be sent when such an error is encountered.

Methods

• method OnProcessInput(pInput As %Stream.Object, Output pOutput As %RegisteredObject, ByRef pHint As %String) as %Status
Parse the incoming file and send the resulting objects to the targets in TargetConfigNames.


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