Skip to main content
Version: 14.1

Install a Hotfix for ADONIS 14.1

Hotfixes resolve software errors and security issues. Please note that the most current hotfix always includes the modifications of previous hotfixes. Only the latest hotfix has to be installed to get all fixes.

If you are planning to install a hotfix for ADONIS 14.1, this guide will walk you through the necessary steps to ensure a smooth transition.

Before you Start​

Before you proceed, note the following considerations:

  • In the majority of cases, you are notified of hotfixes by your ADONIS consultant.

  • The version format of a hotfix is 14.1.x (for example: 14.1.1 or 14.1.2).

  • Download the hotfix from the BOC website (your ADONIS consultant will email you a link).

  • The installation utilises a full, standalone installation package.

Stop Services​

First, the ADONIS 14.1 application server and the Apache Tomcat web server have to be stopped.

To stop the services (on Windows):

  • Open Services. Press <Windows> + <R> to open the Run box, enter services.msc, and then click OK.

  • Stop the ADONIS application server (service name e.g. "ADONISNPServer14.1Service") and the Apache Tomcat web server (service name e.g. "Tomcat9").

Backup Deployment-Specific Data​

Deployment-specific data encompasses various settings and information that are not stored in the database. This includes comments on models and objects, settings such as server ports, and more.

Depending on your ADONIS 14.1 installation, you have to back up the following folders and files:

ADONIS Application Server Configuration

  • <ADONIS 14.1 application server>/conf/server.conf (contains the database name, application server or aworker processes ports, and trusted IP address of the web server).

  • <ADONIS 14.1 application server>/conf/adoxx.conf (optional, if parameters have been changed from their default value)

  • <ADONIS 14.1 application server>/conf/adoxx_web_conf.js (optional, if parameters have been changed from their default value)

Apache Tomcat Configuration

  • <Tomcat>/webapps/ADONIS14_1/adoxx_web.properties (contains the application server IP address and definition of aworker processes)

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/classes/logback.xml (optional, if logging parameters have been changed)

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/web.xml (optional, if additional file types have been whitelisted for uploading)

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/registry/rest/RESTAuthorization.xml (part of the REST API configuration)

Comment Data

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/registry/collaboration (contains XML files that hold all comments for a model or object)

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/registry/upload (contains files that were uploaded along with comments)

  • <Tomcat>/webapps/ADONIS14_1/WEB-INF/registry/axw.ids (contains the last assigned and highest comment ID)

Uninstall ADONIS 14.1​

Now that you've backed up all the relevant deployment-specific data, it's time to uninstall the currently installed version of ADONIS 14.1.

  • Uninstall the ADONIS 14.1 application server, and any other ADONIS 14.1 rich client installations for using the Administration Toolkit. You can do this through the control panel.

  • Remove the ADONIS 14.1 web application from Apache Tomcat.

note

For detailed instructions on how to uninstall, see Uninstall ADONIS.

Install and Configure ADONIS 14.1.x Rich Client​

Now, it's time to install and configure the ADONIS 14.1.x rich client, which serves as an application server and is required for using the Administration Toolkit. Detailed instructions are provided in the following sections.

Perform Installation​

Install the ADONIS 14.1.x rich client now. Depending on your deployment scenario, you must perform the following steps:

  • Install ADONIS as an application server on the designated server machine.

  • Install ADONIS for using the Administration Toolkit, for example on client machines or on a terminal server.

To perform the installation:

  • Double-click setup.exe located in the 02 Rich Client folder within the ADONIS 14.1.x installation package, and then follow the instructions provided by the setup wizard.
note

For detailed instructions on the installation process, see Install Rich Client.

Configure Application Server​

After the installation is complete, configure the ADONIS 14.1.x application server. Unlike a new installation where you'd set initial values, you will use your backup application server configuration files and transfer the values from there.

To configure the application server:

  • Navigate to the directory <ADONIS 14.1.x application server>/conf.

  • Edit the configuration file server.conf and transfer the values from your backup file, including the database name, application server or aworker processes ports, and the trusted IP address of the web server.

  • Optional: Edit the configuration files adoxx.conf and adoxx_web_conf.js, and transfer the values from your backup files if parameters in these files were previously changed.

Example

For example, if you previously modified the file adoxx_web_conf.js to set the standard language the web client should be started with, then copy the value of the parameter ADOXX_WEB_CLIENT_LANGUAGE to the new adoxx_web_conf.js file.

caution

Always merge your changes into the new configuration files - never overwrite them!

Install Application Server as a Service​

With the rich client installation and configuration tasks completed, it's now time to install the ADONIS 14.1.x application server as a service.

  • Open the Windows Command Prompt as an administrator. Press <Windows> + < R> to open the Run box, enter cmd, and then press <Ctrl> + <Shift> + <Enter>.

  • Navigate to the directory <ADONIS 14.1.x application server>.

  • Type aserver.exe -i to install the Windows Service (e.g. ADONISServer14.1.xService).

The application server is now installed as a service. Do not start the service yet.

Install and Configure ADONIS 14.1.x Web Client​

Now, you need to deploy the ADONIS 14.1.x web client and configure it using your backup Tomcat configuration files. You'll benefit from reduced configuration efforts by utilising the same Tomcat instance that already hosted the previous ADONIS 14.1 web client. Detailed instructions are provided in the following sections.

Deploy Web Client​

Deploy the ADONIS 14.1.x web application to Apache Tomcat now by copying the necessary files:

  • Copy the file ADONIS14_1.war to the directory <Tomcat>/webapps. This file can be found in the folder 03 Web Client within the ADONIS 14.1.x installation package.

The ADONIS 14.1.x web client is now deployed. Do not start the Apache Tomcat service yet.

Configure Web Client​

Now, it's time to configure the ADONIS 14.1.x web client. Unlike a new installation where you'd set initial values, you will use your backup Tomcat configuration files and transfer the values from there. You will also import the comment data.

To configure the web client:

  1. Navigate to the directory <Tomcat>/webapps.

  2. Open the file ADONIS14_1.war with a file archiver and perform the following steps on its contents:

    • Edit the configuration file adoxx_web.properties. Transfer the values from your backup file, including the application server IP address and definition of aworker processes.

    • Optional: Edit the configuration files WEB-INF/classes/logback.xml, WEB-INF/web.xml and WEB-INF/registry/rest/RESTAuthorization.xml, and transfer the values from your backup files if parameters in these files were previously changed.

    • Copy the backup folders collaboration and upload, as well as the backup file axw.ids, to the folder WEB-INF/registry.

  3. Save the changes.

caution

Always merge your changes into the new configuration files - never overwrite them!

Start Services​

Finally, the ADONIS 14.1.x application server and the Apache Tomcat web server have to be started.

To start the services (on Windows):

  • Open Services. Press <Windows> + <R> to open the Run box, enter services.msc, and then click OK.

  • Start the ADONIS application server (service name e.g. "ADONISServer14.1.xService") and the Apache Tomcat web server (service name e.g. "Tomcat9").

You can access the web client via the following address: http://<SERVER_NAME>:<TOMCAT_PORT>/ADONIS14_1/. Here, <SERVER_NAME> represents the server machine's name, and <TOMCAT_PORT> corresponds to the HTTP/1.1 Connector Port that was configured during setup (the default value is “8000”).