Skip to main content


class EnsLib.MFT.Adapter.Common extends Ens.Adapter

Base class for MFT Adapters EnsLib.LDAP.Adapter.Inbound and EnsLib.LDAP.Adapter.Outbound

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;


property MFTAPIClass as %String (MAXLEN = 1000) [ Transient ];
Class Name of MFT API for the Service.
This is calculated from the connection.
Property methods: MFTAPIClassDisplayToLogical(), MFTAPIClassGet(), MFTAPIClassIsValid(), MFTAPIClassLogicalToDisplay(), MFTAPIClassLogicalToOdbc(), MFTAPIClassNormalize(), MFTAPIClassSet()
property MFTConnection as %SYS.MFT.Connection.Base;
MFT Connection instance
Property methods: MFTConnectionGet(), MFTConnectionGetObject(), MFTConnectionGetObjectId(), MFTConnectionGetSwizzled(), MFTConnectionIsValid(), MFTConnectionNewObject(), MFTConnectionSet(), MFTConnectionSetObject(), MFTConnectionSetObjectId(), MFTConnectionUnSwizzle()
property MFTConnectionName as %String (MAXLEN = 64);
Name of Managed File Transfer Connection to the file management service.
The list of available Connection definitions will only be shown to users with appropriate privilege (SQL select on table %SYS_MFT_Connection.Base).
Property methods: MFTConnectionNameDisplayToLogical(), MFTConnectionNameGet(), MFTConnectionNameIsValid(), MFTConnectionNameLogicalToDisplay(), MFTConnectionNameLogicalToOdbc(), MFTConnectionNameNormalize(), MFTConnectionNameSet()


method DeleteFile(pFileId As %String, pPermanent As %Boolean = 0) as %Status
Call to MFT DeleteFile using current connection
method DownloadStream(pFileId As %String, ByRef pItemStream As %BinaryStream) as %Status
Call to MFT Download Stream using current connection
method GetFolderContents(pFolder As %String, pIncludeSubFolders As %Boolean = 0, Output pFolderContents As %MFT.FolderContents, ByRef pFolderId As %String) as %Status
Call to MFT GetFolderContents using current connection
If pFolderId is not defined then pFolder is used for the target folder specification.
If pFolderId is defined and not empty then it is used for the target folder specification.
If pFolderId is defined as empty then API calls will be made to find the ID of pFolder and pFolderId will be updated, used as the target folder specification and passed back by reference to the caller.
If pIncludeSubFolders is true and pFolderId is used then it is possible that the Container property for file items found will be empty and it is recommended to call this method with pFolderId undefined if Container property is required.
method GetFolderInfo(pFolder As %String, Output pItemInfo As %MFT.ItemInfo) as %Status
Call to MFT GetFolderInfo using current connection
method GetMFTConnection() as %Status
Obtains the MFT Connection and executes a test GetUser() call.
method GetRequestId(pItemInfo As %MFT.ItemInfo) as %String
Call to MFT GetRequestId using current connection
method GetUsername(pModifiedBy As %String, Output pMFTUsername As %String = "") as %Status
Call to MFT GetUsername using current connection
method HandleMFTError(pMFTStatus As %Status, Output pTriedReconnecting As %Boolean = 0, Output pReconnectedOnError As %Boolean = 0) as %Status
This method is used to identify if the MFT method error was a connection issue that can be recovered by reconnecting and tries the reconnection.
The first parameter is the MFT Status to be examined.
The second parameter indicates if tried reconnecting.
The third parameter is output indicating if it recovered the connection.
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method UploadStream(pStream As %Stream.Object, pFilename As %String, pUploadIfSameFileOnServer As %Boolean = 0, Output pResponse As %MFT.ItemInfo, Output pTriedReconnecting As %Boolean = 0, Output pReconnectedOnError) as %Status
This method wraps the MFT system method UploadStream.
The first parameter is the stream object to upload.
The second parameter is the filename to write the stream to on the target.
The third parameter indicates if the target filename ought to be overwritten. (An MFT server may not overwrite but create multiple versions)
The method returns the status from the MFT call.
The method also returns in parameter pResponse the %MFT.ItemInfo response.
Parameter pTriedReconnecting indicates if there was an error whether the error was a connection type error
Parameter pReconnectedOnError indicates if it was a connection error if it was able to recover
If there was a connection error and there was an error trying to reconnect both errors are included in the return status.

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab