Install the clients if you intend to develop XS applications on a machine that will not have a local SAP HANA 2.0, express edition installation. The clients let you access SAP HANA 2.0, express edition from your client machine.
You can install the clients on the SAP HANA 2.0, express edition server during server installation, but this how-to assumes you are installing the clients on a different machine than the PC where SAP HANA 2.0, express edition is installed.
This how-to refers to the laptop with SAP HANA 2.0, express edition as the server machine, and your local machine as the client machine.
Pre-Installation Info: XS CLI Client
The XS advanced client-tools bundle
xs.onpremise.runtime.client_<platform>-<version>.zip also includes the archive
You can use the XS command line client to perform a wide-variety of developer- and administrator-related tasks. For example, in the role of a developer, you can use the XS CLI to connect to the XS advanced run time installed on the server machine, log on as a specific user, and deploy and manage your applications.
Pre-Installation Info: SAP HANA HDB Client
SAP HANA 2.0, express edition provides the Reduced SAP Client package for connecting applications. You can install the client on the server machine during server installation, or on a separate machine as described in this how-to.
When you install the SAP HANA HDB Client software package, you install the following clients:
- Python (
Step 1: Download the Clients
Install the Download Manager to your client machine and download the client package.
Note: The Download Manager requires Oracle Java SE Runtime Environment 8 (JRE 8) or higher, 64-bit, on your client machine.
Save the Download Manager installation file to your client machine and open it. For instructions on downloading and running the Download Manager, see either the Installing SAP HANA 2.0, express edition (Binary Installer Method) or Installing SAP HANA 2.0, express edition (Virtual Machine Method) tutorials.
In Download Manager, in the Image pull-down, select either Virtual Machine or Binary Installer.
Click Browse and select a directory where your client package will be saved.
Select only Clients. Clear the Select boxes of all other packages.
Click Download. The
clients.zip file downloads to your save directory.
For Windows machines, use a compression utility like WinZip.
For Linux, navigate to the directory in which you wish to extract the client files and use the unzip command.
sudo unzip <download_filepath>/clients.zip
These files are extracted:
Step 2: Install the XS CLI Client
Install the command line client for XS advanced on your client machine.
In this procedure, you learn how to use the XS CLI client to connect to SAP HANA.
XS CLI Client Prerequisites
XS advanced is installed on the SAP HANA 2.0, express edition machine (the server host).
You have access to the Internet from your client machine.
You have logon access to the SAP HANA 2.0, express edition database with the privileges to create SAP HANA users (for example, SYSTEM).
Using a compression utility such as WinZip or Unzip, extract either
xs.onpremise.runtime.client_ntamd64.zip for Windows or
xs.onpremise.runtime.client_linuxx86_64.zip for Linux.
The system will create this folder:
Check that the XS advanced run time is installed and available on the server machine.
Enter the following URL in your Web browser:
For example, the SAP HANA instance “90” on the host
The response displayed in the Web browser is a JSON string with details that indicate a successful connection to the XSA controller. This connection test is important as you want to make sure the connection exists before you attempt it from within the API command.
Check that the XS client for XS advanced is installed and available.
The XS client tools are required to connect to the XS advanced run time on SAP HANA and deploy your XS advanced applications.
On your client machine, open a command window and run the following commands:
Note Linux users should run this command as
If you see output indicated Client version, XS is installed.
Connect to the XS advanced controller on the SAP HANA 2.0, express edition server.
Specify the URL of the API end point on the SAP HANA server you want to connect to:
xs api https://<hostname>:3<instance_number>30
Note: This command may fail due to a missing SSL certificate. This note shows you how to set up a certificate on the client so it can connect to the server. Copy the correct certificate to your client from the SAP HANA 2.0, express edition server.
Open a command session on the server machine or open a PuTTY session to the server machine. From the command prompt, login as sudo and navigate to the certificate. The certificate
default.root.crt.pem is typically located here:
For example, where
Copy the certificate to a folder on the server where you can easily access it.
Using an FTP client or the
scp command, send a copy of the certificate from your server machine to a safe location on your client machine.
scp <server_machine_user>@<ip_address_server>:<file_destination>/default.root.crt.pem <client_machine_user>@<ip_address_client>:<your_desired_filepath>/
Exit your FTP and PuTTY sessions and return to your client machine. Try the previous command again, but use the
-cacert command and specify the local certificate you just copied.
xs api https://<hostname>:3<instance_number>30 -cacert "<copied_filepath>/default.root.crt.pem"
From the client machine, log on to the XS advanced run time.
You log on to the SAP HANA instance specified in the API end point set in a previous step. SAP HANA provides a default user
XSA_ADMIN with administrator permissions; you can use this user ID to test the logon. However, it is recommended to create a new user with more limited permissions, which you can use to log on for developer tasks.
xs login -u XSA_ADMIN -p "<password>"
Note: The password is assigned to the XSA_ADMIN user during SAP HANA 2.0, express edition installation.
Test your connection to XSA. Run the following command to view XS applications on the SAP HANA 2.0, express edition server.
Step 3 (Windows): Install the SAP HANA HDB Client
To install the SAP HANA client on a Windows machine, use either a graphical user interface or a command line.
Using a compression utility like WinRAR or WinZip, extract
hdb_client_windows.zip. (The file
hdb_client_windows.zip is located in the
clients.zip file you downloaded earlier in this how-to.)
The following file path is created:
In file explorer go to the
Open a command prompt and navigate to
In file explorer, double-click:
Or from a command prompt:
Call the program
hdbsetup (GUI installation) or
hdbinst (command line installation) by entering one of the following commands:
hdbsetup [-a client]
hdbinst [-a client] [<option list>]
Follow the instructions displayed by the installation tool.
Add the installation path to the PATH environment variable. For information on setting environment variables, see the documentation for your operating system.
Step 3 (Linux): Install the SAP HANA HDB Client
To install the SAP HANA client on a Linux machine, do the following:
Navigate to the directory where you wish to unpack the
sudo tar -xvzf <unzipped_filepath>/hdb_client_linux.tgz
HDB_CLIENT_LINUX_X86_64 is created.
Move into the
HDB_CLIENT_LINUX_X86_64 directory and run
Follow the onscreen instructions to install the SAP HANA client.
Post-Installation Info: SAP HANA HDB Client
Logging the Installation
The SAP HANA client installation is automatically logged by the system. The log files are stored at
%TEMP%\hdb_client_<time_stamp> for Windows and
/var/temp/hdb_client_<time_stamp> for Linux.
Connect SAP HANA HDB Client to SAP HANA 2.0, express edition
Now that you’ve installed the SAP HANA HDB Client, connect to a SAP HANA 2.0, express edition system.
Uninstall the SAP HAND HDB Client
Each installation has its own uninstallation tool. Use the
hdbuninst command to uninstall the client software from your command prompt.
Follow the onscreen instructions to uninstall the SAP HANA Client.