You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorials/abap-environment-shell-plugin/abap-environment-shell-plugin.md
+21-14Lines changed: 21 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,19 +12,21 @@ parser: v2
12
12
---
13
13
14
14
## 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.
22
23
23
24
>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.
24
25
25
26
>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.
26
27
27
28
## You will learn
29
+
28
30
- How to create a custom shell plug-in.
29
31
- How to deploy the shell plug-in to your SAP BTP ABAP Environment as part of a SAP Fiori Application.
30
32
- 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
103
105
104
106

105
107
108
+
>Ensure that **Use Virtual Endpoints for Local Preview** remains set to **No**.
109
+
106
110
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**.
107
111
108
112
<!--border-->
109
113

110
114
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.
112
116
113
117
<!--border-->
114
118

115
119
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.
117
121
118
122
### Adjust your SAPUI5 Project
119
123
@@ -127,7 +131,7 @@ The application project is automatically initialized with several basic folders,
127
131
- Under the `"sap.app"` configuration adjust the `"type"` property value to `"component"`.
128
132
- Under the `"crossNavigation"` configuration remove the `"title": "{{flpTitle}}"` property and add the property `"hideLauncher": true`.
129
133
- 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"}`.
131
135
132
136
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)):
133
137
@@ -151,9 +155,9 @@ The application project is automatically initialized with several basic folders,
151
155
},
152
156
"crossNavigation": {
153
157
"inbounds": {
154
-
"Shell-plugin": {
158
+
"Shell000-plugin": {
155
159
"hideLauncher": true,
156
-
"semanticObject": "Shell",
160
+
"semanticObject": "shell000",
157
161
"action": "plugin",
158
162
"signature": {
159
163
"parameters": {},
@@ -228,13 +232,14 @@ The application project is automatically initialized with several basic folders,
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):
@@ -308,6 +313,8 @@ You can now deploy your SAPUI5 Component on with a basic (empty) shell plug-in t
308
313
309
314

310
315
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
+
311
318
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:
312
319
`Deployment Successful`. You can now close the terminal window.
313
320
>The deployment process can take up to a few minutes.
0 commit comments