What is the ECGridOSMailboxIO.exe Web Services tool? 

The ECGridOS Windows Command Line Tool is a console program used to upload and download files using ECGridOS API Web Services over an SSL encrypted channel on port 443 (just like HTTPs on your web browser), using a simple script:


Example: ECGridOSMailboxIO {API Key} "C:\Loren Data\outbox" -upload:{ECGridID},{ECGridID} -log


Where can I find more information on the ECGridOSMailboxIO.exe web services tool?

 

Customers can visit our ECGrid GitHub page for full documentation: https://github.com/LorenData/ECGrid-API/wiki/ECGridOSMailboxIO.exe-Web-Services-Tool


What's the minimum OS version we support for the .exe tool? 


ECGridOSMailboxIO.exe uses .NET 8 for basically Windows 10 and Up.  

 

If a customer needs to support a older OS version they can use the Source on GitHub and compile their own version.

 

On the .exe tool are files automatically deleted from the inbox when they are downloaded?


When the file is downloaded ParcelConfirmDownload is called. That removes it from the inbox list. 


Is there a way for customers to see the error codes so they know if there's an issue? 


The errors display on the console or they can add "-log" to the end of the run argument to have it logged to a file. 

There is also an open source version of the program that they can download and modify to fit their needs. 


What are some troubleshooting tips in the case I run into issues?


  1. Make sure the location of the EXE also contains the ECGridOSMailboxIO.dll. config File, this contains the ECGridOS Host URL.
  2.  Make sure you can access https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx/ and it is not blocked.
  3. If the Run location is a network drive, try running from a local directory for everything. (Run location and File location.)
  4. Find out where the error is occurring, You should see the Build and Copywrite info right away, then "ECGridOS [Version number]", then ECGridOS call: ParcelInBox(), for each file Downloading:, ParcelID, etc. Then Writing File to Path ...., then  Download Complete.
    1. If you don't see the ECGridOS Version then you are having an issue connecting to ECGridOS. Check to see if the config file is missing or firewall is blocking the connection.
    2. If you don't see Download Complete then you are having an issue writing to the Inbox path. Check for permission issues for on the application.