Quick Start Guide

  • Purpose: get your first edi configuration running.

  • This is done by installing plugin my_first_plugin; this plugin provides a working configuration.

  • When run, this configuration will read and write example edi messages (provided in the plugin) from your system.

  • In this configuration incoming EDIFACT ORDERS are translated to a fixed file format.

Install plugin ``my_first_plugin``

  1. Assumed is:
  2. Now download the plugin my_first_plugin (ZIP file) from the Bots Plugins package registry.

  3. Install the plugin using the menu bots-monitor->SysTasks->Plugins->Read Plugin. Complete instructions for installing a plugin are here.

  4. You should see a message similar to Plugin "my_first_plugin.zip" is read successful.

../_images/quick-start-1-read-plugin.png

Activate the route

  1. Go to the routes screen: bots-monitor->Configuration->Routes.

  2. Note that route myfirstroute is not active now (indicated by red icon).

  3. Select the tick-box in front of the route myfirstroute.

  4. Select action activate/de-activate.

  5. Click on the ‘Go’ button on the right of the selected action.

  6. Note that route myfirstroute is active now (indicated by green icon).

../_images/quick-start-2-route-active.png

Run the translation

  1. Run the translation: bots-monitor->Run->Run (Only New).

  2. You will get notified that the bots-engine is started.

  3. Bots-engine is the part of bots that does the translations and communications; it runs in the background. Bots-engine will be finished in approximately one second.

View the results

Now let’s view the results of the translation:

  1. First look at the results of the run: bots-monitor->All runs->Reports (per run). Each run of bots is represented by a line; the last run is on top. The green icon should indicate that the run was successful.

  2. View the incoming files via bots-monitor->Incoming->Last Incoming. You should see 3 files. Click on the incoming file name (InFile column) to see its contents.

  3. View the outgoing files in OutFile column (the results of the translation) go to or bots-monitor->Outgoing->Last outgoing. Again: click on the file name to see its contents.

  4. Note: this configuration reads the incoming files but does not delete them. So you can run it over and over again.

../_images/quick-start-3-incoming-files.png