We first will describe the terminology used in Avantra with respect to versions, patches, upgrades, etc.
Avantra consists of several software components. Each of these components has a particular version number, and the whole Avantra suite has a version number as well.
The version number for Avantra always has the format
minor being numbers. The Avantra version described in this document is 23. We also use the term release as a synonym for version.
Every Avantra component has a version number in format
[major].[minor] denotes the Avantra version the component belongs to, and
patch-level indicates the particular patch level of the component.
With every new release of Avantra, the version number changes (at least the
minor version number), and the
patch-level of every component is set to
0. Patches will be released on a per component level comprising first of all bug fixes. The Avantra Server, and the Avantra Agent share a common
patch-level at the time of release.
Details can be found in the Release Notes.
As a general rule, all Avantra components sharing the same
[major].[minor] version prefix are compatible to each other, regardless of the particular patch level. Also, as a general rule, components having a different
[major].[minor] version prefix are not compatible!
In order to support smooth version upgrades Avantra Server components ensure a certain degree of compatibility to Avantra Agents with a lower
[major].[minor] version number. This is described in a more formal way in the Release Notes.
When we talk about applying patches we mean to replace a particular Avantra component with one that shares the same version number except for the
The procedures how to apply patches are described in Applying Patches at the very end of this chapter.
When we talk about version upgrades or (short) upgrades we mean to lift the whole Avantra installation from one
[major].[minor] version to the next.
The major part of this chapter describes how to perform a version upgrade of Avantra.
Not every Avantra release will include updates to the SAP Transports and, where possible, all transports are backward compatible which allows you to upgrade your Server and Agents independent of your SAP Transports. If the latest Avantra release comes with new transport requests it will be listed under the contributions in the download area.
Please make sure to read the release notes prior to upgrades to ensure you are aware of any compatibility notices.
Follow these steps to upgrade your Avantra Server components to Version 23:
avantra-server-23.0-win64.exefrom the SERVER RELEASE 23.0 section at the Support menu of avantra.com.
Open the installer, push Next on the welcome screen and accept the license using the I agree option on the license screen.
You are asked to install either the Avantra Server, the UI, or both. Usually you will leave the default and install both. Push Next to continue.
Choose an appropriate installation location and push Next.
Choose the ports for incoming HTTP and or HTTPS connections of the web UI. You may push the Verify Ports button in order to check if the ports are free. Press Next.
Verify the Windows Firewall configuration rules that will be added to your system. Press Next to proceed.
Choose the (Windows) user to run the Windows services as. If you use Windows Authentication for the Microsoft SQL Server (which is the default in Step 4 of the Procedure: Installing Microsoft SQL Server Express Edition), make sure you use the same user here as for the Microsoft SQL Server.
If you did not change the command in Step 4 of Procedure: Installing Microsoft SQL Server Express Edition, leave it to the default
LocalSystemhere. If your Microsoft SQL Server is running with a different user, fill in the same user. Press Next to proceed.
On the final screen, make sure you have checked Install UI and Server and push Finish.
avantra-server-23.0-[os].binfrom the AVANTRA SERVER RELEASE 23.0 section at the Support menu of avantra.com.
Make sure the file is executable. Otherwise:
xandria$ chmod 755 avantra-server-23.0-[os].bin
Perform one of the following steps:
If your existing Avantra WebUI installation is listening on a port ≥ 1024, (with or without redirecting some port < 1024 to the actual Avantra WebUI port) execute the following as user
root$ chown -R xandria:xandria /syslink/xangui root$ chown -R xandria:xandria /syslink/.xandria
Please make sure to change the
XANGUI_USER=rootentry in the header of the
XANGUI_USER=xandria. Command below uses
vias editor, please use any editor you are familiar with.
root$ vi /syslink/xangui/rc.xangui
Perform the following steps as user
If your existing Avantra WebUI installation is listening on a port < 1024, and you have no redirect scenario in place perform the following steps as user
It is recommended to run Avantra processes with a lower privileged OS user than
root, so you change the Avantra WebUI port during this upgrade.
On Linux operating systems, the Avantra server and the UI restart automatically after an upgrade, however, without support for systemd commands (this will be fixed in our future releases). For now, to avoid additional steps to stop and restart Avantra services, we recommend using the following install command for Linux:
sh avantra-server-20.11.n-linux.bin -- --no-start
The installer requires a suitable Java Runtime Environment to run. It usually finds it automatically based on the existing installation. If no suitable Java Runtime Environment is found, you can specify one like this:
xandria$ ./avantra-server-23.03-[os].bin -- --jvm=[path_to_java_executable]
[path_to_java_executable]the absolute path of the
Yes, it’s really
--first and then
In some cases, the following additional operations may be required:
On the Avantra WebUI Post Upgrade Steps page push the Start post upgrade steps button.
Once finished, click Start Avantra UI.
You have the option to upgrade Avantra Agents manually or automatically (recommended).
Before upgrading an Avantra Agent, please ensure the required transports are installed to prevent errors. See 21.11 Upgrade Path for more information.
Make sure to upgrade to Java 8 Runtime Environment before you upgrade the Avantra Agents.
The Agent Self Updates work as follows:
There is just one(!) upgrade package for the Avantra Agent which is valid for all supported operating systems. It is included in the distribution packages and available as separate download at the Support menu of avantra.com.
The packages are named
On Unix-like operating systems these are the same packages you use for the normal installation.
On Microsoft Windows operating systems this package is used for Agent Self Updates as well, but there is an extra package provided for the initial installation which cannot be used for the automatic upgrade.
In order to avoid too many Avantra Agents trying to download the packages at the same time, the update requests are queued. Only update-simultaneous-downloads update requests are triggered at the same time and there is a delay of schedule-wait-time before the next bunch of update requests is triggered, etc. These two parameters can be configured as described in Change Properties for the WebUI.
As soon as the Avantra Server transfers the update request to the Avantra Agent, the latter one spawns a child process to start downloading the upgrade package while the Avantra Agent continues to run normally.
If there is anything going wrong, Avantra Agent tries its best to fully recover itself, for example, it tries to roll back to the previous version.
During the upgrade process, verbose status messages are sent back to the Avantra Server. Avantra WebUI will display the current status and all log messages of the update attempt, so you can watch the update process periodically.
While the whole process usually works very smoothly, there are a few items to observe:
- Small is beautiful
- Version Information
On Microsoft Windows operating systems the version information shown in the Programs and Features dialog of the control panel will not be updated!
In order to upload packages, perform the following steps:
Selectfrom the top-level menu. Select the Packages tab. Choose Upload from the toolbar.
Choose the packages from your computer and start the upload.
In order to trigger the upgrade perform the following steps:
Selectfrom the top-level menu. Select from the toolbar.
Fill in appropriate values for the Selectors and push OK.
Choose the appropriate version from the drop-down list and set the flags on the Servers you want to update.
Confirm your selection by pushing the Start Agent Update button.
The Status tab contains the latest status information about the recently scheduled agent updates. You may want to choose the value
Running and Errorsfrom the drop-down list in the toolbar to watch the update progress.
|See Troubleshooting Agent Updates in case of any issues.|
Java 8 is recommended.
Make sure the installer file
agent-[version].bin is located in the installation directory of the Avantra Agent, i.e.
agent-[version].bin file with the same operating system user the agent is running currently.
Please make sure that the OS user can (at least temporarily) write to
The installer will notice that a previous version already exists and take care of the upgrade process. It will test whether the agent directory and therein the file ./lib/xandria_agent.jar exist to decide whether it performs an update or fresh install. That way it is possible to prepare a directory
agent/jre, put a JVM installation into a folder
agent/jre/1 and then run the agent bin installer. The installer then detects if there is no agent installed and performs a fresh installation.
Please make sure that the link to the agent start scripts in your
init.d directory (depends on your Unix) are updated to the new start scripts at
The version of transport required is linked to the Avantra Agent installed. Please check the Avantra transports document to ensure the correct version is installed to prevent errors occurring.
Please perform the following steps:
Identify both transports that need to be used, see the description and release information in the
ReadMe.txtfile within the transports'
Import both (corresponding to your release) transports (customizing and workbench) in the client where the RFC User
AVANTRA_RFC. You may select Ignore Invalid Component Version.
If you have this user defined in another client, please also import the customizing (role) transport in this additional client.
Be sure that the profile has been generated correctly and that it is the only one granted to this user, i.e. delete all other profiles and roles not specified here.