EmailDeliver Agent

The EmailDeliver agent is part of the Enterprise workflow service that is responsible for sending notices generated by other workflow service agents. Notices pending delivery are identified in the ST_USER_NOTICE table, where DELIVERY_TYPE = 'Email' and DELIVERED_DATE and UNDELIVERED_DATE are both null. The following variables are involved:

Notes:

•Only one instance of EarthSoft.Workflow.Agents.EmailDeliverAgent can be running.

•The EmailDeliver workflow agent will attempt to redeliver a failed email delivery up to three times before marking the process as a failure.

EQuIS Version: 7

Namespace: EarthSoft.Workflow.Agents.EmailDeliverAgent

Products Affected: Enterprise

Required Modules:

•Enterprise

•Custom Code

From Address

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	from_address	Required
STRING_VALUE	<string>		As defined by mail server

Host

ST_CONFIG	VALUE	REMARK
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	host	Required
STRING_VALUE	<hostname or ip address>	Valid host name or ip address of a mail server that is reachable from the EQuIS application server.

Port

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	port	Required
STRING_VALUE	<integer>	Network port number that mail server is listening on. Default value is 25.	See mail server configuration and firewall settings.

UseDefaultCredentials

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	useDefaultCredentials	Required
STRING_VALUE	<boolean>	Default value is false. Choose one of:	true false

Enable SSL

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	enable_ssl	Required
STRING_VALUE	<boolean>	Default value is false. Choose one of:	true false

Username

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	username	Required
STRING_VALUE	<string>		As defined by mail server

Password

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	password	Required
STRING_VALUE	<string>	This value is not encrypted by EQuIS.	As defined by mail server

Compress File Extension

Note: The Compression Threshold setting is required to enable the Compress File Extension.

ST_CONFIG	VALUE	REMARK
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	compressed_file_extension	Required
STRING_VALUE	<string>	Default value is *.zip. Some mail systems will not allow zipped attachments. Set to a different extension (such as .piz or .zzz) or leave this blank to send the attachments without compression.

Compression Threshold

ST_CONFIG	VALUE	REMARK	VALID VALUES
CONFIG_SECTION	AgentsConfigSettings	Required
CONFIG_KEY	agent	Required
OBJECT_TYPE	EmailDeliver	Required
OBJECT_VALUE	CompressionThreshold	Required
STRING_VALUE	<integer>	Maximum number of bytes for a message attachment before the attachment is compressed inside a ZIP archive. A value of 0 or no setting results in no compression being performed.	Greater than or equal to 0

Example

CONFIG_SECTION	CONFIG_KEY	OBJECT_TYPE	OBJECT_VALUE	STRING_VALUE
AgentsConfigSettings	agent	EmailDeliver	compressed_file_extension	.zip
AgentConfigSettings	agent	EmailDeliver	CompressionThreshold	5242880
AgentsConfigSettings	agent	EmailDeliver	host	exchange.example.com
AgentsConfigSettings	agent	EmailDeliver	port	995
AgentsConfigSettings	agent	EmailDeliver	enable_ssl	true
AgentsConfigSettings	agent	EmailDeliver	username	EQuIS-do-not-reply@example.com
AgentsConfigSettings	agent	EmailDeliver	password	fe12!@EFG$$%^HJ&^^&*KI#B7564f