Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.FTP.PassthroughService
Private  Storage   

EnsLib.FTP.PassthroughService


class EnsLib.FTP.PassthroughService extends
Ens.BusinessService

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 1 3


Summary


This is an Ensemble Business Service class.

The associated Adapter class is EnsLib.FTP.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessError
%ProcessInputCalled %QuitTask %RequestHeader
%SessionId %SuperSession %SuperSessionCreatedBeforeSession
%WaitForNextCallInterval %WarnedLatest %isShadow
Adapter AlertGracePeriod AlertGroups
AlertOnError ArchiveIO BusinessPartner
GenerateSuperSessionID IOLogEntry InactivityTimeout
TargetConfigNames 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 %ProcessInputCalledGet
%ProcessInputCalledSet %RemoveFromSaveSet %SerializeObject %SetModified
%SuperSessionSet %ValidateObject AdapterName AssignOneSetting
CallProcessInputAsync CheckProcessInputAsyncStatus CloseIOLogEntry EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch EvalInitialExpression ForceSessionId
GenerateSuperSession GetDeferredResponseToken GetProductionSettingValue GetProductionSettings
GetPropertyConnections GetRequestClassList GetResponseClassList GetSettings
GetShadowInstance MessageHeaderHandler NewIOLogEntry OnError
OnGenerateSuperSession OnGetConnections OnInit OnKeepalive
OnMonitor OnProcessInput OnProductionStart OnProductionStop
OnTask OnTearDown PopulateSuperSession ProcessInput
PurgeProcessInputAsyncTempData QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync SendRequestSyncMultiple
acceptRequestAsync acceptRequestSync backgroundJob findCachedObject
initConfig inprocRequest makeConnections onOutsideErr
preProcessInput queueRequestAsync queueRequestSync resolveAndIndex

Subclasses
EnsLib.XML.FTPService

Parameters


• parameter ADAPTER = "EnsLib.FTP.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter CONTAINERCLASS = "Ens.StreamContainer";
• parameter SETTINGS = "TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId}";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property TargetConfigNames as %String(MAXLEN=1000);
Configuration item(s) to which to send file stream messages

Methods


• classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Return an array of connections for drawing lines on the config diagram
• method OnProcessInput(pInput As %Stream.Object, pOutput As %RegisteredObject) as %Status
Wrap the input stream object in a StreamContainer message object and send it. If the adapter has a value for ArchivePath, send async; otherwise send synchronously to ensure that we don't return to the Adapter and let it delete the file before the target Config Item is finished processing it.
• method resolveAndIndex(pDoc As %Persistent) as %Status
Initialize and perform requested validation if any