5. Configure the Engine

Now, let’s configure the Axon Ivy Engine with a license and system database.

To start with that you must first request a valid Axon Ivy Engine license. Either you get a license for your productive system through one of our sales personal or contact our support for time limited trial licenses. If you do not have a license you can skip this section and continue with the next section.

Moreover, you need to have a supported database server up and running with a database user that has the rights to create new databases. The configuration and creation of the system database differs a little bit depending on the database system you use. We will use a PostgreSQL database server.

You can start the Setup Wizard on the main page of the Axon Ivy Engine (e.g. http://localhost:8080) by clicking on the link of the demo mode warning message.

On the first page use the Choose license button to install your license file or drop it inside the field.

../../../_images/engine-cockpit-setup-licence.png

Your installed license can be viewed if you click on the link at the top right. Press the Next button to continue.

On the next page, you can configure system administrators.

../../../_images/engine-cockpit-dialog-new-admin.png

Click Add Administrator, fill in the form and press the Add Administrator button.

Note

Administrators can administrate the Axon Ivy Engine. For example, they can add or remove users, assign user to roles, deploy projects, etc. Therefore, you need at least one administrator to administrate the Axon Ivy Engine. The Email addresses of administrators are used to send mail notifications if license problems occur.

On the next page configure which protocol connectors and ports the Axon Ivy Engine internal web server should provide.

../../../_images/engine-cockpit-setup-webserver.png

Note

The Axon Ivy Engine internal web server provides connectors for the following protocols:

  • HTTP Protocol used by web browser to communicate with a web server. This protocol is not secure since the communication is not encrypted. Axon Ivy Engine uses port 8080 by default.

  • HTTPS Like HTTP but secure. It uses TLS to encrypt the communication between the web browser and server. Axon Ivy Engine uses port 8443 by default.

  • AJP This protocol is used to integrate Microsoft IIS or Apache httpd as reverse proxy server. Axon Ivy Engine uses port 8009 by default. AJP is deprecated and will be removed in future versions of Axon Ivy Engine use HTTP or HTTPS to integrate a reverse proxy.

Have a look at the ivy.yaml to see what other parts of the webserver and its connectors can be adjusted for your needs.

Press the Next button.

On the next screen choose the correct Database and Driver (in our case PostgreSQL). Configure the Host and Port where your database server is running and listening. Configure the Username and Password of a database user that has the right to create a new database on the database server. Press the Create Database button.

../../../_images/engine-cockpit-setup-systemdb.png

On the appearing dialog configure the name of the Axon Ivy system database. Press the Save and create button to save and create the system database.

../../../_images/engine-cockpit-dialog-setup-systemdb-create.png

As soon as the database creation is finished you can click on the Connect button to connect to the new system database.

Note

The system database is used by the Axon Ivy Engine to store configurations, users, roles, process instances, tasks and process data

Press the Finish button.

A dialog appears (you may see configuration warnings that should be resolved first) and you can click OK to go back to the main page.

../../../_images/engine-cockpit-dialog-setup-finish.png

Switch back to the Control Center and restart the Axon Ivy Engine by stopping and starting it again.

Note, that the HTTP port of the Axon Ivy Engine may have changed. If you did change the HTTP settings. So open again a web browser and navigate to http://localhost:8080. Have you seen that the header with the Demo Mode message is gone? You now have a production ready Axon Ivy Engine.