Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [RecordMap] >  [Operation] >  [BatchFileOperation]
Private  Storage   

class EnsLib.RecordMap.Operation.BatchFileOperation extends EnsLib.RecordMap.Operation.BatchStandard

Business Operation to write RecordMap batch data out to files on disk. Note that this operation uses a temporary file while writing individual records to the batch, and writes the contents of the temporary file to disk when the batch output is complete.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 2


Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.File.OutboundAdapter.

RequestResponse
%Persistent EnsLib.RecordMap.BatchResponse

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner DefaultBatchClass DeferResponse
DelayDefaultBatchOutput FailureTimeout Filename IOLogEntry
InactivityTimeout IntermediateFilePath NoFailWhileDisconnected OpenMode
QueueCountAlert QueueWaitAlert ReOpenMode RecordMap
ReplyCodeActions Retry RetryCount RetryInterval
RolloverLimit RolloverSchedule SendSuperSession SuspendMessage
ThrottleDelay UnSwizzleRecords UseDefaultBatch WriteEmptyBatches

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 CheckRollover CloseIOLogEntry CreateDefaultBatch
DeferResponse EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
GenerateSuperSession GetCharEncoding GetDefaultBatch GetDeferredResponseToken
GetMessageList GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance GetTempFilename
IncludeSuperSession NewIOLogEntry OnError OnFailureTimeout
OnGenerateSuperSession OnGetConnections OnGetReplyAction OnInit
OnKeepalive OnMessage OnMonitor OnProductionStart
OnProductionStop OnTearDown ProcessTempFile PutBatch
PutObject PutRecord QueueName SaveIOLogEntry
SendAlert SendDeferredResponse SendRequestAsync SendRequestSync
SwitchDefaultBatch TriggerRollover UpdateRolloverTime

Subclasses
EnsLib.RecordMap.Operation.BatchFTPOperation

Parameters

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

Properties

• property Filename as %String(MAXLEN=1000,MINLEN=1) [ InitialExpression = "%Q",Required ];
Name of file to output the document(s) to. May include timestamp specifiers. If present, the %f specifier will be replaced with the name of the document's original source stream (stripped of characters illegal in filenames).
See the method Ens.Util.File.CreateTimestamp() for documentation of timestamping options.

Methods

• method GetCharEncoding() as %String
Return the expected character encoding to use for the output. The Batch operation uses a temp file to store data prior to writing out the end of the batch, and we need to know what encoding we should use to match the final output encoding. For this operation, the encoding is a setting of the adapter.
• method ProcessTempFile(pTempFile As %IO.FileStream, pBatch As EnsLib.RecordMap.Batch) as %Status
Let the adapter take responsibility for writing out the temporary file.


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