Class EnsLib.EDI.XML.Operation.FTPOperation

class EnsLib.EDI.XML.Operation.FTPOperation extends EnsLib.EDI.XML.Operation.Standard

Operation to send an XML document as a file to a remote FTP server

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	2	2

Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.FTP.OutboundAdapter.

Request	Response
EnsLib.EDI.XML.Document	EnsLib.EDI.XML.Document

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

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	OnValidate	QueueName	SaveIOLogEntry
SendAlert	SendDeferredResponse	SendRequestAsync	SendRequestSync
validateAndIndex

Parameters

• parameter ADAPTER = "EnsLib.FTP.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 = "%f_%Q",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.

Methods

• method OnInit() as %Status

This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()

• method OnMessage(pRequest As EnsLib.EDI.XML.Document, Output pResponse As EnsLib.EDI.XML.Document) as %Status

This is the default message handler. All request types not declared in the message map are delivered here

Class Reference IRIS for UNIX 2024.1.2
Documentation Search