Skip to Content
Technical Articles

SAP HANA 2.0 XS Advanced Installation – by the SAP HANA Academy

Update November 2020

For the latest information about SAP HANA 2.0 SPS 05, see

For just the highlights, see

For information about how to get to the latest release, see

Any good? Post a comment, share on social media, and/or give a like. Thanks!

/wp-content/uploads/2016/02/sapnwabline_885687.png

Introduction

Recently, we have updated a number of SAP HANA Academy tutorial videos for the playlist

In this blog, I will provide some references and background information about the SAP HANA XS Advanced (XSA) runtime.

This blog is part of a series:

 

SAP HANA Academy – SAP HANA Installation and Update (YouTube Playlist)

 

Tutorial Video

In this tutorial video, we cover where to download the latest version of both the SAP HANA XS Advanced runtime and the different XS Advanced components; how to perform an installation of the runtime together with SAP HANA database server; and how to perform an update of a server installation to add the XSA runtime component using the SAP HANA database lifecycle management tool (hdblcm) in graphical, web, and command-line mode; how to perform an unattended installation of the XSA runtime with hdblcm in batch mode and the use of a response file.

SAP HANA Academy – XS Advanced

 

SAP HANA XS Advanced Model

Whereas installing the SAP HANA (database) server maybe takes 15 minutes on a bad day, installing the SAP HANA XSA runtime will take a good 90 minutes. To understand why this is the case, it is good to have a basic understanding of the XSA architecture.

For a gentle introduction, see

Unlike the xsengine process of XS classic, the XS Advanced runtime is not built-in/embedded into the SAP HANA database server and needs to be installed separately.

The XSA runtime comprises four operating system processes:

  • xsconstroller (Controller, FileSystem Broker, Platform Router)
  • xsexecagent (Execution Agent)
  • diserver (Deployment Infrastructure Server)
  • xsuaaserver (User Account and Authentication (UAA) service, UAA broker, HDI broker)

The runtime has its own role (xs_worker) and can be included with the SAP HANA server on a single-host installation, on a distributed system for load balancing, and on a dedicated host in a multi-host environment, including as a standby system (xs_standby role) for high availability configurations:

 

XS Advanced system concepts

 

The images below are from the Developer and Administration/Security guides (same paragraph) and illustrate the functionality which the different services provide.

For more information about the architecture, see

XS Advanced system architecture

 

Technical System Landscape of XS Advanced Application Server

 

Software Downloads

You can download the latest version of the XS Advanced runtime and the XSA components from the SAP ONE Support Portal. This works exactly the same as for the other SAP HANA components.

Navigation path: H > SAP HANA PLATFORM EDITION > SAP HANA PLATFORM EDITION 2.0: SUPPORT PACKAGES AND PATCHES

The table below lists the XSA components for SAP HANA Platform Edition 2.0

Software Component Support Package Patches Note
XS_ADVANCED_RUNTIME XS RUNTIME 1 2582204
XS_ADVANCED_RUNTIME SAP EXTENDED APP SERVICES 1 2582204
XS_MONITORING XS MONITORING 1 2465860
XS_SERVICES XS SERVICES 1 2465860
XS_JAVA XS JAVA 1 2465860
XS_JAVASCRIPT XS JAVASCRIPT 1 2465860
XSAC_ALM_PI_UI XSAC_ALM_PRODUCT_INSTALLER_UI1 2495800
XSAC_XSA_COCKPIT XSA COCKPIT 1 2465860
XSAC_SAP_WEB_IDE SAP WEB IDE 2 2457320
XSAC_HRTT SAP HANA RUNTIME TOOLS 2.0 2373065
XSAC_FILE_PROC XSAC FILEPROCESSOR 1.0 2419428
XSAC_PORTAL_SERV XSAC_PORTAL_SERVICES 1.0 2590066
XSAC_UI5_FESV2 SAPUI5 FESV2 XSA 1 2451647
XSAC_UI5_FESV3 SAPUI5 FESV3 XSA 1 2458437
XSAC_XMLA_INT XSAC XMLA INTERFACE FOR HANA 1 2494696
XSAC_SHINE SAP HANA DEMO MODEL ADV. 1 2239095
XSAC_MIGRATION XSAC MIGRATION 1 2493252
XS_GERRIT XS GERRIT 2 2503815

 

SAP Software Downloads – Support Packages and Patches

 

The XSA runtime and XSA components are included in the SAP HANA 2.0 platform edition installation media.

Most components are included in the XSA_CONTENT_10 directory but not the SAP Web IDE for SAP HANA, the migration toolkit, and the Database Explorer (Runtime Tools: HRTT).

The XS clients for Windows, Linux and macOS are provided as compressed zip files in the XSA_CLIENT_10 directory. The installation steps are documented in

 

The XSA runtime directory contains the SAP HANA lifecycle management tools hdbsetup (graphical), hdbinst, hdbsetup and hdbuninst but these utilities should not be executed directly. On the SAP HANA server, always install components using the SAP HANA Database Lifecycle Manager (hdblcm).

SAP HANA 2.0 platform edition – 51052325 extracted

 

SAP HANA XS Advanced Runtime Installation

To install the XSA runtime and the different XSA components, you can choose to run the SAP HANA Lifecycle Management tool in graphical (Windows), web or command-line mode.

For the web version, you can start the tool from the SAP HANA cockpit, SAP HANA studio, or directly using the SAP host agent URL [ https://<host>:1129/lmsl/HDBLCM/<SID>/index.html ]

SAP HANA Platform Lifecycle Management – URL

Start the installation from the Install or Update Additional Components tool.

The first step is to indicate to the tool where the installation media is located using the Add Software Locations button.

SAP HANA Lifecycle Management – 1. Add Software Locations

Next, select the SAP HANA XS Advanced Runtime component for installation.

SAP HANA Lifecycle Management – 2. Select Components

In step 3, you can add additional hosts in case you want to create a distributed system and define the host role for the XSA runtime (xs-worker or xs_standby). You will be prompted if you want to assign the XS runtime roles to the hosts with database roles (see above, section XSA system concepts).

SAP HANA Lifecycle Management – 3. Additional Hosts Properties

In step 4, you need to provide the passwords for the operating system administration account <sid>adm and for the system and tenant database SYSTEM accounts. This is not XSA specific but related to the SAP HANA server.

In step 10 (steps 6, 7, 8, and 9 are for Streaming, Dynamic Tiering, Accelerator and Remote Data Sync – when selected), we get to the screen where we can define the XS Advanced Runtime parameters.

For more information about each of the parameters, see

For more information about the organization and customer space name (and the impact of running applications in customer spaces with separate operating system users), see

For more information about routing mode and domain names, see

SAP HANA Lifecycle Management – 10. Configure XS Advanced Runtime

When the checkbox ‘Run Applications in Customer Space with Separate OS User’ is selected, you are prompted to set the operating system user ID for the SAP and customer space users (Linux). In a distributed (multi-host) environment, these need to be the same.

SAP HANA Lifecycle Management – 11. Configure XS Advanced Space OS User Properties

In the last step, step 13, you can select the XSA components that you want install together with the runtime. Note that not all components are selected by default.

You can run the SAP HANA Lifecycle Management tool again to install (or update) additional XSA components at a later stage. Alternatively, you can use the XS client command ‘xs install’ to add components:

SAP HANA Lifecycle Management – 12. Choose XS Advanced Components to be Installed

The last screen lists all selections made for review and confirmation.

SAP HANA Lifecycle Management – 14. Review and Confirm

Install using Windows

To run the SAP HANA Lifecycle Management tool in graphical mode, just run the hdblcmgui command from the installation media from the Lifecycle Management directory (HDB_LCM_LINUX_X86_64). To run the tool in graphical mode, an X-Windows environment needs have been installed and configured. This might be a bit of an issue as typically the SAP HANA server will have a minimal installation without X-Windows environment.

Running HDB_LCM_LINUX_X86_64/hdblcmgui

In the print screens below, you can see that the dialogs in the version are exactly the same as for the web version. The same is true for the command-line.

SAP HANA Lifecycle Management (hdblcmgui) – Detected Software Components

SAP HANA Lifecycle Management (hdblcmgui) – Add Hosts

SAP HANA Lifecycle Management (hdblcmgui) – XS Advanced Runtime Properties

Unattended Installation with Response File

To automate SAP HANA XS Advanced runtime installations (or XSA component updates), you can run the SAP HANA Lifecycle Management tool in batch mode with a response file.

Installation automation is the topic of another blog in this series, so I will just highlight the required steps here.

First, create a template file with the hdblcm parameter ‘–dump_configfile_template=<filename>’

SAP HANA Lifecycle Management (hdblcm) – Create Config File

Next, you need to edit the template file to provide the required parameters. You use the online help from hdblcm for the specific syntax of the parameters. Alternatively, of course, you can also look them up in the documentation:

Most parameters will have a default value.

SAP HANA Lifecycle Management (hdblcm) – configfile 

Once the response file (template file) and password file have been prepared, we can run the hdblcm command in unattended mode (–batch or -b) specifying the action, the template file and to read the password file from STDIN.

SAP HANA Lifecycle Management (hdblcm) – hdblcm in batch mode

 

Installing SAP HANA XS Advanced Runtime…

The installer first extracts (unzip) the different components and proceeds to stop the SAP HANA system after which the runtime will be installed (Installing package…) and the system started again. This is the system downtime phase and takes about a minute.

Next, we can see that the SAP HANA XS runtime processes are started: hdbxscontroller, hdbxsexecagent, and hdbxsuaaserver.

Installing SAP HANA XS Advanced Runtime…

With the runtime processes started, initial content is loaded and the spaces are created.

Loading initial content

Next, the different services and applications are created that support the infrastructure. This phase ends with the API (URL) of XS Controler, with default HTTPS port 3<instance_number>30 (for port-based routing). This is the API endpoint to use with the XS client.

XS Controller API End Point

In the next phase, the XSA components (Cockpit, SAP UI5, etc.) are installed. Depending on the number of components selected, this will take some time.

The installer exits with an URL for feedback and the location of the log files, should any issue have occurred.

SAP HANA Database components updated

Apps!

Once the runtime is up and running and the XSA components installed, we can connect to the controller with the XS client.

In the print screen below, the XS client included with the SAP HANA XS runtime installation is used. You can also install the XS client on a Microsoft Windows, Linux, or Apple macOS computer. This topic will be discussed in a subsequent blog in this series.

To connect, you will need to provide the API_URL, which refers to the XS Controller API, together with the administration user you created during the installation in step 10 Configure XS Advanced Runtime.

xs login

With the ‘xs apps’ command, we can then list the apps running in space “SAP”, their status, and urls.

xs apps

You can use the URLs to access the different XSA applications in a browser. Below the xsa-admin application, the web interface for XS Advanced Administration.

XS Advanced Administration

References

For more information see:

SAP HANA Academy Playlists

SAP Downloads

SAP Documentation

SAP Blogs

Notes

/wp-content/uploads/2016/02/sapnwabline_885687.png

Share and Connect

Questions? Post as comment.

Useful? Give a like and share on social media. Thanks!

If you would like to receive updates, connect with me on

For the author page of SAP Press, visit

/wp-content/uploads/2016/02/sapnwabline_885687.png

17 Comments
You must be Logged on to comment or reply to a post.
  • Hi Denys

     

    Good to see this summary of all the different components and notes in one place.

    Its been quite a journey to find all the right docu for our system.

    We have setup a new system: HANA  2.0 with AFL, APL, XSA, Webide, DWF

    For installing DWF I followed https://launchpad.support.sap.com/#/notes/2435452 which said you need to install  XSACALMPIUI12. But this gives me these errors:

    #2.0#2018 02 05 18:16:23.886#Z#ERROR#com.sap.lm.sl.alm.5241.MAIN_LOG#
    ######com.sap.lm.sl.alm.prod.installer.process.steps.StepsUtil########pool-7-thread-3###
    [PollStateStep] Error resolving merged descriptor properties and parameters: No configuration entries were found matching the filter specified in resource “product-installer-url”
    No configuration entries were found matching the filter specified in resource “product-installer-url”#

     

    Looking at note 2495800 I get the impression that the ALM can only be installed on a HANA cockpit system. 

    Is that correct?

    BTW DWF is working now, without XSACALMPIUI

     

    gr

    Sander van Gemert

     

     

  • Hi Denys

    I’ve installed XS Advanced and SAP HANA DW Foundation 2.0 on a HANA 2.0 System.

    After the installation I’ve tried to create a NDSO according to this guide: NDSO Admin Guide

     

    According to section 3.1 Pct. 4: “Right-click the project and create an HDB module. Use the CDS editor to model the NDSO. Check the Create DataStore Artifacts box. This is necessary to create an NDSO.”

    If i do a right click on the project then I get the option of creating a SAP HANA Database Module.

    Is this the same as HDB module? I assume yes but would like to have a confirmation.

     

    Second issue that I’m having is that I’m missing the “Create DataStore artifacts” in the “Template Customization step”.

    The DWF Rolle collection is assigned to my user.

    Any idea what might be the cause?

     

    Cheers

    M

     

     

     

     

    • Hi Marian,

      Yes, HDB stands for HANA Database Module.

      If you are missing the “Create Datastore artifacts” checkbox, it might be that you have not turned on the DW Foundation feature. Please go to the Web IDE settings (little wheel icon on the left) > Features > SAP HANA Data Warehouse Foundation > change setting to “On”.

      When changing that setting, you should also be able to create a DW Foundation template to start with, instead of starting with an MTA template and then creating an HDB module. The DW Foundation template does not only give you NDSO functionality, but also Taskchains and Data Lifecycle Manager profiles.

      Kind regards,

      Sefan

    • Hi Denys,

      Thanks for all those education videos on youtube.

      I am trying to install XSA on an installed HANA 2.0. I am able to go through the motions in hdblcmweb but get an error when I hit Update.

      On reviewing the tracefile I see the following:

      22:35:25.515 – INFO: Parameter ‘cannot_resume_pending_update’ (CannotResumePendingUpdate) is set to value = ‘Yes’

      22:35:25.515 – ERR : Mandatory parameter ‘resume_pending_update’ (ResumePendingUpdate) is missing or invalid

      Wondering where I can go from here. Are there some files that I need to delete or set CannotResumePendingUpdate or cannot_resume_pending_update to ‘No’ somewhere. I have done a find for these in all the files under /hana without luck (did not find a property file). I did find reference to CannotResumePendingUpdate in the file : /hana/shared/CAS/hdblcm/resources/nonresident/resident/views/common/update/PendingUpdateProperties.view.js

      I am kind of stuck!

      Would welcome your guidance.

      Best,

      Arun

  • Great job Denys,

    Still a year after you created this – it helped me get my head round how all the XSA stuff is packed up and installed.  Keep up the great work, very much appreciated.!

  • Hi Denys,

    Thanks for all those education videos on youtube.

    I am trying to install XSA on an installed HANA 2.0. I am able to go through the motions in hdblcmweb but get an error when I hit Update.

    On reviewing the tracefile I see the following:

    22:35:25.515 – INFO: Parameter ‘cannot_resume_pending_update’ (CannotResumePendingUpdate) is set to value = ‘Yes’

    22:35:25.515 – ERR : Mandatory parameter ‘resume_pending_update’ (ResumePendingUpdate) is missing or invalid

    Wondering where I can go from here. Are there some files that I need to delete or set CannotResumePendingUpdate or cannot_resume_pending_update to ‘No’ somewhere. I have done a find for these in all the files under /hana without luck (did not find a property file). I did find reference to CannotResumePendingUpdate in the file : /hana/shared/CAS/hdblcm/resources/nonresident/resident/views/common/update/PendingUpdateProperties.view.js

    I am kind of stuck!

    Would welcome your guidance.

    Best,

    Arun

    • Hi Arun,

      Resume update is documented in the SAP HANA installation and update guide:

      However, this concerns the parameter specified BEFORE starting the installation. There is no (documented) resume_pending_update parameter.

      --action=update --prepare_update

      The web client hdblcmweb depends on the SAP Host Agent.

      Could you try to run the tool in command line mode?

      /hana/shared/CAS/hdblcm/hdblcm

       

      • Hi Denys,

         

        cmd line hdblcm seems to have worked. Once the install happened tried to login to xs.  However did not see any apps running with xs apps. I tried changing the target spaces without luck. Where should I look from here?

        The log itself said all good with one error at the end of this note.

        % xs target -s SAP

        API endpoint: https://myhost:30030 (API version: 1)
        User: xsa_admin
        Org: orgname
        Space: SAP

        % xs apps

        Getting apps in org “orgname” / space “SAP” as xsa_admin…
        Found apps:
        No apps found

        Thanks for your time and help.

        Best,
        Arun

         

        Output line 151: ERROR: Fatal error occurred during installation

        Output line 152: com.sap.xs2rt.core.installation.exceptions.InstExceptionBase: Failed to register tenant DB.

        Output line 153:        at com.sap.xs2rt.installation.impl.hana.tenant.RegisterTenantDb.install(RegisterTenantDb.java:34)

        Output line 154:        at com.sap.xs2rt.installation.steps.InstallationStep.installAndMeasure(InstallationStep.java:156)

        Output line 155:        at com.sap.xs2rt.installation.procedures.InstallationProcedure.executeStep(InstallationProcedure.java:118)

        Output line 156:        at com.sap.xs2rt.installation.procedures.InstallationProcedure.perform(InstallationProcedure.java:218)

        Output line 157:        at com.sap.xs2rt.installation.impl.hana.content.HanaContentInstallUpdateProcedure.main(HanaContentInstallUpdateProcedure.java:122)

        Output line 158: Caused by: com.sap.xs2rt.installation.impl.hana.tenant.TenantUtils$TenantException: FAILED to calculate container group name: SAP DBTech JDBC: [258]: insufficient privilege: Detailed info for this error can be found with guid ’86D2C05C7756274ABCFD41781E7D6A5C’

        Output line 159:        at com.sap.xs2rt.installation.impl.hana.tenant.TenantUtils.registerTenantDb(TenantUtils.java:1095)

        Output line 160:        at com.sap.xs2rt.installation.impl.hana.tenant.RegisterTenantDb.install(RegisterTenantDb.java:32)

        Output line 161:        … 4 more

        Output line 162: Caused by: com.sap.db.jdbc.exceptions.JDBCDriverException: SAP DBTech JDBC: [258]: insufficient privilege: Detailed info for this error can be found with guid ’86D2C05C7756274ABCFD41781E7D6A5C’

        Output line 163:        at com.sap.db.jdbc.exceptions.SQLExceptionSapDB._newInstance(SQLExceptionSapDB.java:195)

        Output line 164:        at com.sap.db.jdbc.exceptions.SQLExceptionSapDB.newInstance(SQLExceptionSapDB.java:45)

        Output line 165:        at com.sap.db.jdbc.packet.HReplyPacket._buildExceptionChain(HReplyPacket.java:848)

        Output line 166:        at com.sap.db.jdbc.packet.HReplyPacket.getSQLExceptionChain(HReplyPacket.java:165)

        Output line 167:        at com.sap.db.jdbc.packet.HPartInfo.getSQLExceptionChain(HPartInfo.java:39)

        Output line 168:        at com.sap.db.jdbc.ConnectionSapDB._receive(ConnectionSapDB.java:4225)

        Output line 169:        at com.sap.db.jdbc.ConnectionSapDB.exchange(ConnectionSapDB.java:1665)

        Output line 170:        at com.sap.db.jdbc.StatementSapDB._executeDirect(StatementSapDB.java:1648)

        Output line 171:        at com.sap.db.jdbc.StatementSapDB._execute(StatementSapDB.java:1622)

        Output line 172:        at com.sap.db.jdbc.StatementSapDB._execute(StatementSapDB.java:1583)

        Output line 173:        at com.sap.db.jdbc.StatementSapDB._executeQuery(StatementSapDB.java:1539)

        Output line 174:        at com.sap.db.jdbc.StatementSapDB.executeQuery(StatementSapDB.java:204)

        Output line 175:        at com.sap.xs2rt.installation.impl.hana.content.InitializeHanaBroker.getContainerGroups(InitializeHanaBroker.java:1290)

        Output line 176:        at com.sap.xs2rt.installation.impl.hana.content.InitializeHanaBroker.existContainerGroup(InitializeHanaBroker.java:1311)

        Output line 177:        at com.sap.xs2rt.installation.impl.hana.content.InitializeHanaBroker.getUniqueContainerGroupName(InitializeHanaBroker.java:1333)

        Output line 178:        at com.sap.xs2rt.installation.impl.hana.tenant.TenantUtils.registerTenantDb(TenantUtils.java:1091)

        Output line 179:        … 5 more

        Program terminated with exit code 1

        Switching back to root user.

      • Hi Denys,

        Uninstalled and re-installed and that worked – command line definitely better wrt control.

        So, thanks for the support.

        Best,
        Arun

  • Hi Arun,

    You mentioned in your e-mail

    After doing a bit of troubleshooting saw that the xscontroller would not start because of FQDN problem (https://apps.support.sap.com/sap/support/knowledge/en/2673550). When I installed accepted the default of mds-hana.openstack.na-us-1.cloud.sap for xsa. I guess this is the reason for the apps not starting up, right?

    If so how can I set this to localhost or the static IP?

    See note 2245631 – Routing Mode and Default Domain configuration for SAP HANA extended application services, advanced model

    section Changing The Default Domain

    However, there is a reason why the IP resolves to mds-hana.openstack.na-us-1.cloud.sap (see /etc/resolv.conf). You might want to make sure that the host resolves to the required/desired host and domain name first, and then proceed with the installation of products that rely on the networking functionality.

    Note 2596466 – FAQ: SAP HANA XS advanced is a good starting point if the documentation does not cover the issue.

    [[ PS Log dumps are rarely useful ]]

    Cheers,

    D