Create FTP Connection Configuration

Description

Creates a set of properties needed to open a connection to an FTP server.

Assembly: iCore.Workflow.Activities.Ftp
Category: SFTP/FTP

Arguments

Name	Type	Description
DisplayName	String	Name of the activity.
Result	IFileTransferConnectionConfiguration	The created connection configuration.
Server	String	Name or IP address of FTP server.
Port	Int32	Port that the FTP service is listening on for incoming connections. Default: 21
User	String	User name on FTP server.
Password	String	Password associated with the user name.
Account info	String	Specifies the account information sent to the server using the ACCT (account information) command.
Passive FTP mode	Boolean	Specifies whether passive FTP mode is to be used. True means it will be used (Default).
Connection timeout	Int32	A connection timeout period (in milliseconds) that applies to: Socket timeout – how long the client will try to establish socket connection to server. Listen timeout – how long the listening socket will be open in active mode. Transfer timeout – how long the client is to wait for data connection from remote side to be accepted. Default: 60000.
List method	FtpListMethod	The list command sent to the server. If the server supports MLSD, this option is recommended. Default: MLSD.
Server directory separator	String	Character used by server to separate directories in paths. Default: /.
Retries	Int32	Number of times the activity will retry to issue a failed command before an error occurs. Default: 0
Time between retries	TimeSpan	Time in seconds to wait between each retry. Default: 0.
Trace	Boolean	Enables/disables tracing of sent and received FTP commands to a file. True means tracing is enabled. Default: False.
Trace file	String	The path to the file where traced commands are to be saved. To make the trace file more suitable for presentation, you can trace to a Node file of the custom Node Type FTP trace. For more information, see FTP Trace Format.
Ignore error codes	Int32	Specifies error codes (not specified by the FTP protocol) that may be returned from the FTP server when listing files and there are no files to return. The specified error codes will be ignored when returned. Fill in codes to be ignored as comma-separated list. Example: {500, 503, 550}
List is case sensitive	Boolean	Specifies whether file lists that are retrieved internally are handled as case sensitive. True means lists will be handled as case sensitive. Set argument to True when FTP server has a case sensitive file system.
Remote code page	Int32	Specifies the code page/charset to be used by the remote server. If not specified, 20127 (US-ASCII) is used.
Encrypt data channel	Boolean	Specifies whether encryption of data channel is to be enabled. True means encryption is enabled. Default: False.
Use SSL	Boolean	Specifies whether SSL is to be enabled. True means SSL is enabled. Default: False.
Auth command	FtpAuthorizationCommand	Authorization command to be sent to server to request an explicit SSL session.
Versions	SslVersions	SSL/TLS version to be used. More than one option can be selected. Default is TLS 1.3, TLS 1.2. For more information, see General information about SSL and TLS.
SSL mode	SSLMode	Specifies whether explicit or implicit SSL mode is to be used. Default: Implicit.
Use SSL session resumption	Boolean	Specifies if SSL session resumption should be used.
Certificate validation configuration	CertificateValidationConfiguration	Defines the options and rules to use for validation of server certificates when using an SSL connection. For example, see Remarks.
Certificate	ICertificate	The client certificate that the server may request.
Concurrent Connections	Int32	Number of concurrent connections opened to the server for receiving files. Applicable only when using binary transfer type. Default: 0.
Buffer size	Int32	Specifies the size of the data buffer used in the data transfer.
Incoming speed limit	Int32	The maximum number of bytes per second that the FTPS client can receive. A value of 0 (zero) means the maximum number is unlimited.
Outgoing speed limit	Int32	The maximum number of bytes per second that the FTPS client can send. A value of 0 (zero) means the maximum number is unlimited.
Use IPv6	Boolean	Specifies whether IPv6 should be used.
Use FEAT command	Boolean	Specifies whether to send FEAT (feature list) command to the server.
Virtual host name	String	Name of the virtual host to identify using the HOST command.
Trusted storage	ICertificateStore	The certificate storage containing trusted certificates for validation of server certificate.
Enable validation	Boolean	Enables/disables validation of remote servers certificate. Disabling validation implies that all received certificates will be accepted without any validation. Default: True.
Transfer type	FtpTransferMode	Specifies how data is to be transferred.

Remarks

The below Code expression example shows how to set up a default Certificate validation configuration:

New iCore.Public.Crypto.X509Certificates.CertificateValidationConfiguration() With {
                  .RequirementSuppression = iCore.Public.Crypto.X509Certificates.CertificateValidationErrorSuppression.Default,
                  .Options = iCore.Public.Crypto.X509Certificates.CertificateValidationOptions.Default,
                  .RevocationCheckPreference = iCore.Public.Crypto.X509Certificates.CertificateValidationRevocationCheckPreference.PreferCrl,
                  .RevocationMomentGracePeriod = 60
                  }

See Also

Open SFTP/FTP Connection
FTP Trace Format