Skip to main content
Version: 14

Install a Hotfix for ADOGRC 14

Installing a Hotfix for ADOGRC 14 is easier than ever before. This article covers installation of a Hotfix with the example of an existing ADOGRC 14.0 installation. Hotfixes are micro releases containing only fixes addressing software errors and security issues in the software and do not provide new functionality. 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.

These hotfixes depend on the specific minor or major version and cannot be used to do a full version upgrade. For example, if you currently have ADOGRC 14.0 installed, you will be able to install the hotfix 14.0.1 by following this guide. However, If your currently installed version is 13.3 there will be additional steps necessary to upgrade to 14.0 which are not part of this article.

note

The following guide is an example for upgrading an ADOGRC 14.0.0 installation, if you have a newer installation, please adapt the version numbers and paths accordingly.

Before you Start

Before you proceed, note the following considerations:

  • In the majority of cases, you are notified of hotfixes by your ADOGRC consultant.
  • The version format of a hotfix is 14.0.x (for example: 14.0.1 or 14.0.2).
  • Download the hotfix from the BOC website (your ADOGRC consultant will email you a link).
  • The installation utilises a full, standalone installation package.

Stop Services

First, the ADOGRC 14.0 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 ADOGRC application server (service name e.g. "ADOGRC14.0.0-ADONISServer17.0.0Service") and the Apache Tomcat web server (service name e.g. "Tomcat10").

Backup Deployment-Specific Data

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

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

ADOGRC Application Server Configuration​

  • <ADOGRC 14.0 installation folder>/conf/server.conf (contains the database name, application server or aworker processes ports, and the trusted IP address of the web server).
  • <ADOGRC 14.0 installation folder>/conf/adoxx.conf (optional, if parameters have been changed from their default value)
  • <ADOGRC 14.0 installation folder>/conf/adoxx_web_conf.js (optional, if parameters have been changed from their default value)
  • <ADOGRC 14.0 installation folder>/conf/module/afts_server.conf (optional, if the Java heap size for the full-text search engine has been increased)

Apache Tomcat Configuration​

  • <Tomcat installation folder>/webapps/ADONIS17_0/adoxx_web.properties (contains the application server IP address and definition of aworker processes)
  • <Tomcat installation folder>/webapps/ADONIS17_0/WEB-INF/classes/logback.xml (optional, if logging parameters have been changed)
  • <Tomcat installation folder>/webapps/ADONIS17_0/WEB-INF/web.xml (optional, if additional file types have been whitelisted for uploading)
  • <Tomcat installation folder>/webapps/ADONIS17_0/WEB-INF/registry/rest/RESTAuthorization.xml (part of the REST API configuration)
note

Please note that the name of the web application - and therefore the names of the respective folders - is ADONIS17_0, this is by design.

Uninstall ADOGRC 14.0

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

  • Uninstall the ADOGRC 14.0 application server. You can do this through the control panel.
  • Remove the ADOGRC 14.0 web application from Apache Tomcat. You can do this by deleting the folder <Tomcat installation folder>/webapps/ADONIS17_0 and the ADONIS17_0.war file.
note

Please note that the name of the web application - and therefore the names of the respective folders - is ADONIS17_0, this is by design.

Install and Configure ADOGRC 14.0.x Application Server

Now, it's time to install and configure the ADOGRC 14.0.x application server. Detailed instructions are provided in the following sections.

Perform Installation​

Install the ADOGRC 14.0.x application server on the designated server machine. To perform the installation:

  • Double-click setup.exe located in the 02 Application Server folder within the ADOGRC 14.0.x installation package, and then follow the instructions provided by the setup wizard.

Configure the Application Server​

After the installation is complete, configure the ADOGRC 14.0.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 folder <ADONIS 14.0.x installation folder>/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, adoxx_web_conf.js and module/afts_server.conf, 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 ADOGRC 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 application server installation and configuration tasks completed, it's now time to install the ADOGRC 14.0.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 folder <ADOGRC 14.0.x installation folder>.
  • Type aserver.exe -i to install the Windows Service (e.g. "ADOGRC14.0.0-ADONISServer17.0.0Service").

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

Install and Configure the ADOGRC 14.0.x Web Application​

Now, you need to deploy the ADOGRC 14.0.x web application 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 ADOGRC 14.0 web application. Detailed instructions are provided in the following sections.

Deploy the Web Application​

Deploy the ADOGRC 14.0.x web application to Apache Tomcat by copying the necessary files:

  • Copy the file ADONIS17_0.war to the folder Tomcat installation folder>/webapps. This file can be found in the folder 03 Web Application of the ADOGRC 14.0.x installation package.

The ADOGRC 14.0.x web application is now deployed. Do not start the Apache Tomcat service yet.

note

Please note that the name of the web application is ADONIS17_0, this is by design.

Configure Web Application​

Now, it's time to configure the ADOGRC 14.0.x web application. Unlike a new installation where you would set initial values, you will use your backup Tomcat configuration files and transfer the values from there.

To configure the web application:

  • Navigate to the folder <Tomcat installation folder>/webapps.
  • Open the file ADONIS17_0.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.
  • Save the changes.
caution

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

note

Please note that the name of the web application is ADONIS17_0, this is by design.

Start Services

Finally, the ADOGRC 14.0.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 ADOGRC application server (service name e.g. "ADOGRC14.0.1-ADONISServer17.0.1Service") and the Apache Tomcat web server (service name e.g. "Tomcat10").

You can now access ADOGRC via the same address as before the hotfix installation. The default address is: http://<SERVER_NAME>:<TOMCAT_PORT>/ADONIS17_0/. 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 of Tomcat (the default value is “8000”).