This is documentation for Semarchy xDI 2023.3, which is no longer supported.

For more information, see our Global Support and Maintenance Policy.

Send Files with FTP

FtpPut32x32

Description

Uploads a set of files to an FTP server from the Runtime engine file system. This action also allows to store in a table the list of uploaded files.

Parameters

Name	Mandatory	Default	Description
FTP Hostname	Yes		FTP host name or IP address.
FTP Port	No	21 in normal mode, 990 in secure mode.	FTP host port.
FTP User	Yes		FTP user.
FTP Password			This user’s encrypted password.
FTP Unencrypted Password			This user’s password in plain text.
FTP Remote Filename	No		Remote file name. Ignored if FTP Multiple Mode is set to true.
FTP Remote Path	No		Remote FTP path.
FTP Local Filename	No		Local file name. May be a name pattern if FTP Multiple Mode is set to true.
FTP Local Path	No		Local file path.
FTP File Mode	No	ascii	FTP file transfer mode: ascii or binary.
FTP Append	No	false	Append the content being transferred to the target file if it already exists.
FTP Multiple Mode	No	true	Put multiple files from the FTP server. Use a name pattern for the FTP Local Filename.
FTP Nb Files	No	–1	Number of files to upload. –1 stands for an infinite number of files.
Delete File After Transfer	No	False	Delete the files on the remote server after the transfer.
FTP Passive Mode	No	true	Use FTP passive (PASV) mode.
FTP Disable Login	No	false	If true, the connection to the server will be performed anonymously, without using the login credentials.
FTP Implicit FTPs	No	true	Use FTPs Implicit mode.
FTP Secured Protocol	No	None	Protocol used for FTPs communication: none, tls, ssl
FTP Encrypt Channel Data	No	false	If set to true, channel data will be encrypted using the PROT command.
FTP Protection Buffer Size	No		Defines the size to use for the Protection Buffer. Please refer to your FTP server provider for the possible values.
FTP System Type	No		Specifies the system type of the FTP Server. This helps to better treat the responses of the server. By default, the Runtime will try to auto-detect it. The following types are supported: UNIX,VMS,WINDOWS,OS/2,OS/400,AS/400,MVS,TYPE: L8,NETWARE
Ignore Trust Store	No	false	If true, the specified Trust Store will be ignored.
Socket Timeout	No		Set the timeout in milliseconds of a currently open connection.
Connection Timeout	No		Set the timeout in milliseconds when opening a connection.
Data Timeout	No		Set the timeout in milliseconds on the data connection.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .
SQL Connection	No		SQL connection into which the list of uploaded files is published, similarly to the Get Files with FTP action.
SQL Transaction Name	No		SQL transaction into which the list of uploaded files is published.
SQL Schema Name	No		SQL schema into which the list of uploaded files is published.
Key Store	No		Full path to the Java Key Store to use when connecting to the server.
Key Store Type	No	JKS	Type of the Java Key Store.
Key Store Password	No		Encrypted password of the Java Key Store.
Trust Store	No		Full path to the Java Trust Store to use when connecting to the server.
Trust Store Type	No	JKS	Type of the Java Trust Store.
Trust Store Password	No		Encrypted password of the Java Trust Store.

Name

Mandatory

Default

Description

FTP Hostname

Yes

FTP host name or IP address.

FTP Port

21 in normal mode, 990 in secure mode.

FTP host port.

FTP User

Yes

FTP user.

FTP Password

This user’s encrypted password.

FTP Unencrypted Password

This user’s password in plain text.

FTP Remote Filename

Remote file name. Ignored if FTP Multiple Mode is set to true.

FTP Remote Path

Remote FTP path.

FTP Local Filename

Local file name. May be a name pattern if FTP Multiple Mode is set to true.

FTP Local Path

Local file path.

FTP File Mode

ascii

FTP file transfer mode: ascii or binary.

FTP Append

false

Append the content being transferred to the target file if it already exists.

FTP Multiple Mode

true

Put multiple files from the FTP server. Use a name pattern for the FTP Local Filename.

FTP Nb Files

–1

Number of files to upload. –1 stands for an infinite number of files.

Delete File After Transfer

False

Delete the files on the remote server after the transfer.

FTP Passive Mode

true

Use FTP passive (PASV) mode.

FTP Disable Login

false

If true, the connection to the server will be performed anonymously, without using the login credentials.

FTP Implicit FTPs

true

Use FTPs Implicit mode.

FTP Secured Protocol

None

Protocol used for FTPs communication: none, tls, ssl

FTP Encrypt Channel Data

false

If set to true, channel data will be encrypted using the PROT command.

FTP Protection Buffer Size

Defines the size to use for the Protection Buffer. Please refer to your FTP server provider for the possible values.

FTP System Type

Specifies the system type of the FTP Server. This helps to better treat the responses of the server. By default, the Runtime will try to auto-detect it. The following types are supported: UNIX,VMS,WINDOWS,OS/2,OS/400,AS/400,MVS,TYPE: L8,NETWARE

Ignore Trust Store

false

If true, the specified Trust Store will be ignored.

Socket Timeout

Set the timeout in milliseconds of a currently open connection.

Connection Timeout

Set the timeout in milliseconds when opening a connection.

Data Timeout

Set the timeout in milliseconds on the data connection.

Proxy Host

Host name for the proxy server.

Proxy Port

1080

Port of the proxy server.

Proxy User

Proxy server user.

Proxy Password

Proxy server user password, encrypted.

Proxy Unencrypted Password

Proxy server user password in plain text.

Proxy Protocol

Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

SQL Connection

SQL connection into which the list of uploaded files is published, similarly to the Get Files with FTP action.

SQL Transaction Name

SQL transaction into which the list of uploaded files is published.

SQL Schema Name

SQL schema into which the list of uploaded files is published.

Key Store

Full path to the Java Key Store to use when connecting to the server.

Key Store Type

JKS

Type of the Java Key Store.

Key Store Password

Encrypted password of the Java Key Store.

Trust Store

Full path to the Java Trust Store to use when connecting to the server.

Trust Store Type

JKS

Type of the Java Trust Store.

Trust Store Password

Encrypted password of the Java Trust Store.

Passwords are encrypted using the encrypt <password> command on the Runtime engine console (engine command line tool).

This actions supports publishing the processed files to a table, similarly to the Get Files with FTP action.

Published Variables

Name

Description

FILE_NB

Number of files uploaded.