SAP Fiori Tools: Deploy to ABAP server

[jhodel18]

In my previous blog post SAP Fiori Tools - SAPUI5 Freestyle App, I've shown how to set up a SAPUI5 Freestyle App using SAP Fiori Tools. After you have finished building and testing your UI5 app, the next logical thing to do is prepare it for deployment. In this blog post, I will show how to deploy a SAPUI5 App to the ABAP server using SAP Fiori Tools.

 

 

Prerequisites

---

• SAP Business Application Studio


• Visual Studio Code with SAP Fiori Tools extension installed


• ABAP server (in this demo, I'm using S/4HANA)


• The OData Service to Load Data to the SAPUI5 ABAP Repository is activated

 

UI5 Tooling

---

As I've already mentioned in my previous blog post, UI5 Tooling is one of the many tools behind SAP Fiori Tools. UI5 Tooling is also responsible for deploying the UI5 App to multiple target systems, including the ABAP server.

If you are still using the SAPUI5 Tools for Eclipse, then you should read this blog post -- SAPUI5 Tools for Eclipse – Now is the Time to Look for Alternatives. In short, SAPUI5 Tools for Eclipse has been officially retired. And while SAP WebIDE can still be used to deploy UI5 App to ABAP server, SAP has been promoting the next generation IDE which is SAP Business Application Studio, and therefore, its use for deploying UI5 App to ABAP. And from SAP Business Application Studio, the tool that is used to deploy the UI5 app is the UI5 Tooling.

To sum it up, we are already in the 3rd generation of SAPUI5 Tools in the form of UI5 Tooling. And through this tool, you can utilize it by using your preferred development IDE. While this tool opens up the possibility to be used with the IDE of your choosing, it may be not so straight-forward to use for those who are very used to using SAP WebIDE. Hence, I've created this blog post, to show how it can be used to deploy your UI5 App to the ABAP server.

 

Deploy to ABAP server

---

The base project for this demo is the solution from my previous blog post -- SAP Fiori Tools - SAPUI5 Freestyle App. If you followed through the demo on that blog post, then you're good to proceed with the steps detailed in this blog post. But in case you didn't have the solution, you can find the solution in the link below:

https://github.com/jcailan/cap-samples/tree/blog-fiori-tools

However, you need to make sure that you have installed modules if you are using the Visual Studio Code. Now, with the base project ready, let's start the deployment process.

• 1. Inspect the scripts inside the package.json file. The initial state of the package.json have the deploy script looking like below:

"deploy": "fiori add deploy-config"

As you can see, if you run the deploy script, it will execute the command and generate the deploy config.

• 2. Execute the deploy script on the command line:

> npm run deploy

Note:

On your terminal, you need to be inside the gwsample folder before you execute the command -- npm run deploy.

You will be prompted to answer the information like ABAP Package and Transport Request number -- see below screenshot for more details:

Notice that the deploy script in package.json has been updated with:

"deploy": "ui5 build preload --config ui5-deploy.yaml"

Also, ui5-deploy.yaml file has been created. This serves as the deployment descriptor for the UI5 app.

specVersion: "1.0"

metadata:

  name: "gwsample"

type: application

ui5Theme: sap_fiori_3

builder:

  customTasks:

    - name: deploy-to-abap

      afterTask: generateVersionInfo

      configuration:

        target:

          url: http://sample.host.com:8000

        app:

          name: gwsample

          package: Z_DEMO_UI5_TOOLING

          transport: <your.transport.request>

• 3. Update the deployment descriptor ui5-deploy.yaml file with the configuration for your server credentials. And also make sure that the name of the app starts with Z or Y for the customer namespace (every ABAPer should already know this).

specVersion: "1.0"

metadata:

  name: "gwsample"

type: application

ui5Theme: sap_fiori_3

builder:

  customTasks:

    - name: deploy-to-abap

      afterTask: generateVersionInfo

      configuration:

        target:

          url: http://<your server hostname>:<port> # <-- modify this

          client: <development client> # <-- modify this

          auth: basic

        credentials:

          username: env:UI5_USERNAME

          password: env:UI5_PASSWORD

        app:

          name: zgwsample # <-- modify this

          package: Z_DEMO_UI5_TOOLING

          transport: <your transport request from previous step>

You can follow through the changes from the template above, but keep the credentials section unchanged because we will define UI5_USERNAME and UI5_PASSWORD as environment variables in the next step. We are doing this because you don't want your username and password to be part of the project files that you commit to git.

• 4. Create the .env file that will contain the values of environment variables UI5_USERNAME and UI5_PASSWORD. The file should have below entries:

UI5_USERNAME=<your username>

UI5_PASSWORD=<your password>

Note:

This .env file shouldn't be committed to git, therefore, create an entry for this file in your .gitignore file to make sure that it doesn't get committed to git. If you're not using git then you can ignore this step.

• 5. Now that the deployment setup is complete, it's time to execute the deploy command again:

> npm run deploy

If everything executed smoothly, you will get a series of logs printed in the terminal, and it will end with the following messages:

info builder:custom deploy-to-abap Deployment Successful.

info builder:builder Build succeeded in 20 s

info builder:builder Executing cleanup tasks...

Note that before the actual deployment, the tool builds the UI5 project first and do the minification of UI5 files and the generation of the *preload.js files. So the tool is already taking care of all the best practices build process before the actual deployment.

 

Test the Deployed UI5 App

---

• 1. Go to SICF tcode and search for your app by using the app name as the value for the service name. Once found, test the app by right-clicking on the ui5 app node and click on test service. This will launch the URL of your UI5 app, and you should see the below results:

That's it! You've deployed a SAPUI5 App using SAP Fiori Tools / UI5 Tooling!

 

Closing

---

Now you see how easy it is to deploy a SAPUI5 App using the new UI5 Tooling. Hopefully, this blog post can help you with transitioning from your current preferred tool into using this new SAPUI5 Tooling.

The beauty of this tooling is openness because you can use it on your preferred IDE. And to further ease your transition, I suggest for you to gain a basic understanding of Node.js runtime (if you haven't acquired this yet).

 

~~~~~~~~~~~~~~~~

Appreciate it if you have any comments, suggestions, or questions. Cheers!~

[nomssi]

Hello Jhodel Cailan,

thanks for sharing.

While deploying a WebIDE development to an ABAP backend with report /UI5/UI5_REPOSITORY_LOAD, I experienced 2 issues:

• I often use a version of the UI5 library that is newer than the system version, so the code is copied to the resources path. The copy process takes ca. 2 hours (or more) and I already had to create a copy of the report to make sure no files (e.g. icons) were left out.


• the path to the resources always hat to be adjusted in index.html
  
  
  
  • either src=”https://sapui5.hana.ondemand.com/resources/..
  
  
  • or src=”resources/…” instead of src=”/../../resources/…”
  
  
  
  

JNN

[jhodel18]

Hi jacques.nomssi

Thanks for the comment! However, your issue is a bit off-topic. Kindly post your issue in the Question and Answer section, from there, somebody might be able to help you with your issue. Thanks!

[nomssi]

Hello Jhodel,

sorry, the question I have is: how long does it take for a projekt with say 70 MB to deploy? what is your experience with the UI5 tooling?

best regards,

JNN

 

[MioYasutake]

Hi jhodel18,

 

Thank you for your blog post.

To me it's good to know that I can execute Fiori apps from SICF, without configuring the launchpad.

 

Best regargds,

Mio

 

 

[jhodel18]

Hi mioyasutake

Yes - as long as you have an HTML file included in the deployed app, you can run it in standalone mode.

[jhodel18]

Hi jacques.nomssi

In that case, for 14 MB project files, it takes roughly 10 seconds (or less) to deploy using UI5 Tooling. And so far, I don't really come across of having a single UI5 app that is more than 30 MB in build files. Nevertheless, I don't think there will be any issues for your example of 70 MB size.

[vishnucta]

The one blog..I was waiting for...I had issues deploying into ABAP server n even created a discussion abt it.... let me try this...... Thanks jhodel18

[jhodel18]

Hi vishnu.pankajakshan

I hope this blog post can help you fix your issue.

[vishnucta]

Can u have a look at below thread

 

https://answers.sap.com/questions/13110465/fiori-tools-vscode-connection-to-secure-abap-serve.html

[jhodel18]

Hi vishnu.pankajakshan

Are you sure this is a deployment issue? The command npm start is to start running your app locally. And this command will refer to your ui5.yaml config. From there you can set the ignoreCertError to true.

[vishnucta]

jhodel18

Check step 5 in below tutorial

https://developers.sap.com/tutorials/fiori-tools-generate-project.html#935f7748-b548-4996-b190-02e0c...

[jhodel18]

vishnu.pankajakshan

Can you be more specific?

[vishnucta]

Step 5 says npm start

[dv_u]

Hi,

 

Can we create a adaptation or extension project using the Fiori tools?

[dv_u]

Hi, I tried with the given steps. I am getting the below error

info builder:custom deploy-to-abap Deployment failed with error Request failed with status code 403bap…

And another error after replacing the ui5-deploy.yaml with another ABAP system

info builder:custom deploy-to-abap Deployment failed with error self signed certificate deploy-to-abap..

I changed the

ignoreCertError : true

But still  getting the same error

Please help me to resolve the issue

Thanks

[jhodel18]

Hi udayagiri.swamy

As far as I know, it is not available yet, but my assumption is that it will be available soon, if not Q3 then Q4 this year.

[jhodel18]

Hi udayagiri.swamy

Where did you put that ignoreCertError? at the ui5-deploy.yaml? So far I don't any support for that function on deploy configuration, and unfortunately, I can't replicate the same issue you have in my system.

[dv_u]

in the ui5.yaml. I got this error (self signed certificate ) when i use https protocol.

When I use http, below error occured.

info builder:custom deploy-to-abap Deployment failed with error Request failed with status code 403bap…

[skymu89]

I had the same error while using http:

Error: Request failed with status code 403

By debugging into node_module code, I found related URL:

http://<ip>:<port>/sap/opu/odata/UI5/ABAP_REPOSITORY_SRV

By searching for ABAP_REPOSITORY_SRV, it can be resolved by register service in T-code: /n/iwfnd/maint_service as blog post below:

https://answers.sap.com/questions/12994655/index.html

Then the error changed, I got following 400 error:

Virus scan profile /SCMS/KPRO_CREATE is not active

By search Virus in SPRO, it can resolved by disable scan or activating /SCMS/KPRO_CREATE profile.

Then I still face 400 error,

Error: Request failed with status code 400

with detailed but useless message:

ERR! builder:custom deploy-to-abap SAP_Transaction: For backend administrators: use ADT feed reader "SAP Gateway Error Log" or run transaction /IWFND/ERROR_LOG on SAP Gateway hub system and search for entries with the timestamp above for more details

I know ADT is mandatory dev service but not sure, then I try activating service /sap/bc/adt in T-code sicf

Then the deployment failed with 500 error at the first time, but will success in the second time.

Finally the I can deploy my app successfully using Fiori Tools by command "npm run deploy"

[dv_u]

Thanks sky.mu , it worked now. Initially i tried in 1709  which does not have  /UI5/ABAP_REPOSITORY_SRV . I tried in 1909 and it has /UI5/ABAP_REPOSITORY_SRV.

https://sapui5.hana.ondemand.com/#/topic/a883327a82ef4cc792f3c1e7b7a48de8.html

[TimMuchena]

Hi

 

Thanks for the blog. Managed to deploy. However subsequent deployments are not carrying through the changes to the backend. Ever faced same issue?

 

Thanks

[jhodel18]

Hi willard.chingarande4

I was able to do subsequent deployments. Do you get any errors?

[TimMuchena]

I don't get errors in vscode. I get deployment successful message but the changes don't reflect in the backend BSP object.

Also got same issues when I tried following this blog

[jhodel18]

Unfortunately, I haven't got the chance to do this again recently, and this could be a bug. I suggest that you raise an OSS ticket or submit a question in SAP Community about this.

[former_member705826]

Hi thanks a lot for the blog.

I followed all the steps but I always get 403 when deploying.  Do you know how to use https for deploying and what could be the problem?

Thanks.

[termanico]

Excellent Blog Jhodel! Thx a lot for this!

We're doing a lot UI5 development eith Runtime ABAP (BSP) and we're planning to use Fiori Tools on VSCode in our projects.

However, when I'm trying to deploy to out ABAP BAckend (as described in your block, I' getting an Error Message:

info builder:custom deploy-to-abap Create Archive
info builder:custom deploy-to-abap i18n/i18n.properties addedLU � (4/9) Running task deploy-to-abap...
info builder:custom deploy-to-abap localService/mockserver.js added
info builder:custom deploy-to-abap test/changes_preview.js added
info builder:custom deploy-to-abap test/changes_loader.js added
info builder:custom deploy-to-abap manifest.json added
info builder:custom deploy-to-abap Component.js added
info builder:custom deploy-to-abap test/flpSandboxMockServer.html added
info builder:custom deploy-to-abap test/flpSandbox.html added
info builder:custom deploy-to-abap localService/ZTRAVEL_U_VAN.xml added
info builder:custom deploy-to-abap annotations/annotation.xml added
info builder:custom deploy-to-abap localService/metadata.xml added
info builder:custom deploy-to-abap Starting Deployment.
ERR! builder:custom deploy-to-abap Deployment failed with error VELU � (4/9) Running task deploy-to-abap...
ERR! builder:custom deploy-to-abap unable to get local issuer certificate
info builder:builder application ZFETRAVELU � (5/9) Running task generateFlexChangesBundle...
info builder:builder application ZFETRAVELU � (6/9) Running task generateComponentPreload...
info builder:builder application ZFETRAVELU � (7/9) Running task createDebugFiles...
info builder:builder application ZFETRAVELU � (8/9) Running task uglify...
info builder:builder application ZFETRAVELU � (9/9) Running task generateVersionInfo...
info builder:builder Build succeeded in 3.71 s
info builder:builder Executing cleanup tasks...

Can this be solved with any kind of configuration in ui5-deploy.yaml? such as  useStrictSSL: false or IgnoreCertError: true?

I am a little desperate and any kind of help is more than welcome 🙂

br

Thorsten

 

[jhodel18]

Hi termanico

Thanks for your comment!

I tried redeploying again today and it worked perfectly fine on my side. I'm guessing this has something to do with the environment setup you have that makes it impossible for me to replicate. I'm using plain basic authentication and my server hostname is on http.

I would suggest raising a support ticket to SAP about your issue.

[jhodel18]

Hi braunadr

Thanks for the comment!

Have you read the prerequisites section of this blog post?

[kschoudary]

Thanks Jhodel and this is really a very detailed blog to deploy the app to ABAP server.

[gayuhtaruna]

Very nice tutorial, but I have probel on the .env, can help to explain for this ?  I have created file .env and populated username & password, but still got error below :

 

ERR! builder:custom deploy-to-abap Deployment failed with error al 🔨 (11/11) Running task deploy-to-abap...
ERR! builder:custom deploy-to-abap Request failed with status code 401
ERR! builder:custom deploy-to-abap Please maintain correct credentials to avoid seeing this error
ERR! builder:custom deploy-to-abap (see help: https://www.npmjs.com/package/@sap/ux-ui5-tooling#setting-environment-variables-in-a-env-file)

 

Thanks

[Missschaaa]

Thanks for the tutorial Jhodel. We're facing a problem with the deploy of the app. Console protocol says everythings all right and foldered get created, but nothing happens in SAP system, no files, no ICF node, just as nothing has happended. Any idea what the problem can be?

[aditya_avadhanula]

Hi All ,

I see the below error while deploying to my 1909 ABAP trial system . I have checked the following :

1)/sap/opu/odata/UI5/ABAP_REPOSITORY_SRV service is active in the backend

2) the host and port names have been correctly maintanied .

I am not able to figure out the reason for this error ,

Deployment error

[former_member620231]

Hi aadityarao84

Did you resolve this issue? I also have a hard time with it now.

Thanks,

Alex

[aditya_avadhanula]

Hi Alex ,

 

Unfortunately , this still is an issue . In the meantime i deployed it directly via ABAP report .

 

Regards

Aditya

[former_member620231]

Hi aadityarao84

I think the cause might be that the npm module is not using the correct client.

I have this issue when i try to test locally and the login that appears when it conencts to a custom odata service does not work.

I couldn't set the client on my system because I have other issues with RZ10 but that doesn't matter here.

You could do that and if it does not work, you can try the nwabap npm module which works because you specify the client in the config file.

See step 7 here https://blogs.sap.com/2020/07/18/develop-sap-ui5-apps-using-visual-studio-code/

Regards,

Alex

[Marçal_Oliveras]

Hi,

 

Go to SICF transaction and check that node /sap/opu/odata/ui5/abap_repository_srv is active. I got the same error and /IWFND/MAINT_SERVICE was showing it as active but then I fixed it in SICF

[former_member621219]

Hey Gayuh,

 

Did you happen to resolve this? Running into the same problem..

[former_member621219]

In my case, it was becuause my .env file was inside my webapp folder instead of outside of it.

[former_member620231]

Hi aadityarao84 and anyone else having this problem,

As an update, I have managed to solve this issue and upload via the standard SAP extension by adding the configuration for authentication.

Please look at https://blogs.sap.com/2020/08/10/sap-fiori-tools-deploy-to-abap-server/, especially for the below parameters in ui5-deploy.yaml

        target:

          url: http://<your server hostname>:<port> # <-- modify this

          client: <development client> # <-- modify this

          auth: basic

        credentials:

          username: env:UI5_USERNAME

          password: env:UI5_PASSWORD

Regards,

Alex

[christian_schwarz]

Hi,

I have set this credentials section as already given in the above blog post, also checked that SICF node /sap/opu/odata/ui5/abap_repository_srv is active, even deactivated and reactivated to be sure. But still the same issue,
Invalid URL: /sap/opu/odata/UI5/ABAP_REPOSITORY_SRV

I am also using the SAP standard extension Fiori tools extersion pack, installed brand new, it comes with a deployment section in the application template wizard which lets me specify the server, app name etc. already in the Fiori tools Application Modeler Wizard and writes it to file
ui5-deploy.yaml.  I just added the credentials section as suggested in this blog post as mentioned before.
The last info message before the error is thrown reads:
Using system [] from System store
I am not sure what that means, but I have my system and port configured in the url property of the target section.

I also tried the suggestion from march 8 to use the nwabap npm module. Also no luck. It reports running a few commands like updating/deleting some local files, but I don't see the line for creating the BSP app and, consistent with that, nothing is uploaded to the ABAP UI5 repository.

Any further ideas to turn this into a usable tool?

So far, it's back to WebIDE for me, unfortunately 😞

Thanks in advance for any hints.

Best regards,

Christian

[former_member620231]

Hi schwarzc

Just a few guesses here, for the standard SAP extension, I usually put the client without quotes (ex: client: 100) while the extension uses quotes by default (client: "100"). Also, try to make sure the default login client is specified in the system parameter login/system_client in RZ10. This shouldn't create the issue because you specify the client in the ui5-deploy.yaml but it is something you can try. Check the $metadata endpoint for /sap/opu/odata/UI5/ABAP_REPOSITORY_SRV in your browser to make sure it is working.

For the nwabap extension, you should change the default deploy command in package.json like below

"deploy": "ui5 build -a --clean-dest --include-task=generateManifestBundle generateCachebusterInfo && nwabap upload"

I hope something works!

Alex

[christian_schwarz]

Hi Alex,

thanks a lot for your reply. I looked at this before Easter and verified that RZ10 parameter and $metadata endpoint for /sap/opu/odata/UI5/ABAP_REPOSITORY_SRV were in place (the latter I had checked myself before, in fact). Modifying the deploy command as above did in fact change the behavior, but in the end it did not work. Maybe due to the connected SAP system, e.g. sandbox application did not work while it did on a Northwind demo service.
Going back to this now I got stuck due to installation/update issues which I cannot solve myself since I am not admin on the machine. Too bad.
So I am going to turn to exploring SAP Business application studio but keep an eye on this here once my Visual Studio Code issue will be fixed.

Thanks again, kind regards,

Christian

[Joseph_BERTHE]

Hello,

I have the same issue than you. Did you find a solution ? I am behind a VPN, but the browser has access to the service OData....

Regards,

Joseph

[christian_schwarz]

Hi Joseph, unfortunately not. As stated, I turned to business application studio for the time being. BR Christian

[lukasgreilinger]

I have the following problem. Can abap-deploy not handle a nested folder structure under view/? It would be a lot of work to refactor that ...

"Folder view has children and can't be deleted"

[treee111]

HI @lukasgreilinger

for our deployment, a few folders with subfolders work but others not.

We get the same error as can be seen in your screenshot.

I am using version 2.1.0 with works with abap_repository_srv:

https://github.com/pfefferf/ui5-nwabap-deployer/tree/master/packages/ui5-nwabap-deployer-cli

With version 1.0.4, which does not use this oData Service, I don't get the error!

BR, Benjamin

[former_member680453]

Hello All,

Have attached a snap below. Do any one faced similar issue ? Tracked in all the way, but unable to find the root cause.

BAS Deployment Issue to On-Premise

 

[treee111]

HI @lukasgreilinger,

the issue is fixed now via SAP-note https://launchpad.support.sap.com/#/notes/3089702

Now we could use version 2.1.0 instead of 1.0.4 for the repo's where we had this problem!

[arifuddin_syed]

Hi @jhodel18,

Received the following errors while deploying the Fiori App to ABAP Repository using "npm run deploy" command using visual source code. Additionally found the error messages at transaction /IWFND/ERROR_LOG i.e. "SAPUI5 ABAP Repository with name ZXX does not exist" and "SAPUI5 application was not uploaded or registered successfully"

Please advise.

Your prompt support is highly appreciated.

Error Details:

nfo builder:custom deploy-to-abap Create Archive

info builder:custom deploy-to-abap Starting Deployment.on ZXXX � (11/11) Running task deploy-to-abap...

ERR! builder:custom deploy-to-abap Request failed with status code 400 � (11/11) Running task deploy-to-abap...

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap ***** Upload of SAPUI5 App or Library from ZIP-Archive into SAPUI5 ABAP Repository *****

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap Running in regular mode, brief log

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap Upload canceled, archive could not be read or appears to be empty.

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap * Done *

ERR! builder:custom deploy-to-abap SAP_Transaction: For backend administrators: use ADT feed reader "SAP Gateway Error Log" or run transaction /IWFND/ERROR_LOG on SAP Gateway hub system and search for entries with the timestamp above for more detailsERR! builder:custom deploy-to-abap SAP_Note: See SAP Note 1797736 for error analysis (https://service.sap.com/sap/support/notes/1797736)

ERR! builder:custom deploy-to-abap Deployment Failed.

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap ***** Upload of SAPUI5 App or Library from ZIP-Archive into SAPUI5 ABAP Repository *****

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap Running in regular mode, brief log

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap Upload canceled, archive could not be read or appears to be empty.

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap SAPUI5 application was not uploaded or registered successfully

ERR! builder:custom deploy-to-abap

ERR! builder:custom deploy-to-abap * Done *

ERR! builder:custom deploy-to-abap SAP_Transaction: For backend administrators: use ADT feed reader "SAP Gateway Error Log" or run transaction /IWFND/ERROR_LOG on SAP Gateway hub system and search for entries with the timestamp above for more detailsERR! builder:custom deploy-to-abap SAP_Note: See SAP Note 1797736 for error analysis (https://service.sap.com/sap/support/notes/1797736)

info builder:builder Build succeeded in 13 s

info builder:builder Executing cleanup tasks...

ApplicationInsights:CorrelationIdManager [der Executing cleanup tasks...

Error: connect ETIMEDOUT 0.0.0.0:00

at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1141:16) {

[sdebeaulieu]

Same here.