Command-line fetch utility for FormworX exported data. EODSfetch works by connecting to a FormworX (aka EODS) admin site, logging in, and requesting a specific URL. Usually, the specified URL is to retrieve data that has been queued for export.
+The FormworX export process has been designed to be flexible so as to be configurable for many different clients. As a result, there is no single approach for handling the export of data. This section will attempt to describe the general process followed by most clients.
+The export process is initiated by some event in the FormworX web application, usually a new hire completion event or an explicit export action. This action takes the data and prepares it for export and adds it to a queue to be retrieved at a later date.
+Running completely independent of the FormworX application is eodsfetch, which can be run manually, or as a scheduled process (using the host system's Task Scheduling capability or another scheduler such as Control-M). The task is typically scheduled to run hourly or bi-daily. Eodsfetch is a simple command-line executable that connects to the FormworX web application, retrieves any records queued for export, and saves the result to a file.
+The client then typically has a third step to somehow process the export. This step is completely customer-driven. Since the data has been retrieved into a file in the file system, many different actions can be taken. The file could be used to drive another process, or it could be pushed to another remote server.
-The eodsfetch utility works by emulating a web browser and logging into the FormworX admin site. Normally, you will need to supply the correct root URL, username, and password that is used to log into the administration site, at which point it will attempt to connect and download the data. If you're testing against a staging environment, you should be using the URL used to access your staging admin site.
+The eodsfetch utility works by emulating a web browser and logging into the FormworX admin site. Normally, you will need to supply the correct root URL, username, and password that is used to log into the administration site. With the other settings at the defaults, it should attempt to connect and download the data. If you're testing against a staging environment, you should be using the URL used to access your staging admin site.
+You may also need to specify a "retrieve command". This is a specific URL within the FormworX application which has been designed to grab the export and possibly perform additional actions. Typically, one of two retrieve commands are used: newhires/RetrieveQueuedExport and newhires/ReviewQueuedExport.do. The first command indicates to download the records queued for export and then mark them as exported so they are not retrieved in a future invocation of eodsfetch. The latter command is there primarily for testing and debugging purposes. It downloads the exact same data set as would the former, but it leaves the records in the queue, so subsequent requests will get those records again (in addition to any added since).
+Details and examples are given in the eodsfetch.bat script.