SCP Connector

The Secure Copy Protocol connector (SCP) transfers files to and from an SSH server via SCP.

Key Capabilities

SCP file transfer over SSH with certificate-based and password-based authentication
Bidirectional file transfer with multiple remote path monitoring and glob pattern filtering
Configurable SSH encryption algorithms with automatic file deletion and retry logic

Overview

Each SCP connector uploads to a specified folder and downloads from a set of folders on the remote SSH server. Files that reach the SCP connector in the flow are uploaded to the upload target folder, and files found in the download target folder(s) are downloaded and entered into the flow. The connector supports upload and download filters to send and receive only specified file names and/or file extensions.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Host Configuration

Settings related to establishing the connection to the remote SSH host.

Setting	Description
Connector Id	The static, unique identifier for the connector.
Connector Type	Displays the connector name and a description of what it does.
Connector Description	An optional field to provide a free-form description of the connector and its role in the flow.
Remote Host	The hostname or IP address of the SSH server.
Remote Port	The port on which to connect to the SSH server.

Client Authentication

Settings related to authenticating to the SSH server. Options vary based on the selected authentication mode.

Setting	Description
Authentication Mode	The type of authentication to use with the SSH server.
User	The username credential for logging in to the SSH server.
Password	The password credential for logging in to the SSH server.
Client Certificate	The certificate with a private key to use during public key authentication.
Certificate Password	The password required to access the Client Certificate.

Server Authentication

Settings related to verifying the SSH server’s identity.

Setting	Description
Server Thumbprint	The thumbprint of the certificate that identifies the SSH server. You can also set this to a certificate file containing the server’s public key. When you test the connection, the connector prompts to accept/trust the thumbprint presented by the server.

Upload

Settings related to uploading files to the SSH server.

Setting	Description
Remote Path	Files processed by the connector are uploaded to this remote folder.

Download

Settings related to downloading from the SSH server.

Setting	Description
Remote Path	The remote folder from which files are downloaded. Use a comma-delimited list to specify multiple paths.
File Mask	A glob pattern that determines which files in the Remote Path should be downloaded (for example, *.txt).
Delete files (after download)	Check this to delete successfully downloaded files from the SSH server.

Advanced Tab

Proxy Settings

Advanced Settings

Settings not included in the previous categories.

Setting	Description
Delete Command	The command to use when deleting files after download.
Max Download Files	The maximum number of files to be downloaded from the SCP server in one polling interval. Set to -1 to download all files.
Recurse	Whether to download files in subfolders of the target remote path.
SSH Encryption Algorithms	A comma-delimited list of algorithms to use during SSH encryption. By default, all algorithms are enabled. The following algorithms are supported: aes256-ctr, aes256-cbc, aes192-ctr, aes192-cbc, aes128-ctr, aes128-cbc, 3des-ctr, 3des-cbc, cast128-cbc, blowfish-cbc, arcfour, arcfour128, arcfour256, aes128-gcm@openssh.com, aes256-gcm@openssh.com, chacha20-poly1305@openssh.com
Local File Scheme	A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros.
Timeout	The duration the connector will wait for a connection response before throwing a timeout error.
Upload File Permissions	The file permissions to set on files uploaded by the connector.

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Setting	Description
Upload	Whether files arriving at the connector are automatically uploaded.
Retry Interval	The amount of time before a failed upload is retried.
Max Attempts	The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If this is set to 0, the connector retries the file indefinitely.
Receive	Whether the connector should automatically poll the remote download path(s) for files to download.
Interval	The interval between automatic download attempts.
Minutes Past the Hour	The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
Time	The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
Day	The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
Minutes	The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
Cron Expression	A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

The following settings are required to connect to a remote SSH server:

Remote Host
Remote Port
Authentication Mode
User
Password or Client Certificate/Certificate Password
Server Thumbprint

When you test the connection to the server, the connector prompts to accept/trust the thumbprint of the server’s public key.

Uploading Files

The SCP connector uploads files from the Transactions tab. Files are automatically uploaded to the SSH server if Upload Automation is enabled in the connector. Set the Remote Path to the folder on the remote SSH server where files should be uploaded. The application changes directories to the specified folder after logging in to the server. If a file is not uploaded, the connector attempts to upload it again after the Retry Interval has elapsed. This process continues until the Max Attempts setting has been reached, after which the connector raises an error and the file is no longer sent automatically.

Downloading Files

Downloaded files are displayed in the Transactions tab of the connector, or passed along to the next connector in the flow. Files are automatically downloaded from the SSH server if Download Automation is enabled in the connector, and can be manually downloaded by clicking the Receive button in the Transactions tab. Set the Remote Path to the folder on the remote SSH server from which files should be downloaded. The application changes directories to the specified folder after logging in to the server. File Mask filters files so that only filenames matching the glob pattern are downloaded. You can use the Delete files (after download) setting to delete files on the remote server after they are successfully downloaded. On the Transactions tab, click Receive to test the settings and retrieve the matching files from the server.

Getting Started

Flows

EDI Trading Partner Management Console

Connectors

Mapping

Admin API

How-To Guides

Scripting

Software License and Third-Party Copyrights

Key Capabilities

Overview

Connector Configuration

Settings Tab

Host Configuration

Client Authentication

Server Authentication

Upload

Download

Advanced Tab

Proxy Settings

Advanced Settings

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

Uploading Files

Downloading Files

Macros

Examples

​Key Capabilities

​Overview

​Connector Configuration

​Settings Tab

​Host Configuration

​Client Authentication

​Server Authentication

​Upload

​Download

​Advanced Tab

​Proxy Settings

​Advanced Settings

​Message

​Logging

​Miscellaneous

​Automation Tab

​Automation Settings

​Performance

​Alerts Tab

​SLAs Tab

​Establishing a Connection

​Uploading Files

​Downloading Files

​Macros

​Examples

Key Capabilities

Overview

Connector Configuration

Settings Tab

Host Configuration

Client Authentication

Server Authentication

Upload

Download

Advanced Tab

Proxy Settings

Advanced Settings

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

Uploading Files

Downloading Files

Macros

Examples