FTP Tasks

Properties   Configuration Settings  

The FTP Task adds SSL-enabled FTP send and receive capabilities to your SSIS Package.

Remarks

The FTP Task adds a complete FTP client to your SSIS Package and enables it with plaintext or SSL-secured file download and upload capability.

FTP Receive Task

A single property must be set: FTPServer. You may also set an FTPPort if the server is not set to the default protocol port. If your FTP server requires authentication, you should set the User, Password and/or Account properties. If you wish to enable SSL, you can turn it on by setting an appropriate SSLCert and SSLStartMode as well as supplying an SSLAcceptServerCert.

The task will connect to the FTP server and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the SSIS Package as individual SSIS ADO tables. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. If you wish to do any other PRE- or POST-GET operation, you can specify them as scripts through the BeforeGet and AfterGet properties, respectively.

FTP Send Task

Two properties must be set: FTPServer and a RemoteFile. If your server does not operate on the default FTP port, you will need to specify the correct port via FTPPort. For servers that do not allow anonymous uploads, you may also need to set User, Password, and/or Account. To enable SSL, you should select a client SSLCert and a SSLAcceptServerCert as well as an SSLStartMode.

The task will connect to the FTP server whenever it has a message to send. The task will attempt to upload to the specified RemotePath. In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension. If Overwrite is set to True, the task will delete or overwrite remote files as necessary to complete the operation.

If you wish to do any other PRE- or POST-PUT operation, you can specify them as scripts through the BeforePut and AfterPut properties, respectively.

Receiver Property List


The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterGetA set of FTP commands to be executed after the GET.
BeforeGetA set of FTP commands to be executed before the GET.
DeleteControls if the remote file is deleted after download.
DirListString denoting the name of the variable which contains the last directory listing entries.
FileMaskIndicates the type of files to download from the FTP server.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
LocalDirectoryThe directory on the local machine to write downloaded files to.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OperationThe operation which will be executed by the FTP task.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
RemotePathThe current path in the FTP server.
RuntimeLicenseSpecifies the task runtime license key.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the task starts the SSL negotiation.
TimeoutA timeout for the task.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
UserThe user id for login.
UseSimpleDirListInstructs the task to issue the NLST command instead of LIST.

Sender Property List


The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterPutA set of FTP commands to be executed after the PUT.
AppendWhether or not the task should append data to the RemoteFile .
BeforePutA set of FTP commands to be executed before the PUT.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
LocalFileThe path to a local file for upload.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
RemoteFileThe name of the destination file on the FTP server for uploading.
RemotePathThe current path in the FTP server.
RemoteTempPathA temporary directory on the server to store files before moving them to RemotePath .
RuntimeLicenseSpecifies the task runtime license key.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the task starts the SSL negotiation.
TimeoutA timeout for the task.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
UserThe user id for login.
UseSimpleDirListInstructs the task to issue the NLST command instead of LIST.

Configuration Settings


The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.

AccountThe user account to login with.
AutoSelectDataIPAutomatically select the data connection IP.
CheckFileExistsWhether to check if the remote file exists before uploading.
DirEntryPatternAllows the use of regular expressions to parse non-standard directory entry formats.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparisonWhether the receive task should consider metadata differences when deciding whether to download a file again.
ExcludeMaskInstructs the task to exclude some files when downloading.
LocalFileThe name of the LocalFile to which the remote file will be saved.
LogoffWhether or not to logoff from the server after execution.
MaxFilesPerPollingIntervalThe maximum number of files that will be downloaded from the server during a single poll.
ModeZCompressionLevelUsed to specify the level of compression used.
PortRangeAllows the specification of a port range the task listens to.
RecursiveDownloadWhen true, all files and folders in the RemotePath are downloaded recursively.
RecursiveUploadWhen true, all files and folders in the folder specified in LocalFile are uploaded recursively.
RenameModeThe condition under which RenameTo is used.
RenameToA filename to which RemoteFile will be renamed.
ReusePISSLSessionInDIWhether the PI SSL session will be reused for the DI connection.
ReuseSSLSessionInDIWhether the SSL session will be reused for the DI connection.
TemporaryDownloadExtensionAn extension to be appended during download.
TemporaryUploadExtensionAn extension to be appended during upload.
UseClearCommandChannelAllows for the Clear Command Channel (CCC) command.
UseClearDataChannelAllows for the PROT C command.
UseEPSVAllows extended passive mode.
UseFSwitchSpecifies whether or not the -F parameter is used when listing directory contents.
UseMLSDUses listings for machine processing.
UseModeZAllows compression to be used when transferring data.
UseProtWhenImplicitSends PROT P to the server.
UseRemoteHostAddressForPassiveInstructs the task to use the FTPServer in passive mode.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the task whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 7723]