Skip to main content
Version: 14.1

Upgrade from ADONIS 13.0 to ADONIS 14.1

If you are planning to upgrade from ADONIS 13.0 to ADONIS 14.1, this guide will walk you through the necessary steps to ensure a smooth transition.

Prerequisites​

Before you proceed, note the following prerequisites:

  • Before installing, make sure that all Hardware/Software Requirements are met.

  • Download the ADONIS 14.1 installation package (your ADONIS consultant will email you a link).

  • Create a backup of the ADONIS database.

Application Library for ADONIS 14.1

You can get started right away if you are using the default library that comes with ADONIS (the ADONIS BPMS Application Library).

Please contact your ADONIS consultant if you are using a different application library. This includes ADONIS BPMS Application Libraries with changes in the metamodel or functional extensions or other specific libraries. You may need a new version of your library.

Stop Services​

First, the ADONIS 13.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 ADONIS application server (service name e.g. "ADONISServer13.0Service") and the Apache Tomcat web server (service name e.g. "Tomcat9").

Export Component Settings​

Component settings allow you to adapt a wide range of library-specific features. To ensure you don't lose your settings during the upgrade, it's essential to export the ADONIS 13.0 component settings now. Later, you will have to re-import them after updating the application library.

To export the component settings:

  • In the ADONIS 13.0 Administration Toolkit, go to Library Management > Component Settings.

  • Select your library, and then click Export component settings.

  • Select Export all component settings to export all settings at once. Alternatively, you can clear the check box and select the component settings you want to export.

  • In the Export file box, enter a name for the export file.

  • Click Export. The data is exported.

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 13.0 installation, you have to back up the following folders and files:

ADONIS Application Server Configuration

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

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

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

Apache Tomcat Configuration

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

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

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

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

Comment Data

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

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

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

Install and Configure ADONIS 14.1 Rich Client​

Now, it's time to install and configure the ADONIS 14.1 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 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 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 application server. Unlike a new installation where you'd set initial values, you will use your backup ADONIS 13.0 application server configuration files and transfer the values from there.

To configure the application server:

  • Navigate to the directory <ADONIS 14.1 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 changed in ADONIS 13.0.

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!

Update Application Library​

Next, your application library needs to be updated.

How Does This Affect My Library?

  • If you are using the default ADONIS BPMS Application Library: Databases created with ADONIS 13.0 can still be used with ADONIS 14.1. However, you will not have access to improvements in the ADONIS BPMS Application Library. Optional: Update the library in the ADONIS database. A new version of the ADONIS BPMS Application Library can be found in the folder 04 Sample Data\Library in the installation package.

  • If you are using an   ADONIS BPMS Application Library with changes in the metamodel: Databases created with ADONIS 13.0 can still be used with ADONIS 14.1. However, you will not have access to improvements in the ADONIS BPMS Application Library. Optional: Contact your ADONIS consultant to upgrade your application library.

  • If you are using an ADONIS BPMS Application Library with functional extensions or another specific library: Please contact your ADONIS consultant to clarify if a new version of your specific library is required before you proceed. Update the library in the ADONIS database if you received a new library file.

Perform Update

To upgrade your application library:

  1. Start the ADONIS 14.1 Administration Toolkit and log in to the ADONIS database.

  2. Go to Library Management, select your library, and then click Update library.

  3. Click Search... and select the file you want to import.

  4. Clear the Do not import component settings check box.

    note

    If Do not import component settings is disabled, your existing component settings will be overwritten with those from the import file. This is necessary for adding new component settings not present in ADONIS 13.0. Later, you will re-import your exported component settings to restore your previous settings for all component settings that were already present in ADONIS 13.0.

  5. Click Import. The library is updated.

Import Component Settings​

If you've updated the application library in the previous step, it's time to re-import your exported component settings.

To import the component settings:

  • In the ADONIS 14.1 Administration Toolkit, go to Library Management > Component Settings.

  • Select your library, and then click Import component settings.

  • Click Search... and select the file you want to import. Then, click Import.

  • Click All to select all component settings for import, and then click OK. When prompted to continue, click Yes. The data is imported.

Execute Migration Script​

If you're using the ADONIS BPMS Application Library, and updated it, it's essential to execute a migration script at this point. You can find this script in the ADONIS 14.1 installation package under 05 Migration.

Why a Migration Script?

The ADONIS BPMS Application Library has evolved from ADONIS 13.0 to ADONIS 14.1, incorporating methodical improvements. To prevent potential data loss, you need to adjust your repository content to fit the new method, and this is where the migration script comes into play.

To execute the migration script:

  1. In the ADONIS 14.1 Administration Toolkit, go to Settings > Execute JavaScript file.

  2. Click Search... and select the file 14.0 - repo.js. Then, click Execute.

note

For details on the script, see Migration Scripts.

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 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 application server>.

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

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

Install and Configure ADONIS 14.1 Web Client​

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

Deploy Web Client​

Deploy the ADONIS 14.1 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 installation package.

The ADONIS 14.1 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 web client. Unlike a new installation where you'd set initial values, you will use your backup ADONIS 13.0 Apache 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 changed in ADONIS 13.0.

    • 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!

Uninstall ADONIS 13.0​

You've completed the ADONIS 14.1 installation; now, it's time to uninstall ADONIS 13.0.

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

  • Remove the ADONIS 13.0 web application from Apache Tomcat.

note

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

Start Services​

Finally, the ADONIS 14.1 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.1Service") 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”).