Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

EnsLib.FTP.PassthroughOperation

class EnsLib.FTP.PassthroughOperation extends Ens.BusinessOperation

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = EnsLib.FTP.OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = Filename:Basic,TempFilename;
Inherited description: 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 methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
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.

Property methods: TempFilenameDisplayToLogical(), TempFilenameGet(), TempFilenameIsValid(), TempFilenameLogicalToDisplay(), TempFilenameLogicalToOdbc(), TempFilenameNormalize(), TempFilenameSet()

Methods

method OnMessage(pRequest As Ens.StreamContainer, Output pResponse As %Persistent) as %Status
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab