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: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Default templates for SAP open source repositories, including LICENSE, .reuse/de
6
6
7
7
## To-Do
8
8
9
-
In case you are the maintainer of a new SAP-toturials open source project, these are the steps to do with the template files:
9
+
If you are the maintainer of a new SAP-toturials open source project, these are the steps to do with the template files:
10
10
11
11
- Check if the default license (Apache 2.0) also applies to your project. A license change should only be required in exceptional cases. If this is the case, please change the [license file](LICENSE).
12
12
- Enter the correct metadata for the REUSE tool. See our [wiki page](https://wiki.wdf.sap.corp/wiki/display/ospodocs/Using+the+Reuse+Tool+of+FSFE+for+Copyright+and+License+Information) for details how to do it. You can find an initial .reuse/dep5 file to build on. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository and be sure to run the REUSE tool to validate that the metadata is correct.
SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
6
+
7
+
[[annotations]]
8
+
path = "**"
9
+
precedence = "aggregate"
10
+
SPDX-FileCopyrightText = "2022 SAP SE or an SAP affiliate company and abap-core-development contributors"
<!--DONE with E1Y (https://dlm.wdf.sap.corp/launchpad/portal/#/Search/e1y -> https://my300098.s4hana.ondemand.com/ and btp trial -->
11
11
# Connect SAP Business Application Studio and SAP S/4HANA Cloud System
12
12
<!-- description --> For key user extensibility connect SAP Business Application Studio and an SAP S/4HANA Cloud system using SAML assertion authentication to develop custom UIs.
> - If you want to create a custom SAP Fiori app with developer extensibility check out [Develop an SAP Fiori App to Trigger Purchase Requisitions API](https://developers.sap.com/group.sap-fiori-app-purchase-req.html)
24
-
> - Tutorial last updated with SAP S/4HANA Cloud Release 2302
24
+
> - Tutorial last checked for feasibility with SAP S/4HANA Cloud Release 2408
25
25
26
26
**Prerequisites for SAP BTP customer account**
27
27
@@ -71,24 +71,24 @@ Although this tutorial describes the flow with a trial account, the sequence is
71
71
72
72
| Field Name | Value
73
73
| :------------- | :-------------
74
-
| Name | **`<YOUR_SYSTEMS_ID>_SAML_ASSERTION`**
75
-
| Type | **`HTTP`**
76
-
| Description | **`SAML Assertion Destination to SAP S/4HANA Cloud system <YOUR_SYSTEMS_ID>`**
77
-
| URL | In the SAP S/4HANA Cloud system, navigate to the **Communication Systems** app and copy the **Host Name** from **Own SAP Cloud System** = `Yes`<div></div> and paste it with prefix `https://` for example `https://my12345-api.s4hana.ondemand.com.`
78
-
| Proxy Type | **`Internet`**
79
-
| Authentication | **`SAMLAssertion`**
80
-
| Audience | Enter the URL of your system and remove `-api`, for example `https://my12345.s4hana.ondemand.com`.
74
+
| `Name` | **`<YOUR_SYSTEMS_ID>_SAML_ASSERTION`**
75
+
| `Type` | **`HTTP`**
76
+
| `Description` | **`SAML Assertion Destination to SAP S/4HANA Cloud system <YOUR_SYSTEMS_ID>`**
77
+
| `URL` | In the SAP S/4HANA Cloud system, navigate to the **Communication Systems** app, click the **Own SAP Cloud System** button, copy the **Host Name**<div></div> and paste it with prefix `https://` for example `https://my12345-api.s4hana.ondemand.com.`
78
+
| `Proxy Type` | **`Internet`**
79
+
| `Authentication` | **`SAMLAssertion`**
80
+
| `Audience` | Copy and paste the `OAuth 2.0 SAML2 Audience` from the **Own SAP Cloud System**.
| HTML5.Timeout | **`60000`** | value stated in milliseconds. 60000 equals 1 minute. Required as deployment needs longer than the standard of 30 seconds.
87
+
| `HTML5.DynamicDestination` | **`true`** |
88
+
| `HTML5.Timeout` | **`60000`** | value stated in milliseconds. 60000 equals 1 minute. Required as deployment needs longer than the standard of 30 seconds.
| `nameIDFormat` | **`urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`** | Required in case your subaccount sends the e-mail address as SAML Subject Name Identifier for authentication (configured as **Subject Name Identifier** in its SAP Cloud Identity Service Application, see [Tutorial: SAP Business Technology Platform Neo Environment](abap-custom-ui-trust-settings)), although SAP S/4HANA Cloud system expects user login by default. **That is the case with a trial Account.** This also requires the e-mail address to be maintained for SAP S/4HANA Cloud system business users.
91
+
| `nameIDFormat` | **`urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`** | Required in case your subaccount sends the e-mail address as SAML Subject Name Identifier for authentication (configured as **Subject Name Identifier** in its SAP Cloud Identity Service Application, see [Tutorial: Set Up Trust Between SAP Cloud Identity Services and SAP BTP Cloud Foundry Environment](abap-custom-ui-trust-cf)), although SAP S/4HANA Cloud system expects user login by default. **That is the case with a trial Account.** This also requires the e-mail address to be maintained for SAP S/4HANA Cloud system business users.
92
92
93
93
8. Make sure that the **Use default JDK truststore** checkbox is ticked.
> - This tutorial illustrates all the needed steps to build a UI with all SAPUI5 options in SAP Business Application Studio, test it, and get it into the SAP S/4HANA Cloud system. If you only require a generated UI and maybe adapting it with restricted options within the SAP S/4HANA Cloud system (in-app-extensibility) check out [Generate the UI for a Custom Business Object and grant Access](abap-extensibility-cbo-ui-generation) and [Adapt the UI of a Business Object](abap-extensibility-cbo-ui-adaptation)
27
27
> - If you want to create a custom SAP Fiori app with developer extensibility check out [Develop an SAP Fiori App to Trigger Purchase Requisitions API](https://developers.sap.com/group.sap-fiori-app-purchase-req.html)
28
-
> - Tutorial last updated with SAP S/4HANA Cloud Release 2302
28
+
> - Tutorial last checked for feasibility with SAP S/4HANA Cloud Release 2408
29
29
30
30
---
31
31
@@ -62,21 +62,22 @@ SAP Business Application Studio offers UI generators with a wizard approach to c
62
62
63
63

64
64
65
-
3.Go to**View > Command Palette...**.
65
+
3.Click the three lines on top of the navigation to open**View > Command Palette...**.
66
66
67
67

68
68
69
-
4. Search for command **Fiori: Open Application Generator** and select it.
69
+
4. Search for command **>Fiori: Open Application Generator** and execute it.
70
70
71
71

72
72
73
73
74
74
75
-
### Select floorplan
75
+
### Select UI Project Template
76
76
77
-
For **Template Type**, select the default **SAP Fiori** (1), choose **List Report Page** (2) as **Floorplan**and click **Next** (3).
77
+
As UI project template choose **List Report Page** (1) and click **Next** (2).
1. As **Main Entity**, select the custom business object root node `YY1_BONUSPLAN`.
@@ -109,6 +111,7 @@ In this step you define the root node for your UI in the OData service.
109
111
110
112
In this step, you set project attributes and choose to add further optional configurations.
111
113
114
+
<!--border-->
112
115

113
116
114
117
1. Define a **Module name**, which will later be the folder name of the UI Project and - in combination with optional namespace - the application ID in SAP S/4HANA Cloud system. Example: `bonusplans`
@@ -126,6 +129,7 @@ In this step, you set project attributes and choose to add further optional conf
126
129
127
130
In this step, you define where you want the UI project to be deployed to as a runnable application.
1. Leave the default `ABAP` as **target** platform and as **Destination** the one you have created earlier (see [Connect SAP Business Application Studio and SAP S/4HANA Cloud system](abap-custom-ui-bas-connect-s4hc)).
@@ -146,6 +150,7 @@ npx fiori add deploy-config
146
150
147
151
The SAP Fiori launchpad (FLP) configuration is required to embed your application as a tile into the FLP.
1. Set a **Semantic Object**, for example `bonusplan`
@@ -161,21 +166,22 @@ The UI project is now being generated and dependencies are being installed. This
161
166
162
167

163
168
164
-
Once the generation finished a pop up appears to ask if and how to open it. Choose **Open Folder**
169
+
Once the generation finished a pop up appears to ask if and how to open it. Choose **Add project to workspace**
165
170
166
-

171
+
<!--border-->
172
+

167
173
168
174
>Note that you can also configure the launchpad later via the command line interface by using the following command:
169
175
```Shell/Bash
170
176
npx fiori add flp-config
171
177
```
172
178
173
179
174
-
### Open UI project folder
180
+
### Open UI project folder (optional)
175
181
176
-
In case your SAP Business Application Studio's explorer does not show the project, do the following.
182
+
In case your SAP Business Application Studio's explorer does not show the project, do the following.
177
183
178
-
1. To view the newly created project in the explorer, select **Open Folder**.
184
+
1. To view the newly created project in the explorer with all features, select **Open Folder**.
179
185
180
186

181
187
@@ -189,22 +195,46 @@ In case your SAP Business Application Studio's explorer does not show the projec
189
195
190
196
In this step, you can test the UI with the preview functionality.
191
197
192
-
1.Right-click the project folder and choose **Preview Application**from the context menu.
198
+
1.After Opening the project, Business Application Studio also opens an **Application Info**tab. In its **What you can do** section click the **Preview Application** tile.
193
199
200
+
<!--border-->
194
201

195
202
203
+
> Note that in case there is no Application Info tab you can open it from the context menu of the project
204
+
>
205
+
> <!--border-->
206
+
> 
207
+
196
208
2. Select the `start` option, which will perform a preview based on the configured data source system, retrieve real data and enable you to create, edit and delete data in that system.
Once the command has reached the required state, a new browser tab with the preview is opened.
205
219
220
+
> Alternatively to Preview from Application Info tab, you can open a terminal for your project by right-clicking it and choosing **Open in Integrated Terminal** from the context menu.
221
+
>
222
+
>
223
+
>
224
+
> In the `cli` (command line interface) terminal, enter the following command:
225
+
>
226
+
>```Shell/Bash
227
+
>npm run start
228
+
>```
229
+
>
230
+
><!--border-->
231
+
>
232
+
>
233
+
>Press return.
234
+
206
235
3. To view existing entries, select **GO** or **Create** to add a new entry.
@@ -213,28 +243,30 @@ In this step, you can test the UI with the preview functionality.
213
243
214
244
Once the UI is set up to your needs, you can deploy it to the development SAP S/4HANA Cloud system, where it can be tested and transported to test or productive tenants.
215
245
216
-
1. Open a terminal for your project by right-clicking it and choosing **Open in Integrated Terminal** from the context menu.
217
-
218
-

219
-
220
-
2. In the `cli` (command line interface) terminal, enter the following command:
246
+
1. In the **Application Info** tab, section **What you can do** click the **Deploy** tile
221
247
222
-
```Shell/Bash
223
-
npm run deploy
224
-
```
225
-

248
+
<!--border-->
249
+

226
250
227
-
Press return.
251
+
> Alternatively to Application Info, in the `cli` (command line interface) terminal, enter the following command:
252
+
>
253
+
>```Shell/Bash
254
+
>npm run start
255
+
>```
256
+
>
257
+
>
258
+
>
259
+
>Press return.
228
260
229
-
3. Check the deployment configuration.
261
+
2. Check the deployment configuration.
230
262
231
263

0 commit comments