Installing SAP Web IDE for SAP HANA SPS 11
Hello,
Recently learnt about the new developer features in SAP HANA SPS 11, especially in the area of XS Advanced Model & SAP WebIDE for SAP HANA.
However when I tried to go about it, it seems pretty tricky & complicated as it doesn’t come in a package by default.
Thus I’ve decided to blog about my journey in setting up SAP Web IDE in SAP HANA SPS 11.
Please pardon me if there are any discrepancies or mistakes. Feel free to comment & feedback, I’ll take your advices and improve on this blog post, so to help others facing the similar issues.
Thank you in advance.
In this blog, I’ve broke it down the whole installation & setup into 3 checkpoints to meet in order to make your SAP Web IDE working for your SAP HANA SPS 11.
- Checkpoint 1 (Server Side Setup)
- Checkpoint 2 (Client Side Setup)
- Final Checkpoint (Installation & Configuration Success)
Environment
- SAP HANA on AWS Setup for SAP Business One, version for SAP HANA (Dev & Test Environment)
- SUSE Linux Enterprise Server 11.4
- SAP Business One 9.2 PL03
- SAP HANA SPS 11 (1.00.112.03.1464042351)
Motivation
- To install SAP Web IDE into SPS 11
- To utilize SAP Web IDE capabilities on SAPUI5 Apps Development
- To learn about SAP HANA XS Advanced Model & how every development work can be in SAP Web IDE (Uplift from Web-based Development Workbench)
Reference
- SAP Web IDE for SAP HANA Documentation
- SAP HANA SPS 11: New Developer Features
- SAP Note 2271148 – SAP Web IDE for SAP HANA SPS11
- SAP Note 2233866 – SAP HANA XS Advanced Model SPS11 Release Note
** From the note, you’ll realise that everything isn’t straightforward to setup & configure **
Prerequisite
- XS Advanced Runtime (XSA) has to be installed
- XS Advanced Command Line Tool has to be installed (see second component to be downloaded, depending on your OS selection)
SOFTWARE DOWNLOAD CENTER > INDEX > H > SAP IN-MEMORY (SAP HANA ) > HANA PLATFORM EDITION > SAP HANA PLATFORM EDITION > SUPPORT PACKAGES & PATCHES > ENTRY BY COMPONENT > XS ADVANCED RUNTIME
Download the following components (Version 34)
- SAP EXTENDED APP SERVICES 1
- XS RUNTIME 1 (Client & Runtime to be downloaded – dependant on your OS)
Installation of XS Advanced Runtime
- Extract SAP EXTENDED APP SERVICES 1 in SLES Environment using SAPCAR (EXTAPPSER00P_34-70001316.SAR)
- chmod -R 777 to installation path in SLES Environment (e.g. chmod -R 777 /software_sps11)
- CD to Installation Path (e.g. cd /software_sps11/SAP_HANA_DATABASE)
- Run HDBLCMGUI in SAP HANA DATABASE (e.g. ./hdblcmgui) Setup will run
- Load Components from EXTAPPSER00P_34-70001316.SAR (see attached screenshots below)
- *ERROR* when installing first time, run installer again and it will succeed (Experts, please advise.)
- Post Installation Checks to Make Sure Services are added (see attached screenshots below)
— Click on “Add Component Location … “
— Navigate to the extracted ‘EXTAPPSER00P_34-70001316.SAR’ location (e.g.XSA_RT_10_LINUX_X86_64), Click on “Open”
— “SAP HANA XS Advanced Runtime” will be added to the component list
— Tick all components, especially “Install SAP HANA XS Advanced Runtime Version 1.0.34.275394”
— Click “Next”
— Leave the values entered by default
— Remember your password for XSA_ADMIN (Important)
— Organization Name & Space Name to remember as well
— Review the components below
— Click “Update”
— Takes a few minutes for installation & updating components
— Error occurred while executing SAP HANA Components (for my case)
— Everything else is installed successfully
— Run Installer again & repeat steps (./hdblcmgui)
— Review Installations & Updates
— SAP HANA XS Advanced Runtime is successfully Installed / Updated
— Open SAP HANA Studio, Administration Console
— Do Post Installation Checks (Refer below)
— You should see additional services installed to your HANA Server
Post Installation Checks
- xsexecagent
- xsuaaserver
- xscontroller
- Access into your SAP HANA Platform Lifecycle Management to verify your System Information (see attached screenshots below)
— Access into https://<ipaddress>:1129/lmsl/HDBLCM/<SID>/index.html
— “View System Information”
— “Hosts Information”
— Verify XS Advanced Runtime Worker (xs_worker) is included
— “Installed Components”
— Verify “SAP HANA XS Advanced Runtime” is installed with the right version (34)
Checkpoint 1 (Server Side Setup)
- Installed XS Advanced Runtime in your SAP HANA Server
- SAP HANA XS Advanced Runtime components is up & running
Now, go to your Client side (Windows Server)
Check that the XS advanced run time is installed and available on the SAP HANA server.
Enter the following URL in your Web browser: https://<hana_hostname>:3<instance>30/v2/info
(e.g. https://172.31.31.64:30030/v2/info)
The response displayed in the Web browser is a JSON string with details that indicate a successful connection to the XSA controller.
Next steps, install XS Advanced Runtime Components in your Client side.
Install XS Advanced Command Line (XSA CLI) Tools on Client (e.g. Windows Server)
XS Runtime 1 component that you’ve downloaded at the start (see attached screenshots below)
— Downloaded this client package (version 34) from Software Center
— Extract XSA Client (XS_CLIENT00P_34-70001792.ZIP) into your Windows Server
— Open Command Prompt, cd to directory and run xs (you can add the xs command to your user variables)
— e.g. cd c:/XS_CLIENT00P_34-70001792/bin
Check that the XS client for XS advanced is installed and available (enter into the command prompt).
- xs help
- xs -v
Connect to the XS advanced controller on the SAP HANA server (enter into the command prompt).
- Specify the URL of the API end point on the SAP HANA server you want to connect to:
xs api https://<hostname>:3<instanceNr>30
(e.g. xs api https://172.31.31.64:30030)If this command fails due to a missing SSL certificate, you can download the missing certificate from the SAP HANA server; the certificate default.root.crt.pem is typically installed in the following default location:
<installation_path>/<SID>/xs/controller_data/controller/ssl-pub/router/default.root.crt.pem
For example, where <installation_path>=/hana/shared/ and <SID>=HDB:
/hana/shared/HDB/xs/controller_data/controller/ssl-pub/router/default.root.crt.pem - Install the security certificate on the machine where you are running the XS CLI client.
Place the copy of the root certificate in a safe location in your client file system, for example,/<path>/default.root.crt.pem - Set the API end point for client connections to the SAP HANA server using the newly installed certificate for authentication.
xs api https://<hostname>:3<instanceNr>30 -cacert /<path>/default.root.crt.pem(e.g. xs api https://172.31.31.64:30030/ -cacert C:/XSACLI/default.root.crt.pem)
Login into XS Advanced Runtime (enter into the command prompt)
- xs login -u XSA_ADMIN -p Initial0
Checkpoint 2 (Client Side Setup)
- Downloaded XS Advanced Runtime (Client) into your Client OS (Windows Server)
- Configured XS Advanced Runtime Client
- Configured Certificate & SSL
- Initial Login & Successful Utilization of XSA CLI (Command Line Tools)
Next steps, using XSA CLI to install SAP HANA Web IDE for SAP HANA.
Download SAP HANA Web IDE Components
- SAP HANA RUNTIME TOOLS 1.0
SOFTWARE DOWNLOAD CENTER > INDEX > H > SAP IN-MEMORY (SAP HANA ) > HANA PLATFORM EDITION > SAP HANA PLATFORM EDITION > SUPPORT PACKAGES & PATCHES > ENTRY BY COMPONENT > SAP HANA RUNTIME TOOLS
Download “XSACHRTT01_21-70001571.ZIP – SP01 Patch21 for SAP HANA RUNTIME TOOLS 1.0“ - SAP Web IDE for SAP HANA Development Infrastructure (DI) (DI CORE 1)
SOFTWARE DOWNLOAD CENTER > INDEX > H > SAP IN-MEMORY (SAP HANA ) > HANA PLATFORM EDITION > SAP HANA PLATFORM EDITION > SUPPORT PACKAGES & PATCHES > ENTRY BY COMPONENT > SAP WEB IDE 4 SAP HANA > DI CORE 1
Download “XSACDEVXDI11_1-70001255.ZIP – SP11 Patch1 for DEVX DI 1.0“
- SAP WEB IDE for SAP HANA Web Client
SOFTWARE DOWNLOAD CENTER > INDEX > H > SAP IN-MEMORY (SAP HANA ) > HANA PLATFORM EDITION > SAP HANA PLATFORM EDITION > SUPPORT PACKAGES & PATCHES > ENTRY BY COMPONENT > SAP WEB IDE 4 SAP HANA > SAP WEB IDE 1
Download “XSACSAPWEBIDE11_1-70001256.ZIP – SP11 Patch1 for SAP WEB IDE 1“
** Precautions on Installation **
- Successful Login as XSA_ADMIN
- Install in order (HANA Runtime Tools > DI Core > Web IDE)
- Install into SAP space
- Make sure there is enough space in your HANA Server (otherwise your installation will fail with errors)
– DI CORE (~ 8 GB)
– Web IDE (~ 3 GB)
Install SAP HANA Web IDE Components (enter into the command prompt)
The installation commands include relative paths to the component locations in the XSA file system.
- xs target -s SAP
- xs install XSACHRTT01_21-70001571.zip
- xs install XSACDEVXDI11_1-70001255.zip (default, without customization)
xs install XSACDEVXDI11_1-70001255.zip -e di_mtad.mtaext (with customization – refer to SAP Note 2271148 – SAPWebIDE4HANASPS11_Installation.pdf) - xs install XSACSAPWEBIDE11_1-70001256.zip
— Screenshot of an example of Successful Installation & Deployment of XSA Service of DI Core
— Running of an Installation
Final Checkpoint (Installation & Configuration Success)
- Successful Installation of HANA Runtime Tool, DI Core & Web IDE
- Verified XSA Components are up & running for Web IDE (type xs services in command prompt)
What’s next?
Start your Tutorial for SAP Web IDE for SAP HANA on tinyworld
- YouTube: SAP HANA Academy – Web IDE for HANA
- SCN: Developing with XS Advanced – A TinyWorld Tutorial
I hope this blogpost will help someone out there in figuring out how to go about it to install SAP Web IDE for SAP HANA SPS11.
Please feel free to let me know if you need any assistance in any area by dropping a comment below.
Jacob,
Wow, GREAT journey it is !
Thanks for sharing end-to-end steps for configuring SAP Web IDE on SAP HANA SPS 11.
This is one of the best manuals I have ever reviewed through at HANA community.
for me, I have a plan to utilize SAP Web IDE capabilities on SAPUI5 Apps Development and yours provide me with clear understanding in HANA technical landscape and its components.
Regards, Ted
Hi Ted Kwon,
Thank you for your encouragements!
Yeah, quite a journey also for yourself to get everything set up successfully? 😆
Great to know that! That's awesome to hear that it has helped you.
Please let me know if there's any areas I've missed out / can be improved based on your walkthrough of my blog.
Meantime, all the best in your development~ Cheers!
Kind regards,
Jacob
Hi Jacob,
Thank you for your such detail guide.
But I met a problem when I try to install XS Advanced Runtime that I cannot found the "SAP_HANA_DATABASE/HDBLCMGUI" when I finished the EXTAPPSER00P_34-70001315.SAR file. And there is only "instruntime" ,"package" and "hdbinst".
Did I download the wrong file?
Hope your response!
Best Regards,
Cassie
Dear Cassie,
./hdblcmgui is should be run from the SAP_HANA_DATABASE folder.
Please go through the steps I've mentioned in the guide.
Don't forget to load the components from the folder after the installer pops up.
Hope it helps.
Thank you.
Cheers,
Jacob Tan
Dear Jacob,
Really thanks for your reply. And it works!:)
Thank you~
Best Regards,
Cassie
Hello Jacob ,
Thanks for the step by step instructions to install SAP WebIDE for HANA .
I followed the guide and I could successfully install WebIDE on HANA SPS 12 .
But when I try login to WebIDE it gives me error message ' Permission denied ' ....
I have also performed post installation steps like :
1. Grant XS_CONTROLLER_USER role to development user
2. and set SpaceDeveloper role
Did i miss any steps or ? please give me some suggestion
Regards,
Samyukt Shah
Hi Samyukth,
Did you get it working??, we are also facing the same issue, and no clue to proceed further?
Thanks,
Girish
Hello Girish ,
Yes I am able to fix this issue ,
As I can see from screen shot you have attached( xs apps) , some of the apps required are missing .
Please follow below steps ,
step 1. Install xsa monitoring version SP02 and xsa service SP02 ( some bug in sp03 )
step 2. Get url for xsa-admin app ( cmd : xs app XSA-ADMIN --urls )
step 3: Login to url in step 2 ( The login user must have required roles - as seen in screenshot )
step 4 : Create role collection : WebIDE_DEVELOPER and WebIDE_ADMIN ( credits : Zoya Pronyakova https://archive.sap.com/discussions/thread/3944992)
1. To create role collection:
- open to Application Role Builder tile -> press on 'three parallel lines' (on the left upper side) -> choose Role Collection -> press + on the bottom to create a new Role Collection -> provide the name (e.g. WebIDE_Developer, WebIDE_Administrator) and assign Application Role:
- WebIDE_DEVELOPER role collection, select app name - webide!1, role template = application role - WebIDE_Developer
- WebIDE_ADMIN role collection, select app name - webide!1, role template = application role - WebIDE_Administrator
- Save
Information about Role Collection management should be available HANA / XSA Security Guide
2. Assign Role Collection to a user
- open User Management tile -> select a user -> got to Role Collection section -> add WebIDE_... role collection, depending on user responsibility -
Web IDE developer user - assign WebIDE_DEVELOPER RC
Web IDE administrator user (certificate management or space enablement) - WebIDE_ADMIN RC
Hope this will fix your issue ...
Samyukt Shah
Hello Jacob,
The blog was very useful, by the way, we followed the steps mentioned above and got the XSA installed, but when we try to access the webide via SYSTEM/XSA_ADMIN or the user created with XS_CONTROLLER_USER role, we are getting “Permission denied” error.
xs apps:
What would be the reason..? can you please help over here..
Thanks,
Girish
you are a genius, Jacob...count your blessings...
I don't have an S-User ID...to what extent am I limited in installing the xs command line and the Web IDE for SPS 12 as described?
Hi Jacob - I just started a SAP HANA 2.0 Platform edition on AWS and do not see the WebIDE. Do I need to do the same to install the Web IDE? Is there another instance with SPS 11 or 12 that already has the webIDE installed. I am trying to do NodeJS development on HANA which i believe you need at least HANA with SPS 11 or HANA 2.0.
I just created the following question and then saw your post:
No SAP webIDE running on SAP HANA 2.0 Platform Edition Trial on AWS
https://answers.sap.com/questions/263424/no-sap-webide-running-on-sap-hana-20-platform-edit.html
Thanks for you help in advance.
Regards,
Jay
Hi Jacob,
Thanks for the detailed blog, I am facing below issue during hana runtime tools installtion.
XSACHRTT04_54-70002322.ZIP SP04 Patch54 for SAP HANA RUNTIME TOOLS 2.0
xs install /hana/log/webide/XSACHRTT04_54-70002322.ZIP
Running installation in org "orgname" / space "SAP" as XSA_ADMIN...
Installation failed.
ERR com.sap.cloud.lm.sl.slp.client.communication.NotFoundException: Not Found
Could you please help me here.
Thanks for your help in advance.
Thanks and Regards
Sampath R.
Hi Sampath,
I meet the same question. Have you solved it?
Thanks and Regards
Lyon