Installation of Engine on Redhat or Fedora

 

Requirements

GLIBC - 2.28 Requirement

To run Engine we require Glibc version 2.28 for this reason please ensure you are running on:

  • Fedora 35 or newer
  • Redhat 8.1 or newer 

 

Xvfb Requirement

To run Eflow as a daemon we require Xvfb. This will be also be run as a daemon and will act as a virtual display for Eflow. By default it will run as DISPLAY :1 >> sudo yum install Xvfb

 

Additional Requirements if running on AWS EC2 Instance

To run on AWS EC2 Instance, libxkbcommon and libxkbcommon-x11 must be installed:

  • >> sudo yum install libxkbcommon
  • >> sudo yum install libxkbcommon-x11

If running a Redhat environment on AWS EC2 Instance libxkcommon is installed, but not its components so run

  • >> sudo yum install xcb-util-image
  • >> sudo yum install xcb-util-renderutil
  • >> sudo yum install xcb-util-keysyms
  • >> sudo yum install xcb-util-wm

Installation

These processes must be run as a sudo user.

  1. In terminal navigate to the location of the rpm.
  2. Install the provided rpm:
    • >> sudo yum install engine-eval-x.x.x-1.x86_64.rpm 

 

 Licence Activation

Important: At this point, please switch to the engine user i.e the user that you would like Engine to be run as going forward. The licence must be activated with this user and this will be the only user that the Engine will be able to run successfully with.

  1. Start Engine Configurator Application by either double clicking the app or: >> /usr/bin/emotion/Engine-Configurator
  2. A licence dialog should appear. When prompted, enter your licence code or contact Emotion Systems () for your licence code. 

 

Daemon Setup 

These processes must be run as a sudo user.

To setup Eflow to run as a Daemon, the following steps need to be followed.

  1. Ensure that Xvfb is installed. This will be also be run as a daemon and will act as a virtual display for Eflow. By default it will run as DISPLAY :1 >> sudo yum install Xvfb
  2. A script is provided in the installation that will enable Eflow to be run as a daemon. This script must be run as the root user, but you can supply an engine user for the daemons to run as, provided that you have activated the Engine licence with this engine user. If no username is given the default will be to run the daemons as root. If you did not configure your licence as the root user then you will encounter licence errors running the daemons as root. >> sudo /usr/bin/emotion/emotionDaemonSetup.sh engine_user
  3. If at any point you need to change the daemon user: >> sudo /usr/bin/emotion/setDaemonUser.sh new_user

Eflow listens on port 44544. Your firewall may need to be adjusted to allow connections over a network

 

Rabbit Setup 

Engine utilises the RabbitMQ Messaging System to progress and file updates to be broadcast. Important: Engine is designed to work with a particular version of RabbitMQ or older.

These processes must be run as a sudo user.

  1. This script sets up the RabbitMQ config file with the user credentials and plugins needed by Engine. It will also setup RabbitMQ to run as a Daemon.
    • >> sudo /var/lib/EmotionData/rabbitmq/emotionRabbitSetup.sh 

Eflow will need to be restarted after the RabbitMQ Installation.

 

Upgrading an Existing Engine 

  1. If Eflow is running Stop Eflow: >> systemctl stop Eflow
  2. In terminal navigate to the location of the newly provided rpm.
  3. Upgrade to the provided Rpm: >> sudo yum update engine-eval-x.x.x-1.x86_64.rpm

Select the require Operating system from the drop downs – we recommend centos 7.

Reinstalling an Existing Engine

If you wish to install an Engine of the exact same version: 

  1. If Eflow is running Stop Eflow: >> systemctl stop Eflow
  2. In terminal navigate to the location of the newly provided rpm.
  3. Upgrade to the provided Rpm: >> sudo yum reinstall engine-eval-x.x.x-1.x86_64.rpm

 

 Switching from Evaluation to Permanent Version of Engine 

  1. Remove evaluation versions of Engine by >> sudo yum remove engine-eval
  2. Install the provided permanent rpm: >> sudo yum install engine-perm-x.x.x-1.x86_64.rpm

Note - the yum remove statement only needs engine-eval or engine-perm, and must not have the version number etc part of the filename include. 

IMPORTANT - sudo yum remove will also remove the EmotionData folder. This contains databases that store workflows and settings. Please back this up in a different location if you would like to preserve the databases. Please contact if you need assistance. Downgrading an Existing Engine

Scroll down to Security and access - SSH keys.

Click add item. Then copy the contents to of the public SSH key into the text box

Note to get the contents you can open the sshkey.pub with various text editor tools and simply CTRL A, CTRL C, to copy the contents. Then paste them into the google webpage.

 

Downgrading an Existing Engine  

If you wish to install an older version of Engine

  1. If Eflow is running Stop Eflow: >> systemctl stop Eflow
  2. In terminal navigate to the location of the newly provided rpm.
  3. Upgrade to the provided Rpm: >> sudo yum downgrade engine-eval-x.x.x-1.x86_64.rpm

 

Remove Evaluation Version of Engine 

  1. Remove evaluation versions of Engine by >> sudo yum remove engine-eval

 

Remove Permanent version of Engine 

Important: It is vital you contact Emotion Systems () if you are removing your Licence and wish to transfer it to another machine. Contact Emotion Systems before removing Engine

  • 1. Release the Licence via the Engine Configurator App.
  • 2. Remove the Engine Installation package from the machine: >> sudo yum remove engine-perm

 

Generic Troubleshooting 

Terminal: Yum Lock

This usually means another terminal on the same machine is currently use yum commands. If this is the case simply wait till the yum processes have finished. Otherwise it is likely a command was interrupted and the machine will likely need a restart.

 

Unable to Upgrade, Downgrade of Reinstall Engine

If changing the Engine version fails it is recommended to contact Emotion Systems support ().

If using an evaluation Licence remove Engine:

  • >> sudo yum remove engine-eval

then install the new version of engine

  • >> sudo yum install engine-eval-x.x.x-1.x86_64.rpm

 

 Eflow Daemon Not Running

If after setting up and starting the daemons using the script emotionDaemonSetup.sh eflow is not running it is recommend to contact support.

A few steps to help fix or solve the problem are:

  1. Check the log files in /var/lib/EmotionData/Logs for an Eflow log file of the todays date.
  2. Using the Engine Configurator app. In Advanced options click the service management option. Then Click the restart button to restart Eflow.
  3. Check the Eflow daemon status: >> systemctl status Eflow 

If Eflow is not current running or present start it or run the emotionDaemonSetup script. 

 

ESP Jobs Returning "Software Failed Unexpectedly" 

This issue may be related to Xvfb.

Xvfb runs as a daemon and acts as a virtual display for Eflow. By default it will run as DISPLAY :1.

A few steps to help fix or solve the problem are:

  1. Check that Xvfb is installed.
  2. Go to xvfb.service file (in /etc/systemd/system)
  3. Find the line " ExecStart=/usr/bin/Xvfb :1 -screen 0 1280x1024x8 +extension RANDR”
  4. Change the display and screen if needed. 5. Go to eflow.service file (in /etc/systemd/system)
  5. There should be line "Environment=DISPLAY=:1”
  6. Change this to correct display
  7. To apply the change: >> systemctl daemon-reload

 
Need assistance? Contact