FTPUpload
Description
This activity uploads a file to an FTP archive.
You can choose whether to load a file from a local path or from an IFileValue; to do this, just set the argument of the method you need.
Connection Options
AuthTls InArgument<Boolean>
Set this to True to switch to a TLS encrypted channel. If this property is set, the port typically remains at it's default (21) and the Ssl property should *not* be set. When AuthTls is used, all control and data transmissions are encrypted.
BandwidthThrottleUp InArgument<Int32>
If set to a non-zero value, the FTP component will bandwidth throttle all uploads to this value. The default value of this property is 0. The value should be specified in bytes/second.
Passive InArgument<Boolean>
Connect using passive mode.
Port InArgument<Int32>
The port on the remote server where the FTP service is hosted. 21 is default for FTP and 22 is default for SFTP.
Ssl InArgument<Boolean>
Set this to true to switch to a SSL encrypted channel. If this property is set, the port typically remains at it's default (21) and the AuthTls property should *not* be set. When Ssl is used, all control and data transmissions are encrypted.
UseSocks InArgument<Boolean>
Enable socks protpcol. SOCKS is an Internet protocol that exchanges network packets between a client and server through a proxy server.
Credentials
HostName InArgument<String> REQUIRED
The address of the remote server you want to connect to.
Password InArgument<String>
The password for the specified username.
Username InArgument<String>
A valid username for the remote server you want to connect to.
Misc
ChunkSize InArgument<Int32>
If this property is null or empty DocsMarshal will use 10000000 as default value
Result OutArgument<Boolean>
TempLocalFolder InArgument<String>
If this parameter is null Or Empty, DocsMarshal will save the file (before send) into local temp user path
Proxy
ProxyHostname InArgument<String>
The hostname of your FTP proxy, if a proxy server is used.
ProxyMethod InArgument<EProxyType>
The proxy scheme used by your FTP proxy server.
ProxyPassword InArgument<String>
The password for authenticating with the FTP proxy server.
ProxyPort InArgument<Int32>
If an FTP proxy server is used, this is the port number at which the proxy server is listening for connections.
ProxyUsername InArgument<String>
The username for authenticating with the FTP proxy server.
UseProxy InArgument<Boolean>
Set to true if a proxy server is used.
Results
ConnectFailReason OutArgument<Int32>
The possible failure reasons are: 0 = success, Non-SSL socket fail reasons: 1 = empty hostname, 2 = DNS lookup failed, 3 = DNS timeout, 4 = Aborted by application, 5 = Internal failure, 6 = Connect Timed Out, 7 = Connect Rejected (or failed for some other reason). SSL failure reasons: 100 = Internal schannel error, 101 = Failed to create credentials, 102 = Failed to send initial message to proxy, 103 = Handshake failed, 104 = Failed to obtain remote certificate, 300 = asynch op in progress, 301 = login failure.
LastErrorText OutArgument<String>
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
UploadTransferRate OutArgument<Int32>
The average upload rate in bytes/second.
SFTP
UseSFTP InArgument<Boolean>
Set to true if you are connecting to an SFTP server.
Socks Configuration
SocksHostName InArgument<String>
The SOCKS hostname may be a domain name or IP address
SocksPassword InArgument<String>
The password for the socks specified userneme.
SocksPort InArgument<Int32>
The port of your socks protocol. Default is 1080.
SocksUsername InArgument<String>
A valid username for your socks protoocl.
SocksVersion InArgument<Int32>
To use a SOCKS4 or SOCKS5 proxy. Set the SOCKS version to 4 or 5 based on the version of the SOCKS proxy server
Upload
CreateFolderIfNotExists InArgument<Boolean>
If this property is set to true DocsMarshal will automatically create the remote folder if it doesn't exist. Otherwise, if the folder does not exist, DocsMarshal will throw an exception.
File InArgument<IFileValue>
The file value to upload
LocalFilePath InArgument<String>
The local path where the file to upload is
RemoteDir InArgument<String>
Set this property if you want to save the file into a subfoler of the ftp archive. If ti is left empty DocsMarshal saves it in the root of the Archive.
RemoteFileName InArgument<String>
If this property is null or empty DocsMarshal will use the FileName property of the DmFile property