GR:Gravity/Xref/Locations/Advanced Settings

From Remain Software
Jump to navigation Jump to search

Other Settings

URL Parameters for location type: files

When using the location type 'files', then depending on the protocol being used, it is possible to add connection specific URL parameters to enable or disable connection and or transfer behavior. The protocols which allow the addition of URL parameters are FTP, FTPS and SFTP, for example: 

ftps://10.10.10.11/sync/sources/demo?dataProtectionLevel=C or
sftp://10.10.10.11/sync/sources/demo?strictHostKeyChecking=true


Parameter
Description
avoidPermissionCheck By default the SFTP transport mechanism checks whether the user has permission to access the location of the files. If the location user cannot be used to access the location then set this value to true, default is false.


dataProtectionLevel Set the FTPS data (channel) protection level. This defines the protection used for FTPS data connections, which are used to transmit directory listings and file data. Possible values are:
  • C – Clear (data is sent raw)
  • S - Safe (SSL protocol only)
  • E - Confidential (SSL protocol only)
  • P - Private

The default value is P (highest security level). C and P are supported by most FTP servers.


connectionTimeout Set the SFTP/FTPS/FTP connection timeout value. Default is 180000ms.


dataTimeout Set the FTPS/FTP data timeout value. Default is 180000ms. Setting this value too low may cause the transfer of large files to fail.


passiveMode Enable/disable FTP passive mode. The mode needs to be enabled when the FTP client and server are not in the same network. Default value is true (enabled).


readTimeout Set the FTPS/FTP socket read timeout value (the time a read will block). If not set then a read will not timeout. Setting this parameter may help solve blocking FTP control commands.


strictHostKeyChecking If this parameter is set to yes then the add of new host key will not be performed automatically (i.e. added to the file $HOME/.ssh/known_hosts), and refuses to connect to hosts of which the host key has changed. The value of yes forces the user to manually add all new hosts. If parameter is set to no then a new or host key will be automatically added to the user known hosts file. Default value is no.


userDirIsRoot If set to true then the user's home directory will be the base directory for the URL provided path. If set to false then the OS root directory will be used (user must have sufficient privileges).

Configuring a Proxy Server for FTP and SFTP

Proxy server-specific parameters can be set as URL query parameters. Proxy settings can be globally set with Eclipse preferences. By providing and setting values in the preferences Network Connection page:

Eclipse proxy settings.png

If you are not using Eclipse settings or you need to override the Eclipse settings then you can provide proxy URL parameters, for example, to use Proxy over FTP, you could specify the URL as follows: 

ftp://192.168.1.10/sources/demo?proxyServer=192.168.1.1&proxyPort=8080 or
sftp://10.10.10.11/sync/sources/demo?proxyServer=10.10.10.01&proxyPort=3128&proxyUsername=user&proxyPassword=password

Below are the URL parameters that can be set:


Parameter
Description
proxySet Determines if a proxy is to be used for the URL. This enables you to selectively enable proxy settings on a per location basis.
proxyServer The IP address or DNS name of the proxy server. .
proxyPort The port number on which the proxy server is listening for requests. If this parameter is not set then the port will be determined by the system.
proxyType The proxy server type. This can be HTTP or SOCKS. If the proxy server type is not specified or an unknown proxy server type is set, then the proxyType will be HTTP.
proxyUsername The user name of the proxy server.
proxyPassword The password of the proxy server.
timeout The connection timeout in milliseconds. Default value is 5000ms.
retryCount The number of retry attempts in case of a connection timeout. Default value is 5.


Setting a Proxy server for FTP and SFTP

Proxy server parameters can be set on the location URL as query parameters. For example, to use Proxy over SFTP, specify the URL as follows:

sftp://10.10.10.11/sync/sources/demo?proxyServer=10.10.10.01&proxyPort=3128&proxyUsername=user&proxyPassword=password Following are the URL query parameters that can be set:

  • proxyServer The DNS or IP address of the proxy server.
  • proxyPort The port number on which the proxy server is listening.
  • proxyType The proxy server type. This can either be HTTP or SOCKS. The default is HTTP.
  • proxyUsername The user name of the proxy server.
  • proxyPassword The password of the proxy server.
  • timeout The connection timeout in milliseconds. The default value is 5000.
  • retryCount The number of retry attempts in case of a connection timeout. The default value is 5.