Overview

EODSfetch

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.

Background

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.

Requirements

EODSfetch is designed to run as a Windows command-line executable.

If you desire to run eodsfetch on another operating system, please contact us for details on getting a compiled python script, suitable for running in Unix-based environments.

Installation

EODSfetch is distributed as a single zip file containing an executable suitable for running on Windows. The system that runs eodsfetch must have internet connectivity to the admin site. Expand this zip file to a suitable location on the system (i.e. C:eodsfetch).

Invocation

To invoke eodsfetch from the command line, open a command prompt (from the Windows start menu), and change to the installation directory.

> cd c:eodsfetch

Then you can run "eodsfetch.exe --help" to get usage about eodsfetch. There are a number of possible parameters that can be passed to eodsfetch - each will be described to you. The usage documentation is also included in the eodsfetch.bat file, which is a useful way to customize the application to your specific needs.

Batch Configuration

eodsfetch.bat is a batch file with several examples of the usage of eodsfetch. It describes how the process works and what parameters are necessary to download the data but leave it on the server (useful for testing) or to download the data and purge it from the server (what�s typically done when running in production). Note that the purge is for the export data only and doesn�t affect the active user�s record.

You can customize the eodsfetch.bat file to use the correct parameters for your target environment.

Then, using a command-prompt, you may invoke eodsfetch.bat to execute the process.

Process Description

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.

Troubleshooting

If the process fails to connect, it may be due to the proxy configuration of the client system, or other security restrictions. First double-check that you can access the client site from you web browser using the URL, username, and password. If you can access the site through a normal web browser, then some proxy parameters may need to be supplied to eodsfetch. Your system support staff may be able to describe the proxy parameters required. Add these parameters to eodsfetch.bat (or pass them on the command-line to eodsfetch.exe).

Consider testing eodsfetch from a different location (such as from home or a cyber cafe).

If all else fails, contact us at support@hrworx.com. Please include the full output from eodsfetch.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.