Salesforce

FTP Resource (Magic xpi 4.5)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

FTP Resource (Magic xpi 4.5)

FTP resources contain the following parameters (parameters in bold are mandatory):

Parameter

Description

Server

The FTP server name.

If you want to define a port, use the following syntax: servername:portnum.

You can either enter the server name, or click to open the Environment Variables List. Here, you can select an environment variable to use as a server name.

Protocol

The required protocol for the resource. Select one of the following from the drop-down list:

  • FTP (default)

  • SFTP

Since version: 4.5

Enable Server Validation

Determines whether to enable the validation of the server. Select one of the following from the drop-down list:

  • Yes (default)

  • No

Note:

You should not disable the server validation functionality while working in the production environment.

This parameter is available only if you select SFTP in the Protocol parameter (above).

Since version: 4.5

Validate Against

The file type used for the validation of the server. Select one of the following from the drop-down list:

  • Public Key File (default)

  • Known Hosts File

This parameter is available only if you select Yes in the Enable Server Validation parameter (above).

Since version: 4.5

Server Validation File

The full path to the file holding the list of known hosts and their public keys, or to a file holding a single server public key.

You can either enter file path, or click to open the Environment Variables List. Here, you can select an environment variable to use as a file path.

This parameter is available only if you select Yes in the Enable Server Validation parameter (above).

Since version: 4.5

Client Authentication

The SFTP authentication type. Select one of the following from the drop-down list:

  • User Password (default)

  • Public Private Keys

This parameter is available only if you select SFTP in the Protocol parameter (above).

Since version: 4.5

User

Your FTP or SFTP user name.

You can either enter the user name, or click to open the Environment Variables List. Here, you can select an environment variable to use as a user name.

Password

Your FTP or SFTP password. If you are working with SFTP, enter either the client password or the private key password used in the SFTP protocol, depending on the type that you set in the Client Authentication parameter (above).

You can either enter the password, or click to open the Environment Variables List. Here, you can select an environment variable to use as a password.

Note:

A password entered as an environment variable is masked by asterisks.

Client Private Key File Path

The full path to the file holding the private key. The following formats are supported:

  • OpenSSH

  • SSH.com

  • PuTTY

You can either enter file path, or click to open the Environment Variables List. Here, you can select an environment variable to use as a file path.

This parameter is available only if you select Public Private Keys in the Client Authentication parameter (above).

Since version: 4.5

Encoding

Indicate whether to encode the scanned files. Click here for more information on encoding.

Locale Name

This is a Java locale or locale name used to parse ‘last modified’ dates in DIR text.

For example: en_US, fr, he_IL

Timeout in Milliseconds

Define the time (in milliseconds) during which the component should perform a scan.

Connect Mode

Select one of the following from the drop-down list:

  • Passive (default)

  • Active

Each file transfer (upload or download) needs an additional connection for the data stream. Usually (in active mode), the server establishes this connection. In passive mode, however, you need to establish the connection. This may be necessary when working with firewalls that do not allow connections from outside.

This parameter is available only if you select FTP in the Protocol parameter (above).

Number of Login Retries

The number of retry attempts to be performed when connection with the server has failed.

Delay Between Login Retries

The delay, in seconds, between each attempt to restore a failed server connection.

Use Secured FTP

Indicates if the FTP protocol implementation (for both the FTP and Directory Scanner components) supports and requires Secure Sockets Layer (SSL) added security. Default value is No.

Server Certificate Validation

Indicates if the FTP SSL protocol implementation requires server certificate validation. Default value is No. Displays only if Use Secured FTP is set to Yes.

Server Certificate file

The path to the server PEM format certificate. Displays only if Use Secured FTP is set to Yes.

Use Client certificate

Indicates if the FTP SSL protocol implementation requires client certificate validation. Default is No. Displays only if Use Secured FTP is set to Yes.

Client certificate file

The path to the Client PEM format certificate and private key. Displays only if Use Secured FTP is set to Yes.

Client Certificate Password

The password for the Client certificate. Displays only if Use Secured FTP is set to Yes.

Note:

  • The permission required for the FTP is drwxrw-rw- (for example: 766).

  • The FTP implicit mode is not currently supported when using an HTTP over SSL connection.

FTP resources also give you the following buttons:

Button

Description

Validate

Click this button to verify that the connection to the FTP server is valid. You will receive a message indicating that the connection is established, or an error message if the connection failed.

Server Pub

Click this button to perform the following steps automatically:

  1. Obtain the server's public key

  2. Save the key under the runtime TEMP directory.

  3. Populate the Server Validation File parameter with the file path.

This button is available only if you select SFTP in the Protocol parameter (above).

Since version: 4.5

Related Topics

Reference
Attachment 
Attachment