SSH Service
Overview
The SSH Service connects B2Win Suite to an SFTP server over SSH. It stores the host, port, credentials, and optional root folder used by SFTP file nodes.
Purpose
Use this service when workflows need encrypted file transfer through SFTP.
Configure in B2Win Suite
Go to Configurations > Services and open SSH Service. Create a new configuration or edit an existing one.
| Field | Required | Default | Description |
|---|---|---|---|
| Host | Yes | None | SFTP server hostname or IP address. |
| Port | Yes | 0 | SSH/SFTP port. Configure the actual port required by the server, commonly 22. |
| User | Yes | None | Username used to authenticate to the SFTP server. |
| Password | Yes | None | Password for the configured user. |
| Root Folder | No | Empty string | Base folder prepended to node-level remote paths. |
Click Test Connection to verify the SSH login and SFTP channel, then Save the configuration.
For administrator override settings, see Services Configuration. For user-specific settings, see My Services.
Usage
Once configured, this service can be selected in:
- Read File (SFTP) - download one or more files through SFTP.
- Copy File (SFTP) - upload workflow files through SFTP.
Example
Use an SSH service for encrypted SFTP delivery to a reporting server:
| Field | Example Value |
|---|---|
| Host | sftp.partner-example.com |
| Port | 22 |
| User | report_uploader |
| Root Folder | /incoming/b2win |
In Copy File (SFTP), set Path to /invoices/ to upload files under /incoming/b2win/invoices/.
Troubleshooting
- Confirm the B2Win Suite server can reach the SSH host and port.
- Verify the username and password are correct.
- Confirm the account has read or write permissions under the configured root folder.
- Check firewall and network rules for outbound SSH/SFTP access.
- If paths fail, verify whether node-level paths should be relative to Root Folder.
Notes / Limitations
- The service uses password-based SSH authentication.
- Node-level paths are resolved under Root Folder when a root folder is configured.
- Use FTP Service only when the target server requires FTP or FTPS instead of SFTP.