FtpRetrieve Agent

The FTP Retrieval agent is part of the Enterprise workflow service that polls a remote File Transfer Protocol (FTP) server, scans the folder designated, and moves any files that match the mask to the FTP sub-folder of the EQuIS work folder. It is assumed that an FTP channel is defined for the FileMonitor agent. See the FTP Retrieval Setup and Troubleshooting article in the Enterprise chapter for additional information. EQuIS supports FTP, FTPS, and SFTP. The FTP Retrieve agent can also connect to an Azure Blob Storage account using SFTP.

Note: Only one instance of EarthSoft.Workflow.Agents.FtpRetrieveAgent can be running.

EQuIS Version: 7

Namespace: EarthSoft.Workflow.Agents.FtpRetrieveAgent

Products Affected: Enterprise

Required Modules:

•Enterprise

•Custom Code

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"

Host

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
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. Note: if connecting to an Azure Blob Storage account using SFTP, it is necessary to remove everything and including the '@' symbol in the host name.

Port

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
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 file wall settings.

SSL

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
OBJECT_VALUE	ssl	Required
STRING_VALUE	<boolean>	Default value is False Choose one of:	True False

SSL Remarks

The SSL setting is only applicable for FTP, not SFTP.

Pasv

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
OBJECT_VALUE	pasv	Required
STRING_VALUE	<boolean>	Default value is True. Choose one of:	True False

Pasv Remarks

The PASV setting is only applicable for FTP, not SFTP.

Remote Folder

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
OBJECT_VALUE	remoteFolder	Required
STRING_VALUE	<string>	This is the folder on the FTP server that EQuIS should scan for files. If the FTP server's operating system is Windows, 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	AgentsConfigSettings	Required
CONFIG_KEY	agent	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	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
OBJECT_VALUE	username	Required
STRING_VALUE	<string>		As defined by FTP server Note: if connecting to an Azure Blob Storage account using SFTP, prefix the Azure Storage Account name to the sftp username (separated by a period) to get the full username.

Password

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	<service_name>	Begins with "FtpRetrieve"	One of the SERVICE_NAME from the ST_SERVICE_RESERVATION table, where object_name='EarthSoft.Workflow.Agents,EarthSoft.Workflow.Agents.FtpRetrieveAgent'
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 (FTP)

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

Example (SFTP)

CONFIG_SECTION	CONFIG_KEY	OBJECT_TYPE	OBJECT_VALUE	STRING_VALUE
earthsoft.net	ftpSettings	inbox	protocol	SFTP
AgentsConfigSettings	agent	FtpRetrieve	mask	*.zip
AgentsConfigSettings	agent	FtpRetrieve	host	sftp.example.com
AgentsConfigSettings	agent	FtpRetrieve	port	22
AgentsConfigSettings	agent	FtpRetrieve	remoteFolder	/edd
AgentsConfigSettings	agent	FtpRetrieve	username	example\username
AgentsConfigSettings	agent	FtpRetrieve	password	fe12!@EFG$$%^HJ&^^&*KI#B7564f

Example (connect to an Azure Blob Storage account using SFTP):

CONFIG_SECTION	CONFIG_KEY	OBJECT_TYPE	OBJECT_VALUE	STRING_VALUE
earthsoft.net	ftpSettings	inbox	protocol	SFTP
AgentsConfigSettings	agent	FtpRetrieve	mask	.
AgentsConfigSettings	agent	FtpRetrieve	host	examplesftp.blob.core.windows.net
AgentsConfigSettings	agent	FtpRetrieve	port	22
AgentsConfigSettings	agent	FtpRetrieve	remoteFolder	EDDs
AgentsConfigSettings	agent	FtpRetrieve	username	examplesftp.sftpretrieveagent
AgentsConfigSettings	agent	FtpRetrieve	password	NotARealPassword