EarthSoft.Net ftpSettings

Earthsoft.net ftpSettings define the default values loaded when a new instance of EarthSoft.Common.Net.FtpClient is created. They are set when FtpRetrieve agent settings are set by the Workflow widget and are typically the same values. EQuIS supports FTP, FTPS, and SFTP.

EQuIS Version: 7

Namespace: EarthSoft.Common.Net

Products Affected: Enterprise

Required Modules:

•Enterprise

•Custom Code

Warning: ST_CONFIG table settings where the CONFIG_SECTION = "AgentsConfigSettings" will override the STRING_VALUE value where CONFIG_SECTION = "earthsoft.net" for records where the values for OBJECT_VALUE are the same.

•It is recommended to configure the "AgentsConfigSettings" values to match the "earthsoft.net" settings so any values being overridden remain the same.

•Please see the FtpRetrieve article for more information about "AgentsConfigSettings" and "earthsoft.net" settings.

Host

ST_CONFIG	VALUE	REMARK
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	host	Required
STRING_VALUE	<hostname or ip address>	Valid host name or IP address of an FTP server that is reachable from the EQuIS application server.

Port

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	port	Required
STRING_VALUE	<integer>	Network port number that mail server is listening on.	Default value is 21. The port will be 22 for the SFTP. See FTP server configuration and firewall settings.

Protocol

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	protocol	Required
STRING_VALUE	<string>	Null value will default to "ftp"	Choose from: "ftp", "ftps", or "sftp"

SSL

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	ssl	Required
STRING_VALUE	<boolean>	Default value is False Choose one of:	True False

Pasv

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	pasv	Required
STRING_VALUE	<boolean>	Default value is True. Choose one of:	True False

Remote Folder

ST_CONFIG	VALUE	REMARK
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	remoteFolder	Required
STRING_VALUE	<string>	This is the folder on the FTP server that EQuIS should scan for files. If on an FTP server, this value should begin with the '/' character. On a Linux / Unix server, this value should not begin with the '/' character unless referencing a full path to the folder as seen by the file system.

Mask

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	mask	Required
STRING_VALUE	<string>	Default value is . to avoid attempts to retrieve folders.	Globing file name mask for files that should be retrieved. For example, *.zip would limit the search to files with the .zip file name extension.

Username

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	username	Required
STRING_VALUE	<string>		As defined by FTP server

Password

ST_CONFIG	VALUE	REMARK
CONFIG_SECTION	earthsoft.net	Required
CONFIG_KEY	ftpSettings	Required
OBJECT_TYPE	inbox	Required
OBJECT_VALUE	password	Required
STRING_VALUE	<string>	As defined by FTP server. Please note that this value is NOT encrypted in EQuIS. Permissions on this login should be limited to retrieving EDDs from the remote folder and deleting them when transfer is complete.

Example

CONFIG_SECTION	CONFIG_KEY	OBJECT_TYPE	OBJECT_VALUE	STRING_VALUE
earthsoft.net	ftpSettings	inbox	host	ftp.example.com
earthsoft.net	ftpSettings	inbox	port	21
earthsoft.net	ftpSettings	inbox	ssl	true
earthsoft.net	ftpSettings	inbox	pasv	true
earthsoft.net	ftpSettings	inbox	remoteFolder	/edd
earthsoft.net	ftpSettings	inbox	mask	*.zip
earthsoft.net	ftpSettings	inbox	username	example\username
earthsoft.net	ftpSettings	inbox	password	fe12!@EFG$$%^HJ&^^&*KI#B7564f