Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.RecordMap.Operation.FileOperation
Private  Storage   

EnsLib.RecordMap.Operation.FileOperation


class EnsLib.RecordMap.Operation.FileOperation extends
EnsLib.RecordMap.Operation.Standard

Business Operation to write RecordMap data out to files on disk. Note that this operation is not designed to run in multiple processes.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 1


Summary


This is a Business Operation class.

The associated Adapter class is EnsLib.File.OutboundAdapter.

RequestResponse
%Persistent Ens.Response

Properties
%ActionHint %AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError %QuitTask
%RequestHeader %SessionId %SuperSession %WarnedLatest
%isShadow Adapter AlertGroups AlertOnError
AlertRetryGracePeriod ArchiveIO BusinessPartner DeferResponse
FailureTimeout Filename IOLogEntry InactivityTimeout
NoFailWhileDisconnected QueueCountAlert QueueWaitAlert RecordMap
ReplyCodeActions Retry RetryCount RetryInterval
SendSuperSession SuspendMessage ThrottleDelay

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnClose
%OnNew %OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetModified %SuperSessionSet %ValidateObject
AdapterName AssignOneSetting CloseIOLogEntry DeferResponse
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch EvalInitialExpression
GenerateSuperSession GetDeferredResponseToken GetMessageList GetProductionSettingValue
GetProductionSettings GetPropertyConnections GetRequestClassList GetResponseClassList
GetSettings GetShadowInstance IncludeSuperSession MessageHandler
MessageHeaderHandler NewIOLogEntry OnError OnFailureTimeout
OnGenerateSuperSession OnGetConnections OnGetReplyAction OnInit
OnKeepalive OnMessage OnMonitor OnProductionStart
OnProductionStop OnTask OnTearDown PutObject
QueueName SaveIOLogEntry SendAlert SendDeferredResponse
SendRequestAsync SendRequestSync SendRequestSyncMultiple acceptRequestAsync
acceptRequestSync doReplyAction finalReplyAction findCachedObject
initConfig inprocRequest makeConnections queueRequestAsync
queueRequestSync

Subclasses
EnsLib.RecordMap.Operation.FTPOperation

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 OnMessage(pObject As %Persistent, pResponse As Ens.Response) as %Status
This is the default message handler. All request types not declared in the message map are delivered here