This page is for data modellers who want to export files using FTP.
Overview
An FTP site can be set up to send files generated by a File Exporter, or retrieve files using a File Collector, via FTP.
To add a new FTP site object to an analysis model:
- Go to the model's toolbar → Create group.
- Click
File to expand the menu. - Drag a
FTP Site onto the analysis model.
To add an existing FTP site object to an analysis model:
- Go to the model toolbar → List group.
- Click File to expand the menu.
- Click FTP Site to open the list of available FTP sites.
- Drag an FTP site into the analysis model.
Property Pane Toolbar
For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.
Properties Tab
Parent Details
If this item is within or belongs to another, its parent name is shown here. See the Parent Details section on the Common Properties page for more details.
Basic Settings
The FTP Type, FTP Mode, SSL Security and SFTP Ciphers are standard FTP concepts.
| Field | Description |
|---|---|
| Name | The name of the FTP Site. |
| Enabled | Whether or not the FTP Site is enabled to run. |
| Username | The name of the user that will be used to create a connection with the FTP server. |
| Password | Available when FTP Type is Plain or SSL. Also available when FTP Type is SSH AND Authentication Mode is Password (PhixFlow version 11.3+). The password that will be used to create a connection with the FTP server. |
| Server Address | The address of the destination server. |
| FTP Type | Select an option from:
|
| Port | Optional field to specify a Port Number, if required. |
| FTP Mode | Available when FTP Type is Plain or SSL. Select an option from:
|
| SSL Security | Available when FTP Type field is SSL. Select an option from:
|
| SFTP Cipher | Available when FTP Type field is SSH. For secure file transfer, PhixFlow automatically uses current ciphers (listed below). If your SSH server uses deprecated ciphers, enter a comma-separated list of all the ciphers you want to use. The order that you enter the ciphers indicates the order of preference. PhixFlow uses the first cipher that is listed and is available to encrypt/decrypt the files it transfers. Enter a list of ciphers, in order of preference, that you want PhixFlow to use for secure file transfer. The list can include:
|
Authentication Mode (Available in PhixFlow version 11.3+) | Available when FTP Type field is SSH. Choose from:
|
Private Key (Available in PhixFlow version 11.3+) | Available when FTP Type field is SSH AND Authentication Mode is Private Key. Paste your RSA formatted private key here. |
Private Key Password (Available in PhixFlow version 11.3+) | Available when FTP Type field is SSH AND Authentication Mode is Private Key. This field is optional. Enter the passphrase for your private key if it is encrypted. |
Analysis Models
If this item is used by an analysis model, its name is listed here. See the Common Properties page, Analysis Model section for more details.
Description
We recommend that you always enter a description to explain the purpose of this item.
Audit Tab
Audit Summary
See the Common Properties page, Audit Summary section.
How to use SFTP with Private Key Authentication
- Select SSH as your FTP Type
- Choose Private Key as your Authentication Mode
- Paste your RSA formatted private key into the Private Key field
- If your private key is encrypted with a passphrase, enter the passphrase in the Private Key Password field