efdManagementConfiguration.FileMonitor

<< Click to Display Table of Contents >>

EQuIS 7  >>  Configuration > ST_CONFIG Entries > Enterprise Workflow >

efdManagementConfiguration.FileMonitor

 

EarthSoft Workflow File Monitor agent loads EDD files in to an EQuIS Database in preparation for processing by Enterprise EDP. The agent can be completely customized through development of a custom client assembly (DLL). The Default client assembly ( EarthSoft.Workflow.Clients.Default ) supports all the capabilities of other Client Assemblies. The major difference between Default and the other Client Assemblies is the EDD file naming convention.

 

FileMonitor configuration includes definition of EDD delivery Channels and the Client Assembly associated with them.

 

EQuIS Version: 7

 

Namespace: EarthSoft.Workflow.Clients

 

Products Affected:

oEnterprise

oProfessional

oEDGE

oEDP Stand Alone

 

Requires Module:

oEnterprise Workflow Service

 

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

efdManagementConfiguration


Required

CONFIG_KEY

FileMonitor


Required

OBJECT_TYPE

channel


Required

OBJECT_VALUE

EML

FTP

WEB

<custom>

object_value defines a three character channel designation that maps to a sub-folder of the workfolder setting.

Choose One

STRING_VALUE

<class name>


EarthSoft.Workflow.Clients.Default.DefaultFileMonitor

EarthSoft.Workflow.Clients.Default.DataFileMonitor

EarthSoft.Workflow.Clients.Default.SplitByFacilityFileMonitor

or as directed by EarthSoft.

 

Remarks:

 

By default, EarthSoft defines three channels:

WEB - EDDs uploaded via EQuIS Enterprise EDP Upload widget or Sign and Submit web service.

EML - EDDs retrieved from email box monitored by Email Retrieval agent.

FTP - EDDs retrieved from remote FTP server by Ftp Retrieval agent.

Additional channels may be declared as desired so long as the channel designation is no more than three characters long.

 

The DataFileMonitor will look for text files in the channel and repackage them in ZIP containers with a designated user certificate. To accomplish this, DataFileMonitor requires two additional entries in st_config (see example). Those entries combine the literal "FileMonitor.' with the channel name from object_value

<USER_ID>: Enterprise EDP requires that an EDD contain a user certificate identifying the data submitter. <USER_ID> is the USER_ID (from ST_USER) of the user that DataFileMonitor will use for creating the user certificate. This user will become the data submitter of the EDDs as the EDDs are processed by EnterpriseEDP.

·<FILE_NAME>: Enterprise EDP assumes a specific file naming convention for each EDD. The name of the EDD needs to identify the facility to which the data will be loaded and the name of the EDD format. <FILE_NAME> is a string that will be used as a template for the EDD file name that DataFileMonitor produces. It may contain the following (case sensitive) place holders:

oo{fileDate:yyyyMMdd_HHmm}: This place holder will be replaced with the last write time of the incoming data file (based on server time). This place holder is typically used to ensure uniqueness in the EDD file name.

oo{fileName}: This place holder will be replaced with the name (without file extension) of the incoming data file.

 

The SplitByFacilityFileMonitor supports a few EDP Formats that include FACILITY_CODE in the primary key of the EDD. These EDDs are split into separate EDDs which are resubmitted for processing.

 

Example:

 

Default configuration.

 

config_section

config_key

object_type

object_value

string_value

efdManagementConfiguration

FileMonitor

channel

EML

EarthSoft.Workflow.Clients.Default.DefaultFileMonitor

efdManagementConfiguration

FileMonitor

channel

WEB

EarthSoft.Workflow.Clients.Default.DefaultFileMonitor

efdManagementConfiguration

FileMonitor

channel

FTP

EarthSoft.Workflow.Clients.Default.DefaultFileMonitor

 

DataFileMonitor Example:

 

Creates a new channel named RMT that accepts tab delimited or CSV text files uploaded to the application server via 3rd party tools. These text files are repackaged as ZIP archives with a user certificate for user_id 12345 and submitted to the Springfield facility using the EZEDD format.

 

config_section

config_key

object_type

object_value

string_value

efdManagementConfiguration

FileMonitor

channel

RMT

EarthSoft.Workflow.Clients.Default.DataFileMonitor

efdManagementConfiguration

FileMonitor.RMT

user_id

12345


efdManagementConfiguration

FileMonitor.RMT

file_name

{fileDate:yyyyMMdd_HHmm}.SPRINGFIELD.EZEDD.zip