Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [EDI] >  [XML] >  [Service] >  [FTPService]
Private  Storage   

class EnsLib.EDI.XML.Service.FTPService extends EnsLib.EDI.XML.Service.Standard

Service to receive an XML document as a file from a remote FTP server

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.FTP.InboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BusinessPartner DocSchemaCategory
GenerateSuperSessionID IOLogEntry InactivityTimeout
ReplyMode SearchTableClass TargetConfigNames
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 EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetRequestClassList GetResponseClassList GetSettings GetShadowInstance
IOLogDiscard NewIOLogEntry OnDocumentEnd OnDocumentStart
OnError OnGenerateSuperSession OnGetConnections OnInit
OnKeepalive OnMonitor OnParsingError OnPostDocument
OnPreDocument OnProcessInput OnProductionStart OnProductionStop
OnResolveDocType OnTearDown OnValidate PopulateSuperSession
QueueName SaveIOLogEntry SendAlert SendDeferredResponse
SendReply SendRequestAsync SendRequestSync reportReply
resolveAndIndex resolveDocType standardOnProcessInput


Parameters

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

Methods

• method OnProcessInput(pFTPStream As %Stream.Object, Output pOutput As %CharacterStream) as %Status
Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).


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