Setting up the environment using the Apama Command Prompt
Before you can run any of the Apama tools (such as engine_send or engine_inject) or any of the Apama servers (such as the correlator or the Integration Adapter Framework which is also known as the IAF) from a normal command prompt, you have to set up your environment correctly. This includes setting the paths to the Apama installation directory, the Apama work directory, the location of the libraries, the Java location, and other environment variables. Apama provides a batch file (Windows) or shell script (UNIX) for this purpose, which is called the Apama Command Prompt.
On Windows, you invoke the Apama Command Prompt by choosing the following command from the Start menu:
Software AG > Tools > Apama n.n > Apama Command Prompt n.n
Keep in mind that Software AG is the default group name that you can change during the installation.
Alternatively, if you are already in a regular Windows command prompt, you can run the file apama_env.bat which is located in the bin directory of your Apama installation.
On UNIX, you invoke the shell script from a Bash shell. Please note csh (C Shell) is not supported. Use the following command from within your Apama installation directory:
source bin/apama_env
It is important that you use source because invoking apama_env directly will not work.
You can add the above command to your shell initialization script (which is .bashrc in the case of the Bash shell). If you do so, every shell you use will be an Apama Command Prompt.
Running a single Apama command
Alternatively, you can just run a single Apama command on either Windows or UNIX 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.
On Windows, you can see the syntax with:
apama_env.bat /?
To run a single Apama command, provide the command name and arguments after the file name, for example:
apama_env.bat correlator --config myproject
On UNIX, 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
Using an alternative CA bundle
You can use your own SSL certificate within the Apama Command Prompt. This will affect all processes within the prompt. If you do not specify an alternative certificate file, the default Apama SSL certificate is used.
To use your own SSL certificate, set the environment variable SSL_CERT_FILE to the file path of your certificate before starting the Apama command prompt.
On Windows, set the environment variable as follows:
set SSL_CERT_FILE=path-to-certificate-file
On UNIX, set the environment variable as follows:
export SSL_CERT_FILE=path-to-certificate-file
If you explicitly wish to not use a CA bundle, set SSL_CERT_FILE=none.