Install EDI Translator

The EDI Translator is used to convert data into EDI format. It runs on localhost and listens on port 9191 by default. This is controlled via the edi_webrick.cnf file located in the edi_translator directory. It should not be necessary to edit this configuration if you install EDI Translator on the same server used for running Action/Triggers events.


If you are running Evergreen with a multi-server configuration, make sure to install EDI Translator on the same server used for Action/Trigger event generation.

Steps for Installing

  1. As the opensrf user, copy the EDI Translator code found in Open-ILS/src/edi_translator to somewhere accessible (for example, /openils/var/edi):

    cp -r Open-ILS/src/edi_translator /openils/var/edi
  2. Navigate to where you have saved the code to begin next step:

    cd /openils/var/edi
  3. Next, as the root user (or a user with sudo rights), install the dependencies, via "". This will perform some apt-get routines to install the code needed for the EDI translator to function. (Note: subversion must be installed first)

  4. Now, we’re ready to start "edi_webrick.bash" which is the script that calls the "Ruby" code to translate EDI. This script needs to be started in order for EDI to function so please take appropriate measures to ensure this starts following reboots/upgrades/etc. As the opensrf user:

  5. You can check to see if EDI translator is running.

    • Using the command "ps aux | grep edi" should show you something similar if the script is running properly:

      root    30349  0.8  0.1  52620 10824 pts/0      S       13:04   0:00 ruby ./edi_webrick.rb
    • To shutdown EDI Translator you can use something like pkill (assuming no other ruby processes are running on that server):

      kill -INT $(pgrep ruby)

Install EDI Scripts

The EDI scripts are "" and "" and are used to "push" and "fetch" EDI messages for configured EDI accounts.

  1. As the opensrf user, copy and from Open-ILS/src/support-scripts into /openils/bin:

    cp Open-ILS/src/support-scripts/ /openils/bin
    cp Open-ILS/src/support-scripts/ /openils/bin
  2. Setup the and scripts to run as cron jobs in order to regularly push and receive EDI messages.

    • Add to the opensrf user’s crontab the following entries:

      10 * * * * cd /openils/bin && /usr/bin/perl ./ > /dev/null
      0 1 * * * cd /openils/bin && /usr/bin/perl ./ > /dev/null
    • The example for sets the script to run at 10 minutes past the hour, every hour.
    • The example for sets the script to run at 1 AM every night.


You may choose to run the EDI scripts more or less frequently based on the necessary response times from your vendors.