
SFTP Functions
by Appian Corporation
Description
Contains multiple Smart Services for interacting with a remote file server via SFTP, FTP, or SCP. Using these services, an Appian application can be configured to send and receive files, folders, and metadata in a process. Features support for zlib compression.
Features
Key Features & Functionality Smart Services included:
SFTP: Send File Over SFTP Receive File Over SFTP Get Remote Folder Contents Over SFTP Create Folder Over SFTP Remove File Over SFTP Receive Files In Folder Over SFTP Rename File Over SFTP
SCP: Send File Over SCP Receive File Over SCP
FTP: Send File Over FTP Receive File Over FTP Get Remote Folder Contents Over FTP Receive Files In Folder Over FTP Remove File Over FTP Rename File Over FTP
FTPS Get Remote Folder Contents Over FTPS Receive File Over FTPS Receive Files In Folder Over FTPS Send File Over FTPS
Functions: getfoldercontentsoverftp getfoldercontentsoverftps getfoldercontentsoversftp All smart services in the package use Secure Credentials Store.
Release notes
Added an optional security check for FTPS connections. You can now turn on hostname verification to ensure your server's certificate matches the server you're connecting to, helping prevent unauthorized interception. This is turned off by default, so your existing setup won't be affected. To turn it on, set enableHostnameVerification to true in your FT_Config.
Version history (17)
4.2.0
Added configurable FTPS mode selection to support both implicit SSL and explicit FTPS.
4.1.1
Upgraded commons-lang3 library for vulnerability fix.
4.1.0
Fixed the deprecated API's and set the minimum supported version to 23.2
4.0.0
Upgraded the JSch library to support more algorithm
3.0.3
Added License file
3.0.2
Updated commons-net library. Additional plugin enhancements were also made, please see the SFTP document for the changes.
2.3.0
Added a parameter "Remote file name” in the Send file over SFTP Smart service.
2.2.2
Security Updates
2.2.1
What’s new in V2.2.1
- Support For Passive FTP Connections in Send File Over FTP Smart Service
- Added the following parameters EnterLocalActiveMode and BinaryFileType in Send File
Over FTP Smart Service
- EnterLocalActiveMode - True Indicates FTP Connection in Active Mode , False
indicates Passive Mode.Default Value is False.
- BinaryFileType - False indicates Ascii mode ftp file transfer , True indicates
Binary Mode File Transfer
- Added the output parameters Error and Status in following smart services to denote the
status of the smart service file operation performed.
2.1.1
v2.1.1 Release Notes Receive File Over FTP Bug fix.
v2.1.0 Release Notes:
"Receive File Over SFTP" - Bug fix
Updated - Version and document.
New in V2.0.0:
Added : Remove Directory Over SFTP (Basic Credentials)
- Which uses the username and password input from the smart service data.
- Which uses the credentials from the secure credential storage.
New in v1.8.0
Added “Create Directory Over SFTP” smart service. Added “Create Directory Over SFTP (Basic Credentials)” smart service.
2.1.0
v2.1.0 Release Notes:
"Receive File Over SFTP" - Bug fix
Updated - Version and document.
New in V2.0.0:
Added : Remove Directory Over SFTP (Basic Credentials)
- Which uses the username and password input from the smart service data.
- Which uses the credentials from the secure credential storage.
New in v1.8.0
Added “Create Directory Over SFTP” smart service. Added “Create Directory Over SFTP (Basic Credentials)” smart service.
2.0.0
Updated - Version and document.
New in V2.0.0:
Added : Remove Directory Over SFTP (Basic Credentials)
- Which uses the username and password input from the smart service data.
- Which uses the credentials from the secure credential storage.
New in v1.8.0
Added “Create Directory Over SFTP” smart service. Added “Create Directory Over SFTP (Basic Credentials)” smart service.
1.8.1
Fix the filename when uploading a file over SFTP
1.8.0
Updated - Version and document.
New in v1.8.0
Added “Create Directory Over SFTP” smart service. Added “Create Directory Over SFTP (Basic Credentials)” smart service.
1.7.1
[MIGRATED] This plugin has been updated to include the smart services available in the (now deprecated) Remote Transfer Plugin. The two smart services that exist in both SFTP Smart Services and Remote Transfer (Send File Over SFTP and Receive File Over SFTP) have been updated to use the version from Remote Transfer as it provides the ability to download a document as a new version of an existing document. In addition, all smart services in the package have been updated to use Secure Credential Store.
V1.7.1 The logs should now provide line numbers for any errors that occur V1.7.0 Added keep alive to the FTPS Send Function. v1.6.9 Added keep alive to Receive Folder Over FTPS
v1.6.8 Added support for FTPS
v1.6.5
- Added support for zlib compression.
v1.6.2
- Support authentication via password and private key at the same time.
Migration Steps Required: Configurations that use a private key with a passphrase must take action. Private keys without a passphrase do not require changes. A new "passphrase" field must be added to the third party credentials. "password" is reserved for the users password and "passphrase" is reserved for accessing a secured private key
v1.6.1
- Support authenticate via private key
- Support strict host checking
- Better logging and error handling
v1.5.2
- Option to use Basic Credentials for authentication (Andre Dessens)
v1.5.1
- Better performance of Receive File Over SFTP smart service (Owen Parrish)
- Send File Over SFTP
- Send File Over SFTP (Basic Credentials)
- Receive File Over SFTP
- Receive File Over SFTP (Basic Credentials)
- Rename File Over SFTP
- Send File Over SCP
- Receive File Over SCP
- Send File Over FTP
- Receive File Over FTP
- Receive Folder Over FTP
- Get Remote Directory Contents Over SFTP
- Get Remote Directory Contents Over SFTP (Basic Credentials)
- Receive Folder Over FTPS
- Send File Over FTPS (Basic Credentials)
1.7.0
[MIGRATED] This plugin has been updated to include the smart services available in the (now deprecated) Remote Transfer Plugin. The two smart services that exist in both SFTP Smart Services and Remote Transfer (Send File Over SFTP and Receive File Over SFTP) have been updated to use the version from Remote Transfer as it provides the ability to download a document as a new version of an existing document. In addition, all smart services in the package have been updated to use Secure Credential Store.
V1.7.0 Added keep alive to the FTPS Send Function. v1.6.9 Added keep alive to Receive Folder Over FTPS
v1.6.8 Added support for FTPS
v1.6.5
- Added support for zlib compression.
v1.6.2
- Support authentication via password and private key at the same time.
Migration Steps Required: Configurations that use a private key with a passphrase must take action. Private keys without a passphrase do not require changes. A new "passphrase" field must be added to the third party credentials. "password" is reserved for the users password and "passphrase" is reserved for accessing a secured private key
v1.6.1
- Support authenticate via private key
- Support strict host checking
- Better logging and error handling
v1.5.2
- Option to use Basic Credentials for authentication (Andre Dessens)
v1.5.1
- Better performance of Receive File Over SFTP smart service (Owen Parrish)
- Send File Over SFTP
- Send File Over SFTP (Basic Credentials)
- Receive File Over SFTP
- Receive File Over SFTP (Basic Credentials)
- Rename File Over SFTP
- Send File Over SCP
- Receive File Over SCP
- Send File Over FTP
- Receive File Over FTP
- Receive Folder Over FTP
- Get Remote Directory Contents Over SFTP
- Get Remote Directory Contents Over SFTP (Basic Credentials)
- Receive Folder Over FTPS
- Send File Over FTPS (Basic Credentials)
1.6.9
[MIGRATED] This plugin has been updated to include the smart services available in the (now deprecated) Remote Transfer Plugin. The two smart services that exist in both SFTP Smart Services and Remote Transfer (Send File Over SFTP and Receive File Over SFTP) have been updated to use the version from Remote Transfer as it provides the ability to download a document as a new version of an existing document. In addition, all smart services in the package have been updated to use Secure Credential Store.
v1.6.9 Added keep alive to Receive Folder Over FTPS
v1.6.8 Added support for FTPS
v1.6.5
- Added support for zlib compression.
v1.6.2
- Support authentication via password and private key at the same time.
Migration Steps Required: Configurations that use a private key with a passphrase must take action. Private keys without a passphrase do not require changes. A new "passphrase" field must be added to the third party credentials. "password" is reserved for the users password and "passphrase" is reserved for accessing a secured private key
v1.6.1
- Support authenticate via private key
- Support strict host checking
- Better logging and error handling
v1.5.2
- Option to use Basic Credentials for authentication (Andre Dessens)
v1.5.1
- Better performance of Receive File Over SFTP smart service (Owen Parrish)
- Send File Over SFTP
- Send File Over SFTP (Basic Credentials)
- Receive File Over SFTP
- Receive File Over SFTP (Basic Credentials)
- Rename File Over SFTP
- Send File Over SCP
- Receive File Over SCP
- Send File Over FTP
- Receive File Over FTP
- Receive Folder Over FTP
- Get Remote Directory Contents Over SFTP
- Get Remote Directory Contents Over SFTP (Basic Credentials)
- Receive Folder Over FTPS
- Send File Over FTPS (Basic Credentials)
Resources
- Download
SFTP Documentation.docx
Documentation