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

EnsLib.File.PassthroughService


class EnsLib.File.PassthroughService extends
Ens.BusinessService

Accepts files from the File Inbound Adapter, encapsulates each one as a Stream object within a StreamContainer object and forwards the container object to the configured target configuration item or items.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 1 4


Summary


This is a Business Service class.

The associated Adapter class is EnsLib.File.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 GenerateSuperSessionID
IOLogEntry InactivityTimeout TargetConfigNames
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 EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetProductionSettingValue GetProductionSettings GetPropertyConnections GetSettings
GetShadowInstance NewIOLogEntry OnError OnGenerateSuperSession
OnGetConnections OnInit OnKeepalive OnMonitor
OnProcessInput OnProductionStart OnProductionStop OnTearDown
PopulateSuperSession QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync removeStreamFromInput
resolveAndIndex

Subclasses
EnsLib.XML.FileService

Parameters


• parameter ADAPTER = "EnsLib.File.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 removeStreamFromInput(pInput As Ens.StreamContainer) as %Status
This method is called if the actual input file pointed to by the request object will be deleted by the Adapter.
It requires the request object (CONTAINERCLASS parameter) to be Ens.StreamContainer
It also requires the Adapter to be the EnsLib.File.InboundAdapter.
If this class has been subclassed to override CONTAINERCLASS or the adapter it may be necessary to override this method and act accordingly.
• method resolveAndIndex(pDoc As %Persistent) as %Status
Initialize and perform requested validation if any