DataFileMonitor

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > Installation and Configuration > Configuration > Enterprise EDP Configuration >

DataFileMonitor

EQuIS Enterprise EDP expects incoming EDD files to be compressed (zipped) files containing the EDD data files and the data submitters user certificate (*.usr). In some scenarios, such as system integration, it may be desirable to have individual data files processed by Enterprise EDP. For example, a LIMS or other tool may produce flat files, but not have the ability to produce *.zip files with the user certificate. DataFileMonitor is designed to accommodate this scenario. DataFileMonitor will watch for data files, then zip each file and add the user certificate for further processing by Enterprise EDP.

 

To enable DataFileMonitor, you must create the following records in your ST_CONFIG table (values in bold should be entered exactly as shown; values in italics you should enter as described below):

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

efdManagementConfiguration

FileMonitor

channel

<CHANNEL>

EarthSoft.Workflow.Clients.Default.DataFileMonitor

efdManagementConfiguration

FileMonitor.<CHANNEL>

user_id

<USER_ID>

 

efdManagementConfiguration

FileMonitor.<CHANNEL>

file_name

<FILE_NAME>

 

 

<CHANNEL>: Enterprise EDP tags EDD files with the "channel" through which the EDD was received. The default channels in Enterprise EDP are WEB (EDDs received via web upload), FTP (EDDs received via FTP), and EML (EDDs received via email). In order to use DataFileMonitor, you need to first determine the "channel" name for the data files that DataFileMonitor will process. You should choose a channel name that is no more than three characters long and identifies the source of the files. For example, you may use the name LMS to represent files coming directly from a LIMS system, or perhaps CSV to represent comma-separated files exported from another system. You can create as many DataFileMonitor channels as you need by giving each of them a different name.

<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 Enterprise EDP.

<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:

{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.

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

 

After adding the records to ST_CONFIG, you need to restart the EQuIS Enterprise Workflow service on the application server. Upon restarting, the Workflow service will create a new folder for the channel you specified. The folder will be created within workfolder as specified in ST_CONFIG:

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

efdManagementConfiguration

workfolder

 

 

C:\Windows\Temp\equisworkflow

 

You will need to configure the third party application to export the files to the C:\Windows\Temp\equisworkflow\<CHANNEL> folder.

 

For example, suppose you:

 

have a LIMS that produces comma-separated value files (*.csv); and

the *.csv files are in the EZEDD format; and

you want the EDDs to be "submitted" by a user with USER_ID = 329; and

you want the EDDs to be loaded into the SPRINGFIELD facility (aka FACILITY_CODE = 'SPRINGFIELD')

your workfolder setting in ST_CONFIG is C:\Windows\Temp\equisworkflow

 

You can have Enterprise EDP automatically process these files by adding the following records to ST_CONFIG:

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

efdManagementConfiguration

FileMonitor

channel

LMS

EarthSoft.Workflow.Clients.Default.DataFileMonitor

efdManagementConfiguration

FileMonitor.LMS

user_id

329

 

efdManagementConfiguration

FileMonitor.LMS

file_name

{fileDate:yyyyMMdd_HHmm}.SPRINGFIELD.EZEDD.zip

 

 

After adding these records to ST_CONFIG, restart the EQuIS Enterprise Workflow service. Upon restarting, the service will create a folder called C:\Windows\Temp\equisworkflow\LMS. Configure the LIMS to export the *.csv files into the ...\equisworkflow\LMS folder. As the files are exported, DataFileMonitor will pick them up and register them in ST_FILE_REGISTRATION, where they will continue to be processed as normal EDDs.