Installation

Install Axon.ivy Engine

To install the Axon.ivy Engine extract the correct zip file for your platform to the directory where you want to install the Axon.ivy Engine. For Debian based operating systems there is a convenient installer package available. The following platforms are supported:

CPU

Architecture

Operation System

Installation File

Intel

x64

Debian (Ubuntu/Mint)

axonivy-engine-V_X.Y.Z.deb

Intel

x64

Windows

AxonIvyEngineX.Y.Z_Windows_x64.zip

Intel

x64

Linux and Windows*

AxonIvyEngineX.Y.Z_All_x64.zip

Intel

x64

Linux and Windows*

AxonIvyEngineX.Y.Z_Slim_All_x64.zip

* The All and Slim_All engines are delivered with launchers for Linux and Windows, but without a JRE. To use the slim engine set up the IVY_JAVA_HOME environment variable pointing to a supported x64 JRE, or the JAVA_HOME environment variable pointing to a supported x64 JDK. The slim engine comes without demo projects.

Note

Note, that the installation procedure implies sufficient administration and access rights on the system. For example the access to drive C: on a Windows Server 2008 system is very restrictive that you might install the programs on drive D: instead.

Installing a Licence

By default a demo licence is installed that allows you to run the Axon.ivy Engine in demo mode. You have to install a licence in order to run Axon.ivy Engine in a production environment.

Note

The licence file contains the name of the host where the engine is installed on. The licence will only work if the name of the machine exactly matches the name stored in the licence file.

To install a licence file follow the steps below:

  1. Copy the licence file *.lic to the directory configuration/.

  2. Change the extension of your old licence files to anything, but *.lic (e.g. from foo_bar_another_licence.lic to foo_bar_another_licence.lic.old).

Hint

You may leave demo.lic in the configuration folder, because this licence is taken only if no other licence files are found.

Installed Files and Directories

After the installation the following files and folders are located in the Axon.ivy Engine installation folder:

Folder / File

Description

bin/

Programs to start and configure the engine

configuration/

Axon.ivy Engine configuration data

reference/

Documentation for all available configurations

templates/

Use case driven configuration templates

demo.lic

Demo licence file

ivy.yaml

Main configuration file of the Axon.ivy Engine. Configures environments such as the system database, e-mail servers, administrators and more.

ivy.cache.properties

System database cache configurations

keystore.p12

Keystore with the default signature of the Axon.ivy Engine (for https/ssl)

truststore.p12

Empty truststore can be used to add trusted server certificate for SSL connection clients

jvm.options

Java Virtual Machine (JVM) options of the Axon.ivy Engine.

log4jconfig.xml

Logging configuration

doc/

Engine-Guide, New and Noteworthy, Migration Notes and more

dropins/

Third party extension libraries that contribute to the Axon.ivy runtime

elasticsearch/

Bundled Elasticsearch server

jre/

Java Runtime Environment for Axon.ivy Engine

logs/

Log files

misc/

apache/

Files to integrate Axon.ivy into an Apache web server

iis/

Files to integrate Axon.ivy into a Microsoft Internet Information Server (IIS)

visualvm/

The Axon.ivy VisualVM plugin file

system/

The OSGi system

application/

System application

configuration/

OSGi configuration

demo-applications/demo-portal/

Demo portal application which gets deployed in demo mode

features/

Installed OSGi features

lib/boot/

OSGi boot classpath libraries

plugins/

Installed OSGi plugins. Basically all default or automatically installed java libraries of the Axon.ivy Engine

webapps/

ivy/

Axon.ivy Engine web interface

ivy/info/

Info Web Pages

ivy/WEB-INF/

Contains the web.xml file

ivy/META-INF/

Contains the context.xml file

ivy/wf/

Contains the workflow web interface

work/

Temporary files that are created and used by the Axon.ivy Engine

Windows Programs

The bin folder of a windows installation contains the following native dynamic link libraries and executable files:

File

Description

AxonIvyEngine.exe

Starts the Axon.ivy Engine. See Axon.ivy Engine.

AxonIvyEngineC.exe

Same as AxonIvyEngine.exe but additionally logs any output to a console window.

AxonIvyEngineService.exe

Executable of the Windows service. See Engine Service.

ControlCenter.exe

Program that allows to configure, start and stop the Axon.ivy Engine. It also permits to configure the Windows services. See Control Center.

ControlCenterC.exe

Same as ControlCenter.exe but additionally logs any output to a console window.

JavaWindowsServiceHandler.dll

Library that contains native methods to register, unregister, configure, start and stop windows services

JVMLauncher.dll

Library containing code to launch the Java virtual machine.

Linux Programs

The bin folder of a Linux installation contains the following script files:

File

Description

AxonIvyEngine

Starts the Axon.ivy Engine. See Axon.ivy Engine.

AxonIvyEngine.service

Template systemd script of the Linux service. It will be copied to /etc/systemd/system/ by running InstallService.sh.

ControlCenter

Program that allows to configure, start and stop the Axon.ivy Engine. See Control Center.

InstallService.sh

Script to install the Axon.ivy Engine as a daemon. See Engine Service.

launcher.sh

Helper script to launch a Java program.