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

class EnsLib.RecordMap.Operation.ComplexBatchFileOperation extends EnsLib.RecordMap.Operation.ComplexBatchStandard

Business Operation to write ComplexBatch data out to files on disk. Note that this operation uses a temporary file while writing out the ComplexBatch, and transmits the temporary file when 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 %Persistent

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner ComplexMap DeferResponse
FailureTimeout Filename IOLogEntry InactivityTimeout
NoFailWhileDisconnected OpenMode QueueCountAlert QueueWaitAlert
ReplyCodeActions Retry RetryCount RetryInterval
SendSuperSession SuspendMessage 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 DeferResponse EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetCharEncoding
GetDeferredResponseToken GetMessageList GetMsgHdrRequestKey GetProductionSettingValue
GetProductionSettings GetPropertyConnections GetSettings GetShadowInstance
GetTempStream IncludeSuperSession NewIOLogEntry OnError
OnFailureTimeout OnGenerateSuperSession OnGetConnections OnGetReplyAction
OnInit OnKeepalive OnMessage OnMonitor
OnProductionStart OnProductionStop OnTearDown ProcessTempStream
PutBatch QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync

Subclasses
EnsLib.RecordMap.Operation.ComplexBatchFTPOperation

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 ComplexBatch to. May include timestamp specifiers. If present, the %f specifier will be replaced with the value of the ComplexBatch object's %Source property stripped of characters illegal in filenames.
See the documentation for the CreateTimestamp() method in Ens.Util.File for more detailed 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 ProcessTempStream(pTempStream As %IO.FileStream, pBatch As EnsLib.RecordMap.ComplexBatch) 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.