Skip to content

Commit e28f00f

Browse files
LGFM
Main
2 parents 84d9292 + 222e376 commit e28f00f

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

tutorials/abap-environment-shell-plugin/abap-environment-shell-plugin.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,21 @@ parser: v2
1212
---
1313

1414
## Prerequisites
15-
- You have access to a SAP BTP Subaccount with a SAP Business Application Studio subscription.
16-
- You have access to a SAP BTP ABAP Environment in a Cloud Foundry space in the subaccount.
17-
- You have connected SAP Business Application Studio to your SAP BTP ABAP Environment via destination.
18-
- You have a user in the subaccount, with `Business_Application_Studio_Developer` role collection.
19-
- You are a member of the Cloud Foundry space where your SAP BTP ABAP Environment resides, and you have **Space Developer** role.
20-
- You have a user in your SAP BTP ABAP Environment with the following roles: `SAP_BR_ADMINISTRATOR` and `SAP_BR_DEVELOPER`.
21-
- You are connected to your SAP BTP ABAP Environment in the ABAP Development Tool (ADT) in Eclipse.
15+
16+
- You have access to a SAP BTP Subaccount with a SAP Business Application Studio subscription.
17+
- You have access to a SAP BTP ABAP Environment in a Cloud Foundry space in the subaccount.
18+
- You have connected SAP Business Application Studio to your SAP BTP ABAP Environment via destination.
19+
- You have a user in the subaccount, with `Business_Application_Studio_Developer` role collection.
20+
- You are a member of the Cloud Foundry space where your SAP BTP ABAP Environment resides, and you have **Space Developer** role.
21+
- You have a user in your SAP BTP ABAP Environment with the following roles: `SAP_BR_ADMINISTRATOR` and `SAP_BR_DEVELOPER`.
22+
- You are connected to your SAP BTP ABAP Environment in the ABAP Development Tool (ADT) in Eclipse.
2223

2324
>This tutorial was written for SAP BTP ABAP Environment. However, you should be able to use it in SAP S/4HANA Cloud Environment in the same way.
2425
2526
>Throughout this tutorial, you will create various development objects and UI components. Wherever the suffix `###` or `000` is used, please replace it with your initials or group number.
2627
2728
## You will learn
29+
2830
- How to create a custom shell plug-in.
2931
- How to deploy the shell plug-in to your SAP BTP ABAP Environment as part of a SAP Fiori Application.
3032
- How to create a Business Catalog and Business Role to regulate access to the SAP Fiori Application.
@@ -103,17 +105,19 @@ The shell plug-in will be deployed to your SAP BTP ABAP Environment as an SAP Fi
103105

104106
![Create SAP Fiori application - Project attributes](create_SAPUI5_project_5.png)
105107

108+
>Ensure that **Use Virtual Endpoints for Local Preview** remains set to **No**.
109+
106110
9. Deployment Configuration: In the **Please choose the target** dropdown menu, select **ABAP**. In the **Destinations** dropdown menu, select the destination that points towards your SAP BTP ABAP Environment. Input for example `z_plugin_###` as name for the **SAPUI5 ABAP Repository** and a **Deployment description**. In the **Package** field, input the name of the package that you created in ABAP Development Tool in Eclipse in the previous step. Select **Enter manually** and Input the **Transport Request** number you created in the previous step. Click on **Next**.
107111

108112
<!--border-->
109113
![Create SAP Fiori application - Deployment configuration](create_SAPUI5_project_6.png)
110114

111-
10. Fiori Launchpad Configuration: In the **Semantic Object** field input `Shell###` and in the **Action** field input `plugin`. Input a **Title** of your choice. Click on **Finish**. The project folder will be generated.
115+
10. Fiori Launchpad Configuration: In the **Semantic Object** field input `shell###` and in the **Action** field input `plugin`. Input a **Title** of your choice. Click on **Finish**. The project folder will be generated.
112116

113117
<!--border-->
114118
![Create SAP Fiori application - Fiori Launchpad Configuration](create_SAPUI5_project_7.png)
115119

116-
>Make sure to input the fields with the correct cases: `shell` must start with an lower case and `plugin` must start with a lower case.
120+
>Make sure to input the fields with the correct cases: `Shell` must start with an upper case and `plugin` must start with a lower case.
117121
118122
### Adjust your SAPUI5 Project
119123

@@ -127,7 +131,7 @@ The application project is automatically initialized with several basic folders,
127131
- Under the `"sap.app"` configuration adjust the `"type"` property value to `"component"`.
128132
- Under the `"crossNavigation"` configuration remove the `"title": "{{flpTitle}}"` property and add the property `"hideLauncher": true`.
129133
- Remove the blocks for the `"routing"` configuration and the `"rootView"` definition.
130-
- At the end of the file, behind the third last `}`, insert the following code snippet: `,"sap.flp": {"type": "plugin"}`.
134+
- At the end of the file, behind the second last `}`, insert the following code snippet: `,"sap.flp": {"type": "plugin"}`.
131135

132136
At the end your **`mainfest.json`** file should look like the following (certain properties are project-dependent and might therefore have different values for you. For this reason, you should use this code snippet as a guide, and manually adjust your **`mainfest.json`** file (rather than simply copy and paste this code snippet)):
133137

@@ -151,9 +155,9 @@ The application project is automatically initialized with several basic folders,
151155
},
152156
"crossNavigation": {
153157
"inbounds": {
154-
"Shell-plugin": {
158+
"Shell000-plugin": {
155159
"hideLauncher": true,
156-
"semanticObject": "Shell",
160+
"semanticObject": "shell000",
157161
"action": "plugin",
158162
"signature": {
159163
"parameters": {},
@@ -228,13 +232,14 @@ The application project is automatically initialized with several basic folders,
228232

229233
![Delete view folder content](delete_view_content.png)
230234

231-
5. Open the **`Component.js`** file in the **`webapp`** folder. Delete the entire content of the file, and replace it with the following code:
235+
5. Open the **`Component.js`** file in the **`webapp`** folder. You should use this code snippet as a guide, and manually adjust your Component.js file (rather than simply copy and paste this code snippet):
232236

233237
``` JavaScript
234238
sap.ui.define([
235239
"sap/ui/core/UIComponent"
240+
"zplugin000/model/models"
236241
],
237-
function (UIComponent) {
242+
function (UIComponent, models) {
238243
"use strict";
239244

240245
return UIComponent.extend("zplugin###.Component", {
@@ -308,6 +313,8 @@ You can now deploy your SAPUI5 Component on with a basic (empty) shell plug-in t
308313

309314
![Deploy application](deploy_application.png)
310315

316+
>In case the Deploy tile is not visible in the Application Info, right-click the ui5-deploy.yaml file, select Open in Integrated Terminal, and execute the command **npm run deploy**.
317+
311318
2. The deployment process will begin. You will be prompted to confirm the deployment by typing `Y`. Once the SAPUI5 Application is successfully deployed to your SAP BTP ABAP Environment, the terminal will return the status:
312319
`Deployment Successful`. You can now close the terminal window.
313320
>The deployment process can take up to a few minutes.

0 commit comments

Comments
 (0)