Class EnsLib.FTP.PassthroughOperation

class EnsLib.FTP.PassthroughOperation extends Ens.BusinessOperation

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	2	1

Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.FTP.OutboundAdapter.

Request	Response
Ens.StreamContainer	%Persistent

Properties
%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	ReplyCodeActions	Retry
RetryCount	RetryInterval	SendSuperSession	SuspendMessage
TempFilename	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

Parameters

• parameter ADAPTER = "EnsLib.FTP.OutboundAdapter";

The type of adapter used to communicate with external systems

• parameter SETTINGS = "Filename:Basic,TempFilename";

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 filename (stripped of characters illegal in target filenames).
See the method Ens.Util.File.CreateTimestamp() for documentation of timestamping options.

• property TempFilename as %String(MAXLEN=1000);

Name of a temporary file to output the document(s) to. Upon completion of the upload the file with this name to the FTP server it is renamed to the name specified in the Filename setting. If this setting is blank no temporary file will be used.
May include timestamp specifiers. The %f specifier if present will be replaced with the name of the document's original source filename (stripped of characters illegal in target filenames).
See the method Ens.Util.File.CreateTimestamp() for documentation of timestamping options.

Methods

• method OnMessage(pRequest As Ens.StreamContainer, Output pResponse As %Persistent) 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