EagleML API Client - Synchronous Mode

Overview

To enable synchronous mode enter in the console:

To launch a single extract you can determine all necessary parameters directly in console with the "-data=" option, for example:

When you want to launch several extracts or just want to read all parameters from a file, use the "-file=" option:

Read more about formatting such files

Step-by-Step Process Description

In synchronous mode the client works like this:

• Sends a RunTastRequest for extract.

• Waits for the TaskStatusResponse from server.

• Parses the TaskStatusResponse to understand if its task status is SUCCESS, FAILED or NO_DATA.

  • If the status is SUCCESS, extracted data will be uploaded as an archive file and saved in the temporary folder with correlation id as its name. (temporary folder is the system %TEMP%, e.g., C:\Users\admin\AppData\Local\Temp - this folder is not purged automatically)

    • If a folder is specified in the "resultsdir" parameter, the extract data will be unzipped and stored in this particular folder.

    • If "resultsdir" is not specified or empty, the extract remains unzipped in the temp folder.

  • ​If the status is FAILED or NO_DATA, error description will be displayed.

• The client will move to the next extract on the list.