EnsLib.MFT.Adapter.Inbound
class EnsLib.MFT.Adapter.Inbound extends Ens.InboundAdapter, EnsLib.MFT.Adapter.Common
MFT Inbound AdapterProperty Inventory
- DeleteFromServer
- DownloadItemInfoOnly
- FilesToRetrieve
- FindModifiedByUsername
- IncludeSubFolders
- MFTSourceFolders
Method Inventory
Parameters
parameter SETTINGS = MFTConnectionName:Basic:mftconnectionSelector,MFTSourceFolders:Basic:lookuptableSelector,FilesToRetrieve:Basic,IncludeSubFolders:Basic,DeleteFromServer:Basic,FindModifiedByUsername:Basic,DownloadItemInfoOnly:Basic;
Inherited description: List of properties can be set as settings in the configuration file
format is a comma separated list of property names
Properties
property DeleteFromServer as %Integer (DISPLAYLIST = ",No,Trash,Permanent", VALUELIST = ",0,1,2") [ InitialExpression = 0 ];
Specifies whether or not to delete files on the remote MFT server after successful processing.
The three options are:
No = Do not request any form of delete from the server but record locally that the file has been processed based on file id, its container and modified date so that the file is not reprocessed.
If the modified date changes the file will be processed again.
Note - the local list of processed files will be amended based on the list found on the server.
Files will be removed from the list if they are no longer found on the server and it is possible for this list to keep growing.
The functionality of the following 2 options may be implemented differently or not at all on the remote MFT server:
Trash = Request the MFT server to mark the remote file as deleted but recoverable by manual intervention.
Permanent = Request the MFT server to permanently delete the file.
The Default is No
The three options are:
No = Do not request any form of delete from the server but record locally that the file has been processed based on file id, its container and modified date so that the file is not reprocessed.
If the modified date changes the file will be processed again.
Note - the local list of processed files will be amended based on the list found on the server.
Files will be removed from the list if they are no longer found on the server and it is possible for this list to keep growing.
The functionality of the following 2 options may be implemented differently or not at all on the remote MFT server:
Trash = Request the MFT server to mark the remote file as deleted but recoverable by manual intervention.
Permanent = Request the MFT server to permanently delete the file.
The Default is No
Property methods: DeleteFromServerDisplayToLogical(), DeleteFromServerGet(), DeleteFromServerIsValid(), DeleteFromServerLogicalToDisplay(), DeleteFromServerNormalize(), DeleteFromServerSet()
property DownloadItemInfoOnly as %Boolean [ InitialExpression = 0 ];
This flag can be set to not download the stream - just the ItemInfo.
Property methods: DownloadItemInfoOnlyDisplayToLogical(), DownloadItemInfoOnlyGet(), DownloadItemInfoOnlyIsValid(), DownloadItemInfoOnlyLogicalToDisplay(), DownloadItemInfoOnlyNormalize(), DownloadItemInfoOnlySet()
property FilesToRetrieve as %String (MAXLEN = 1000);
Regular expression to match against file names to retrieve.
Empty value is the default and means all files.
An example of retrieving only files with extension pdf or jpg case insensitive would be:
(?i) .*\.pdf | .*\.jpg
Where (?i) means case insensitive
.* means any characters
\. means a period
pdf means ends with pdf
| means OR
See documentation on Regular expressions for further information.
Empty value is the default and means all files.
An example of retrieving only files with extension pdf or jpg case insensitive would be:
(?i) .*\.pdf | .*\.jpg
Where (?i) means case insensitive
.* means any characters
\. means a period
pdf means ends with pdf
| means OR
See documentation on Regular expressions for further information.
Property methods: FilesToRetrieveDisplayToLogical(), FilesToRetrieveGet(), FilesToRetrieveIsValid(), FilesToRetrieveLogicalToDisplay(), FilesToRetrieveLogicalToOdbc(), FilesToRetrieveNormalize(), FilesToRetrieveSet()
property FindModifiedByUsername as %Boolean [ InitialExpression = 0 ];
Set this to true if a separate call is to be made for each download to find the
service's username that modified the document.
Property methods: FindModifiedByUsernameDisplayToLogical(), FindModifiedByUsernameGet(), FindModifiedByUsernameIsValid(), FindModifiedByUsernameLogicalToDisplay(), FindModifiedByUsernameNormalize(), FindModifiedByUsernameSet()
property IncludeSubFolders as %Boolean [ InitialExpression = 0 ];
Specifies if we search through sub folders
Property methods: IncludeSubFoldersDisplayToLogical(), IncludeSubFoldersGet(), IncludeSubFoldersIsValid(), IncludeSubFoldersLogicalToDisplay(), IncludeSubFoldersNormalize(), IncludeSubFoldersSet()
property MFTSourceFolders as %String) [ InitialExpression = "/" ];
Name(s) of source MFT Folders to search in.
The name can be one folder or a comma separated list of folders or an @ followed by the name of a Lookup Table.
If @ is the first character and the remainder of the string identifies an existing Lookup Table then
the values for all rows in the Lookup Table are used as the MFT Source Folders.
The drop down will list Lookup Tables preceded by a @ for those users with %Ens_LookupTables:READ privilege.
If @ is the first character and the remainder of the string does not identify an existing Lookup Table then
the folder name will be taken to be the complete value of the setting including the @ - this is to
allow for the possibility that the MFT server supports folder names beginning with @
Property methods: MFTSourceFoldersDisplayToLogical(), MFTSourceFoldersGet(), MFTSourceFoldersIsValid(), MFTSourceFoldersLogicalToDisplay(), MFTSourceFoldersLogicalToOdbc(), MFTSourceFoldersNormalize(), MFTSourceFoldersSet()
Methods
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method OnTask() as %Status
Inherited description: default InboundAdapter behavior: always call ProcessInput on CallInterval
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- BusinessHost
- CallInterval
- Credentials
- KeepaliveInterval
- MFTAPIClass
- MFTConnection
- MFTConnectionName
- RegistryID
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AssignOneSetting()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- CredentialsSet()
- DeleteFile()
- DownloadStream()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GetFolderContents()
- GetFolderInfo()
- GetMFTConnection()
- GetRequestId()
- GetSettings()
- GetUsername()
- HandleMFTError()
- OnKeepalive()
- OnTearDown()
- UploadStream()