Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsLib.MFT.Operation.Passthrough
Private  Storage   

EnsLib.MFT.Operation.Passthrough


class EnsLib.MFT.Operation.Passthrough extends
Ens.BusinessOperation

Accepts objects of type Ens.StreamContainer and uploads to MFT Server

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 3 1


Summary


This is a Business Operation class.

The associated Adapter class is EnsLib.MFT.Adapter.Outbound.

RequestResponse
Ens.StreamContainer %MFT.ItemInfo

Properties
%ActionHint %AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError %QuitTask
%RequestHeader %SessionId %SuperSession %WarnedLatest
%isShadow Adapter AlertGroups AlertOnError
AlertRetryGracePeriod ArchiveIO BusinessPartner DefaultFilenameSpec
DefaultMFTFolder DeferResponse FailureTimeout IOLogEntry
InactivityTimeout NoFailWhileDisconnected Overwrite QueueCountAlert
QueueWaitAlert ReplyCodeActions Retry RetryCount
RetryInterval SendSuperSession SuspendMessage 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 %RemoveFromSaveSet
%SerializeObject %SetModified %SuperSessionSet %ValidateObject
AdapterName AssignOneSetting CloseIOLogEntry DeferResponse
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch EvalInitialExpression
GenerateSuperSession GetDeferredResponseToken GetMessageList GetProductionSettingValue
GetProductionSettings GetPropertyConnections GetRequestClassList GetResponseClassList
GetSettings GetShadowInstance IncludeSuperSession MessageHandler
MessageHeaderHandler NewIOLogEntry OnError OnFailureTimeout
OnGenerateSuperSession OnGetConnections OnGetReplyAction OnInit
OnKeepalive OnMessage OnMonitor OnProductionStart
OnProductionStop OnTask OnTearDown QueueName
SaveIOLogEntry SendAlert SendDeferredResponse SendRequestAsync
SendRequestSync SendRequestSyncMultiple acceptRequestAsync acceptRequestSync
doReplyAction finalReplyAction findCachedObject initConfig
inprocRequest makeConnections queueRequestAsync queueRequestSync


Parameters


• parameter ADAPTER = "EnsLib.MFT.Adapter.Outbound";
The type of adapter used to communicate with external systems
• parameter SETTINGS = ",DefaultMFTFolder:Basic,DefaultFilenameSpec:Basic,Overwrite:Basic,-SendSuperSession";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property DefaultFilenameSpec as %String(MAXLEN=1000,MINLEN=1) [ InitialExpression = "%f" ];
The OutputFilename property of the request is used as the name of file to create on the MFT Server.

If the OutputFilename property of the request is empty then this specification setting is used to generate the target filename as follows:

The %f specifier if present will be replaced with the value of the filename portion of the OriginalFilename property.

The specification may include timestamp specifiers. See the method CreateTimestamp in class Ens.Util.File for documentation of timestamping options.

An example to specify a fixed name with a date time stamp for those requests with an empty OutputFilename could be:

ImportantDocument.%Q.txt

This will create a target file name of for example ImportantDocument.2017-01-30_14.12.44.630.txt

• property DefaultMFTFolder as %String(MAXLEN=1000) [ InitialExpression = "/" ];
Name of target MFT Folder to use if the request object has an empty OutputFolder property.
The folder value will be concatenated with the target filename and hence a trailing / or other character as appropriate for the particular service is needed.
• property Overwrite as %Boolean [ InitialExpression = 1 ];
Indicate if a file on the server exists with the same name then still upload.
Default is to upload if a file with the same name exists.
The particular MFT Server may generate different versions rather than replace.

Methods


• method OnMessage(pRequest As Ens.StreamContainer, Output pResponse As %MFT.ItemInfo) as %Status
Takes an Ens.StreamContainer object and uploads the Stream to the MFT Service.
See DefaultMFTFolder and DefaultFilenameSpec.
Returns an %MFT.ItemInfo object with information about the upload.