Install on Linux

Guided Installation

The installation for Linux is provided through a .sh Bash script. It has been tested on Ubuntu 22.04.

To install ADOxx or an ADOxx based tool on Linux:

1. Download the .zip package with the installation files for Linux from the ADOxx homepage.
2. Extract the downloaded .zip file to a location of your choice.
3. Open a terminal window and navigate to the extracted location.
4. Execute the script ./install_on_linux.sh.
   • If the script can not be executed, then give it execution permissions with the command chmod +x ./install_on_linux.sh and try again.
5. Follow the instructions of the installation script.
   
   • Dependencies are installed as necessary during this step.
   • Your administration password is required for the installation.

In case you face any issues during installation, please have a look at the corresponding Troubleshooting section.

Guided Uninstallation

To uninstall ADOxx or an ADOxx based tool on Linux:

1. Open a terminal window and navigate to the of the installer files (extracted location for installation).
2. Execute the script ./uninstall_on_linux.sh.
   • If the script can not be executed, then give it execution permissions with the command chmod +x ./uninstall_on_linux.sh and try again.
3. Follow the instructions of the uninstallation script.

Wine

ADOxx and ADOxx based tools require Wine to run on Linux, which is installed as part of the installation process. Only remove Wine if you no longer need it for any other applications, for example other ADOxx based tools etc.

Dependencies

ADOxx and ADOxx based tools require the following to run on Linux:

• Wine: Necessary to run the Windows applications.

Additionally the tool requires a database to store the data:

• Currently the default database system used is SQLite.
• Alternatively Microsoft Azure SQL Edge can be used via an ODBC connection. See Using Microsoft Azure SQL Edge as DBMS for details.

Manual Installation

The following describes the steps necessary to manually install and set up the ADOxx platform on Linux. It can be roughly described by the following steps:

1. Install necessary dependencies.
2. Install the database management system.
3. Create a Wine-prefix.
4. Copy the ADOxx application files.
5. Set up the ADOxx database.
6. Create shortcuts for the Development Toolkit and the Modelling Toolkit.

Adapt the commands in the following sections as necessary for your system and the used ADOxx tool version.

Install Dependencies

1. Install Wine through your package manager of choice.
   • When using apt, run the command sudo apt install wine to install Wine.

Install Database Management System

The current version of ADOxx uses SQLite for managing a simple database file by default. No special installation is needed for this case, as the necessary files are provided with ADOxx.

If necessary, it is also possible to use a Microsoft Azure SQL Edge to manage the database. Some details are described in the Using Microsoft Azure SQL Edge as DBMS section.

Create Wine-prefix

1. Create a Wine-prefix where ADOxx will run out of.
   • Run a command like: LANG=en_US WINEARCH=win64 WINEPREFIX=${HOME}/.wine_adoxx18 WINEDEBUG=-all wine64 cmd /c exit

Copy ADOxx Application Files

1. Extract the contents of the .zip file containing the built ADOxx files, for example install-support/ADOxx_1.8.0.zip, to a folder in the Wine-prefix, for example "${HOME}/.wine_adoxx18/drive_c/Program Files/BOC/ADOxx_1.8.0/" (in Wine: "C:\Program Files\BOC\ADOxx_1.8.0\").

Set Up Database

1. Run the asetlic.exe tool from the ADOxx installation directory with the arguments "-plicense.ini" "-Lalicdat.ini" and specify the customer number and license number.
   • Run a command like: LANG=en_US WINEARCH=win64 WINEPREFIX=${HOME}/.wine_adoxx18 WINEDEBUG=-all wine64 "C:/Program Files/BOC/ADOxx_1.8.0/asetlic.exe" "-p${HOME}/.wine_adoxx18/drive_c/Program Files/BOC/ADOxx_1.8.0/license.ini" "-L${HOME}/.wine_adoxx18/drive_c/Program Files/BOC/ADOxx_1.8.0/alicdat.ini"
2. Run the adbinst.exe tool from the ADOxx installation directory.
   • Run a command like: LANG=en_US WINEARCH=win64 WINEPREFIX=${HOME}/.wine_adoxx18 WINEDEBUG=-all wine64 "C:/Program Files/BOC/ADOxx_1.8.0/adbinst.exe"
3. In the dialog specify:
   • the "Database name", which should be between 3 and 8 characters long and should only use ASCII letters and numbers,
   • the "License number",
   • select "SQLITE" as the "Database system",
   • select "WITHOUT Single-Sign-on" for "Single-Sign-on installation option",
   • mark "Create new database"
     
4. Select "OK".

By default the database files are located in the folder %APPDATA%\ADOxx\sqlitedbs\ of the Wine-prefix. The environment variable ADO_SQLITE_DBFOLDER (must be set in the Wine-prefix) can be used to specify a path to a different folder where the database files should be stored instead.

Some ADOxx based tools come with example models / Attribute Profiles. These are located in the adostd.adl file inside the application's folder. After finishing the installation import them through the Modelling Toolkit by switching to the "Import/Export" component and selecting the menu Model -> ADL Import -> Models/Attribute profiles....

Create Shortcuts

The easiest way is to copy the provided shortcuts and icons located in install-support/ into the correct folder for your system. On Ubuntu this would be ${HOME}/.local/share/applications/ for the shortcuts and ${HOME}/.local/share/icons/ for the icons. If necessary, adapt the scripts in the shortcuts as needed.