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

class EnsLib.XML.Object.Operation.FTPOperation extends EnsLib.XML.Object.Operation.FileOperation

EnsLib.XML.Object.Operation.FTPOperation is the FTP based operation class which writes an XML document based on a persistent object.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1


Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.FTP.OutboundAdapter.

RequestResponse
%Persistent %Persistent

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO AttributeQualified BusinessPartner Charset
DefaultNamespace DeferResponse ElementQualified ExpectedClassName
FailureTimeout Filename Format IOLogEntry
InactivityTimeout Indent IndentDepth Namespace
NoFailWhileDisconnected NoXMLDeclaration QueueCountAlert QueueWaitAlert
ReferencesInline ReplyCodeActions Retry RetryCount
RetryInterval RootElementName RuntimeIgnoreNull SendSuperSession
SuppressXmlns 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 GetDeferredResponseToken
GetMessageList GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetSettings GetShadowInstance IncludeSuperSession
NewIOLogEntry OnError OnFailureTimeout OnGenerateSuperSession
OnGetConnections OnGetReplyAction OnInit OnKeepalive
OnMessage OnMonitor OnProductionStart OnProductionStop
OnTearDown QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync SetProperties
standardOnMessage


Parameters

• parameter ADAPTER = "EnsLib.FTP.OutboundAdapter";
The type of adapter used to communicate with external systems

Properties

• property Filename as %String(MAXLEN=1000,MINLEN=1) [ InitialExpression = "%f_%Q.xml",Required ];
Name of file to output the document(s) to. May include timestamp specifiers. The %f specifier if present 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.


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