Setting up the environment using apama_env

In most cases you do not need to do anything to set up the environment, since when using Apama from a Docker container or by installing a Debian package, the Apama tools are automatically added to the relevant path environment variables.

However there may be situations where these are not available or you have a clean (empty) environment, in which case the apama_env script can be used to ensure the correlator and Apama command line tools can be executed.

This script is designed to work from a Bash shell. Please note csh (C Shell) is not supported:

source bin/apama_env

It is important that you use source because invoking apama_env directly will not work.

Running a single Apama command

Alternatively, you can just run a single Apama command by using the apama_env script as a wrapper. This will not change the environment for your shell and you have to use the apama_env wrapper each time you run a command. This is particularly useful if you are invoking Apama commands from another program which has not had the environment set up.

You can see the syntax with:

apama_env --help

To run a single Apama command, provide the command name and arguments after the script name, for example:

apama_env correlator --config myproject