Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

any Filesvoid myFiles.Upload(id: string, options: FileTransferOptions)

...

Remarks

If port number is specified passive mode is automatically disabled, to enable it please remove the port number from options.

Example

Uploading file via FTP into a folder located on a remote server

Code Block
languagejs
var fileId = $Xml.Evaluate('File/FileId');
//Create File Transfer Option..
    var fileTransferOptions = {
         
            RemoteHostRemoteHost : '192.168.1.28',
            RemotePathRemotePath : 'testfolder' + '/' + 'testdoc.pdf',
            UsernameUsername : 'myUsername',
            PasswordPassword : 'myPassword',
            ProtocolProtocol : 'FTP'
    
   };

 
//Uploading..
$Files.Upload(fileId, fileTransferOptions)
````
@see {@link FileTransferOptions}`

Types

FileTransferOptions

{ // Password to authenticate on remote environment. Optional. Password : string // Port number of remote environment. Optional. Port : number Protocol : string RemoteHost : string RemotePath : string UserName : string }

Examples

...

languagejs

...

// Protocol to use for file transfer. Optional. Default is FTP. Protocol : ( "FTP" | "FTPS" | "SFTP" | "HTTP" | "HTTPS" ) // IP address or host name of remote environment. RemoteHost : string // Path of file on remote environment. RemotePath : string // Username to authenticate on remote environment. Optional. UserName : string }