Response "FTP"

Settings


(1) Protocol: You can choose between the protocols "FTP", "SFTP" (see section below) and "FTPS". See also (2).

(2) Channel selection: Here you can select a channel of type "FTP" (for protocols "FTP" and "FTPS") or " SSH" (for protocol " SFTP" ) .

(3) Via DMZ: Send data via DMZ server. If no DMZ is configured, this checkbox will not be displayed.

(4) Server: URL or IP address of the FTP server. If a channel is selected and a value is entered in this field, the value of the field overwrites the server address of the channel.

(5) Port: A value greater than 0 overrides the port of a selected channel. If value 0 is set, the port set in the channel is used.

(6) User/Password: User and password for the target system. When connecting to a Value Added Network (VAN), it may be necessary to specify the GXS account (7) in addition to the user.

(7) GXS account.

(8) Directory: Target directory on the FTP server.

(9) File: Name of the output file. If you enter "lobster/unzip" here, the payload is regarded as a ZIP file. The file is unpacked and all contained files are transferred. Each file is created with the name it has in the archive.

(10) Temp. file: Name of the temporary file during the transfer of the data. If a value is entered in this field, the data is first transferred into a temporary file on the target system. After the file has been transferred successfully, the temporary file is renamed to the final destination file. The name of the temporary file can be set as follows. You can use variables in the form @variablename@ and the placeholder <lines> for the number of lines in the output data.

Suffix

The content of the field is appended as a suffix to the file name. Example: If the value .tmp is entered, the temporary file order4711.csv.tmp is created when transferring the file order4711.csv. Note: If no leading dot is specified, it will be inserted automatically. The suffix tmp would therefore lead to the same result.

Prefix

The content of the field is prefixed to the file name. Example: If the value tmp is entered, the temporary file tmporder4711.csv is created when transferring the file order4711.csv.

Name

The content of the field is used as the name of the temporary file, regardless of the file name. Example: If the value tmp.csv is entered, the temporary file tmp.csv is created when transferring the file order4711.csv.

(11) Control file: After a successful transfer of the data, a control file can be generated on the target system. You can also choose between Suffix, Prefix and Name. Example: If the value .ctrl is entered (and Suffix is selected), the control file order4711.csv.ctrl is created after the transfer of the file order4711.csv. If the placeholders <file>, <file-prefix> or <basefile> are used, the content of the field is no longer interpreted as a suffix, but as the name of the control file. You can use variables. Additionally, you can use placeholder <lines> for the number of lines in the output data if you use the output formats (Content) CSV, Excel or Fix record. If you use value as received in field Content, this placeholder will not be properly resolved. Please use the system variable VAR_SYS_LINES instead.

(12) Passive mode: In passive mode, the client establishes the control connection and the data connection here. Normally, the server establishes the data connection, but the necessary port for that might be blocked by the local firewall.

(13) ASCII transfer mode: Converts platform-dependent text formats (special characters).

(14) Append: If this checkbox is set, no new file will be created, but the target data will be appended to the end of an already existing file. If the file does not exist yet, it will still be created. This option is not available if (10) has a value. Additionally, appending to an existing file is not possible in the following cases, i.e. a set checkbox is ignored.

  • Output format XML. An XML file may only have one root node.

  • Output format Excel. An Excel file is a binary file.

  • Compressed data. A compressed file is also a binary file.

(15) Check upload file: After transferring the data, there will be a check as to whether a file exists with the name defined in field (9).

(16) Additional FTP commands: Additional FTP SITE commands and standard FTP commands can be specified here (according to RFC 959). Which SITE commands can be specified here depends on which commands the respective FTP server supports (with SITE HELP the FTP server sometimes provides a list of its specific SITE commands). If you specify the additional FTP command somecommand, the FTP command SITE somecommand will be sent internally. If you want to send standard FTP commands, please use the prefix rfc:. So if you enter the additional FTP command rfc:CDUP, the FTP command CDUP will be sent internally. If there is a prefix before:, the command will be sent before the file transfer, otherwise afterwards. So to send the command CDUP before the file transfer, before:rfc:CDUP must be used. Note: When sending commands, the return code is checked by the server and all values 2xx (except 202) and 350 are accepted. For other values, the profile generates an error. Note: Profile variables in the form @VARNAME@ can also be used to specify the additional commands. Note: Additional FTP commands cannot be used with SFTP.

(17) Mark whole job as failed if this response fails: Normally a job is not necessarily considered to be erroneous if a single Response fails (see section Status of Response - Error Behaviour). But it can be enforced with this option here.

(18) Additional text on error: Here you can specify an additional log text for the error case.

Extremely large files


With extremely large files, the communication between the inner Integration Server and the DMZ server can lead to a timeout. A solution is described in section Dealing with Timeouts Due to Extremely Large Files.

Empty files


Empty files are ignored.

Special features of SFTP


The subtype SFTP uses a transmission secured by SSH encryption. SSH uses fingerprints to verify the identity of the server. This feature can only be used in this Response by assigning a partner channel of type "SSH", which then specifies the fingerprint.

SFTP Responses configured without a partner channel accept every key presented to them by the server.

Authentication is possible by username and password, or by a certificate. The user name and password are either taken from the selected partner channel or specified directly in the Response. The certificate can only be selected in the channel. The server decides which authentication it expects. If both user name and certificate are configured, the server decides which authentication type is used.

With SFTP, only CHMOD can be used as an additional command. Other commands are not available.