Skip to content

Commit e757fae

Browse files
authored
Pull request to update step titles and number referencing (#18591)
* Automatic commit: Move 'cap-extend-sfsf-add-logic' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-ui-annotations' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-add-security' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-deploy-hc' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-fiori-elements' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-deploy-cf' from QA to Production * Automatic commit: Move 'cap-extend-sfsf-add-launchpad' from QA to Production
1 parent c654598 commit e757fae

7 files changed

Lines changed: 53 additions & 53 deletions

File tree

tutorials/cap-extend-sfsf-add-launchpad/cap-extend-sfsf-add-launchpad.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,68 +30,68 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
3030

3131
---
3232

33-
[ACCORDION-BEGIN [Step 1: ](Access the Launchpad Service Site Manager)]
33+
[ACCORDION-BEGIN [Step 1: ](Access the launchpad service site manager)]
3434

35-
In the **SAP BTP cockpit**, on the **left-hand pane** expand the **Services** menu and click on **Instances and Subscriptions**. On the right side, locate the **Launchpad Service** under **Subscriptions** and click on the **Go to Application** icon next to it.
35+
In the **SAP BTP cockpit**, on the **left-hand pane** expand the **Services** menu and (1) click on **Instances and Subscriptions**. On the right side, locate the **Launchpad Service** under **Subscriptions** and (2) click on the **Go to Application** icon next to it.
3636

3737
![Figure 1 – Go to Application on Launchpad Service subscription](launch-service.png)
3838

3939
The **Site Manager UI** will open-up in a new browser tab. So, the first thing you need to do is to **refresh** (grab) the content from the **HTML5 applications** repository for bring in our application from there.
4040

41-
Click on the **sandwich menu** at the top-left corner of the page to expand the app menu and click on the **Provider Manager** option. Then, click on the **refresh button** at the far right of the **HTML5 apps** provider to bring-in the content from there.
41+
(1) Click on the **sandwich menu** at the top-left corner of the page to expand the app menu and (2) click on the **Provider Manager** option. Then, (3) click on the **refresh button** at the far right of the **HTML5 apps** provider to bring-in the content from there.
4242

4343
![Figure 2 – Refresh content from the HTML5 apps repository](refresh-content.png)
4444

4545
[DONE]
4646
[ACCORDION-END]
4747

48-
[ACCORDION-BEGIN [Step 2: ](Prepare Business Content: Application, Group and Catalog)]
48+
[ACCORDION-BEGIN [Step 2: ](Prepare the business content - application, group and catalog)]
4949

5050
To learn about the **concepts** managed by the **SAP Launchpad Service**, please refer to the official documentation in [**this link**](https://help.sap.com/viewer/8c8e1958338140699bd4811b37b82ece/Cloud/en-US/3f619a13ca2a4a59a14bec8507c3fb69.html).
5151

52-
Click on the **Content Manager** option, then on the **Content Explorer** tab and, finally, on the **HTML5 Apps** tile.
52+
(1) Click on the **Content Manager** option, then (2) on the **Content Explorer** tab and, finally, (3) on the **HTML5 Apps** tile.
5353

5454
![Figure 3 – Access HTML5 Apps Repository](access-repo.png)
5555

56-
Select the **Manage Projects** app, then click on the **Add to My Content** button.
56+
(1) Select the **Manage Projects** app, then (2) click on the **Add to My Content** button.
5757

5858
![Figure 4 – Add Manage Projects App to My Content](add-app.png)
5959

60-
Click on the **My Content** tab, then on the **New** button and select **Catalog** from the menu.
60+
(1) Click on the **My Content** tab, then (2) on the **New** button and (3) select **Catalog** from the menu.
6161

6262
![Figure 5 – Add New Catalog](add-catalog.png)
6363

64-
Type **Project Management** as **Title** and **Project Management Catalog** as **Description**. Click on the **Assign Items** search bar and, then, on the "**+**" icon to the right of the **Manage Projects** app. Finally, click on the **Save** button.
64+
Type **Project Management** as **Title** and **Project Management Catalog** as **Description**. (1) Click on the **Assign Items** search bar and, then, (2) on the "**+**" icon to the right of the **Manage Projects** app. Finally, (3) click on the **Save** button.
6565

6666
![Figure 6 – Project Management Catalog Information](catalog-info.png)
6767

68-
Go back to the **Content Manager** home page, click on the **New** button and select **Group** from the menu.
68+
Go back to the **Content Manager** home page, (1) click on the **New** button and (2) select **Group** from the menu.
6969

7070
![Figure 7 – Add New Group](add-group.png)
7171

72-
Type **SuccessFactors Extensions** as **Title** and **SuccessFactors Extensions Group** as **Description**. Click on the **Assign Items** search bar and, then, on the "**+**" icon to the right of the **Manage Projects** app. Finally, click on the **Save** button.
72+
Type **SuccessFactors Extensions** as **Title** and **SuccessFactors Extensions Group** as **Description**. (1) Click on the **Assign Items** search bar and, then, (2) on the "**+**" icon to the right of the **Manage Projects** app. Finally, (3) click on the **Save** button.
7373

7474
![Figure 8 – SuccessFactors Extensions Group Information](group-info.png)
7575

7676
[DONE]
7777
[ACCORDION-END]
7878

79-
[ACCORDION-BEGIN [Step 3: ](Assign the Application to Everyone)]
79+
[ACCORDION-BEGIN [Step 3: ](Assign the application to everyone)]
8080

8181
Go back to the **Content Manager** home page and click on the **Everyone** role in the list.
8282

8383
![Figure 9 – Access the Everyone Role](access-role.png)
8484

85-
Click on the **Edit** button at the top-right and then on the **Assign Items** search bar. Click on the "**+**" icon to the right of the **Manage Projects** app. Finally, click on the **Save** button.
85+
Click on the **Edit** button at the top-right and then (1) on the **Assign Items** search bar. (2) Click on the "**+**" icon to the right of the **Manage Projects** app. Finally, (3) click on the **Save** button.
8686

8787
![Figure 10 – Assign the Manage Projects app to the Everyone Role](assign-app.png)
8888

8989
[DONE]
9090
[ACCORDION-END]
9191

92-
[ACCORDION-BEGIN [Step 4: ](Create the Launchpad Site)]
92+
[ACCORDION-BEGIN [Step 4: ](Create the launchpad site)]
9393

94-
Click on the **Site Directory** option and then on the **Create Site** button.
94+
(1) Click on the **Site Directory** option and then (2) on the **Create Site** button.
9595

9696
![Figure 11 – Create New Site](create-site.png)
9797

@@ -102,7 +102,7 @@ Name the site **BTP Extensions** and click on the **Create** button.
102102
[DONE]
103103
[ACCORDION-END]
104104

105-
[ACCORDION-BEGIN [Step 5: ](Test the Site and Application)]
105+
[ACCORDION-BEGIN [Step 5: ](Test the site and application)]
106106

107107
Click on the link below the **URL** field to **launch the site**, which will open-up in a new browser tab.
108108

@@ -131,12 +131,12 @@ And this is the **final step** to **Extend SAP SuccessFactors on SAP BTP with CA
131131
[DONE]
132132
[ACCORDION-END]
133133

134-
[ACCORDION-BEGIN [Step 6: ](Check Your Knowledge)]
134+
[ACCORDION-BEGIN [Step 6: ](Check your knowledge)]
135135

136136
[VALIDATE_1]
137137
[ACCORDION-END]
138138

139-
[ACCORDION-BEGIN [Step 7: ](Stretch Yourself)]
139+
[ACCORDION-BEGIN [Step 7: ](Stretch yourself)]
140140

141141
**Congratulations**! After having gone through and completed the tutorials in this group you should have successfully **Extended SAP SuccessFactors on SAP BTP with CAP** with a **simple project management application**!
142142

tutorials/cap-extend-sfsf-add-logic/cap-extend-sfsf-add-logic.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
2424

2525
---
2626

27-
[ACCORDION-BEGIN [Step 1: ](Create the Service Module Code File)]
27+
[ACCORDION-BEGIN [Step 1: ](Create the service module code file)]
2828

2929
The **business logic** of the application is implemented via **custom service handlers** for the various operations executed on its entities (create, read, update, delete, etc.). Those handlers are defined in a **module** within a `JavasScript` file with the **same name** of the service but with the `.js` extension.
3030

3131
So, now it's time for you to create it.
3232

33-
On the **left-hand pane** of **SAP Business Application Studio**, select the `srv` folder, then click on the **three dots** to the right of the project name and select **New File**.
33+
On the **left-hand pane** of **SAP Business Application Studio**, (1) select the `srv` folder, then (2) click on the **three dots** to the right of the project name and (3) select **New File**.
3434

3535
![Figure 1 – Create New File](create-file.png)
3636

@@ -41,7 +41,7 @@ On the **dialog** name the file `projman-service.js` and click **OK**.
4141
[DONE]
4242
[ACCORDION-END]
4343

44-
[ACCORDION-BEGIN [Step 2: ](Code the Service Module)]
44+
[ACCORDION-BEGIN [Step 2: ](Code the service module)]
4545

4646
Copy and paste the **code snippet below** into the recently created file:
4747

@@ -71,7 +71,7 @@ Finally, you make some **comments** as **placeholders** to mark where you will f
7171
[DONE]
7272
[ACCORDION-END]
7373

74-
[ACCORDION-BEGIN [Step 3: ](Organize Your Code)]
74+
[ACCORDION-BEGIN [Step 3: ](Organize your code)]
7575

7676
It is a best practice to have your code organized into **files** representing the nature of the code (i.e. **utility functions** should go into some `utils` file, **handlers** should go into some `handlers` file and so on). Those files represent your "code library", so it's appropriate to store them into some `lib` folder.
7777

@@ -96,11 +96,11 @@ Type `touch lib/handlers.js` and press **Enter**.
9696
[DONE]
9797
[ACCORDION-END]
9898

99-
[ACCORDION-BEGIN [Step 4: ](Code the Service Handlers)]
99+
[ACCORDION-BEGIN [Step 4: ](Code the service handlers)]
100100

101101
Now, you'll develop the required service handlers according to the business rules that have been defined in the [**group introduction and preparation**](cap-extend-sfsf-intro).
102102

103-
### Users Read Handler
103+
### Users READ handler
104104

105105
On the **left-hand pane** expand the `lib` folder, then click on the `hanlers.js` file to open it.
106106

@@ -204,7 +204,7 @@ Click on the `SFSF_User` link
204204

205205
Now, you should be able to view the users that are being read from **SAP SuccessFactors** via the **User entity** from the `PLTUserManagement` service.
206206

207-
### Other Handlers
207+
### Other handlers
208208

209209
That was the most important handler you should first implement as it's the one responsible for bringing the SAP SuccessFactors' employees into your application.
210210

@@ -508,7 +508,7 @@ The code logic is well explained in the comments details.
508508
[DONE]
509509
[ACCORDION-END]
510510

511-
[ACCORDION-BEGIN [Step 5: ](Attach the Service Handlers to the Service Module Events)]
511+
[ACCORDION-BEGIN [Step 5: ](Attach the service handlers to the service module events)]
512512

513513
Open the `srv/projman-service.js` file, then copy and paste the **following code** over (overwrite) the current content:
514514

@@ -560,7 +560,7 @@ And, with that, you completed the coding of the business logic for your applicat
560560
[DONE]
561561
[ACCORDION-END]
562562

563-
[ACCORDION-BEGIN [Step 6: ](Check Your Knowledge)]
563+
[ACCORDION-BEGIN [Step 6: ](Check your knowledge)]
564564

565565
[VALIDATE_1]
566566
[ACCORDION-END]

tutorials/cap-extend-sfsf-add-security/cap-extend-sfsf-add-security.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
2525

2626
---
2727

28-
[ACCORDION-BEGIN [Step 1: ](Set Service to Require Authentication)]
28+
[ACCORDION-BEGIN [Step 1: ](Set service to require authentication)]
2929

3030
So far, you have been working on a local project which only developers would have access to. Therefore, it's OK to leave your service "unprotected" as it's not yet publicly available. But, as soon as you deploy it to the cloud, it will be available to anyone who knows the service endpoint (which is not quite difficult).
3131

@@ -46,7 +46,7 @@ As you are still in development you can provide whatever information you like an
4646
[DONE]
4747
[ACCORDION-END]
4848

49-
[ACCORDION-BEGIN [Step 2: ](Set Authorization for Service Entities Access)]
49+
[ACCORDION-BEGIN [Step 2: ](Set authorization for service entities access)]
5050

5151
But, in an **administrative scenario** like this one, just **being an authenticated user is not enough**. It's appropriate that, additionally, the authenticated user must be granted some **administrative role** (i.e. an **Admin** role).
5252

@@ -119,7 +119,7 @@ After deployment, you just need to assign it to the user who should be granted s
119119
[DONE]
120120
[ACCORDION-END]
121121

122-
[ACCORDION-BEGIN [Step 4: ](Add Required Dependencies)]
122+
[ACCORDION-BEGIN [Step 4: ](Add required dependencies)]
123123

124124
Now, you just need to add four dependencies to the CAP service for it to properly handle security and other related stuff – such as the user JSON Web Token (JWT) – during runtime. Those are:
125125

@@ -142,7 +142,7 @@ When the commands complete, your `package.json` file should like the screenshot
142142
[DONE]
143143
[ACCORDION-END]
144144

145-
[ACCORDION-BEGIN [Step 5: ](Check Your Knowledge)]
145+
[ACCORDION-BEGIN [Step 5: ](Check your knowledge)]
146146

147147

148148

tutorials/cap-extend-sfsf-deploy-cf/cap-extend-sfsf-deploy-cf.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
2828

2929
---
3030

31-
[ACCORDION-BEGIN [Step 1: ](Build the MTA Archive)]
31+
[ACCORDION-BEGIN [Step 1: ](Build the MTA archive)]
3232

3333
Before you build the MTA Archive for deployment, do not forget to switch back the database from **in-memory `SQLite`** to **SAP HANA** (if not already). For that, just open the `package.json` file from the CAP service and set the `cds.requires.db.kind` parameter to `hana` like demonstrated below:
3434

@@ -74,7 +74,7 @@ It's going to take a while until the deployment process finishes. When it does,
7474
[ACCORDION-END]
7575

7676

77-
[ACCORDION-BEGIN [Step 3: ](Assign Admin Role to your Business User)]
77+
[ACCORDION-BEGIN [Step 3: ](Assign Admin role to your business user)]
7878

7979
Before you jump into testing the application, you must remember that it's meant for **project administrators**, meaning, users with the Admin role assigned. So, assign the role to your user in SAP BTP.
8080

@@ -91,9 +91,9 @@ Now you are OK to test the application.
9191
[DONE]
9292
[ACCORDION-END]
9393

94-
[ACCORDION-BEGIN [Step 4: ](Test the Deployed Application)]
94+
[ACCORDION-BEGIN [Step 4: ](Test the deployed application)]
9595

96-
On the **left-hand pane**, click on **HTML5 Applications** and locate your **Business Solution** (`sfsf-projman-<your subdomain>`). Then, click on the link of the **Application Name**.
96+
On the **left-hand pane**, (1) click on **HTML5 Applications** and locate your **Business Solution** (`sfsf-projman-<your subdomain>`). Then, (2) click on the link of the **Application Name**.
9797

9898
![Figure 10 – Start application](launch-app.png)
9999

@@ -118,7 +118,7 @@ Finally, the last step in the journey of this tutorial group is to add your appl
118118
[DONE]
119119
[ACCORDION-END]
120120

121-
[ACCORDION-BEGIN [Step 5: ](Check Your Knowledge)]
121+
[ACCORDION-BEGIN [Step 5: ](Check your knowledge)]
122122

123123
[VALIDATE_1]
124124
[ACCORDION-END]

tutorials/cap-extend-sfsf-deploy-hc/cap-extend-sfsf-deploy-hc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
2525

2626
---
2727

28-
[ACCORDION-BEGIN [Step 1: ](Setup Project for SAP HANA)]
28+
[ACCORDION-BEGIN [Step 1: ](Setup project for SAP HANA)]
2929

3030
So far, all data persistence of your application has been utilizing a **default `SQLite` in-memory database**, which means that, each time you restart the application, all data that has been added/updated is completely lost.
3131

@@ -48,7 +48,7 @@ In the **Terminal** type `npm install` and press **Enter** to install the newly
4848
[DONE]
4949
[ACCORDION-END]
5050

51-
[ACCORDION-BEGIN [Step 2: ](Deploy the Database to SAP HANA Cloud)]
51+
[ACCORDION-BEGIN [Step 2: ](Deploy the database to SAP HANA Cloud)]
5252

5353
> **IMPORTANT NOTE**: before executing the next steps first make sure:
5454
>
@@ -81,7 +81,7 @@ If you click on the **Cloud Foundry icon** (small light bulb) on the left-hand p
8181
[DONE]
8282
[ACCORDION-END]
8383

84-
[ACCORDION-BEGIN [Step 3: ](Run Project locally with the Database in the Cloud)]
84+
[ACCORDION-BEGIN [Step 3: ](Run project locally with the database in the cloud)]
8585

8686
Now, checkout what happens when you execute the application.
8787

@@ -100,7 +100,7 @@ If you want to **switch to the `SQLite` in-memory database** again for developme
100100
[DONE]
101101
[ACCORDION-END]
102102

103-
[ACCORDION-BEGIN [Step 4: ](Check Your Knowledge)]
103+
[ACCORDION-BEGIN [Step 4: ](Check your knowledge)]
104104

105105
[VALIDATE_1]
106106
[ACCORDION-END]

tutorials/cap-extend-sfsf-fiori-elements/cap-extend-sfsf-fiori-elements.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ primary_tag: software-product-function>sap-cloud-application-programming-model
2828

2929
---
3030

31-
[ACCORDION-BEGIN [Step 1: ](Add MTA Configuration to the Project)]
31+
[ACCORDION-BEGIN [Step 1: ](Add MTA configuration to the project)]
3232

3333
To deploy your application to Cloud Foundry on SAP BTP, you are going to use the **MTA** (Multi-Target Application) approach, which facilitates the deployment as it **pushes everything at once** to the platform: UI application, backend service, database, service instances creation and binding, etc.
3434

@@ -55,7 +55,7 @@ The next step is to create an `approuter` module with a **unique route name** (i
5555
[DONE]
5656
[ACCORDION-END]
5757

58-
[ACCORDION-BEGIN [Step 2: ](Add AppRouter Configuration to the MTA file)]
58+
[ACCORDION-BEGIN [Step 2: ](Add AppRouter configuration to the MTA file)]
5959

6060
Before you move forward with the creation of the `approuter` module, you need to make a **copy** of your `xs-security.json` file as the **module generator will overwrite it** with some specific `approuter` configuration.
6161

@@ -120,7 +120,7 @@ And that's it! This completes the `approuter` configuration.
120120
[DONE]
121121
[ACCORDION-END]
122122

123-
[ACCORDION-BEGIN [Step 3: ](Create the Fiori Elements App as an MTA Module)]
123+
[ACCORDION-BEGIN [Step 3: ](Create the Fiori elements app as an MTA Module)]
124124

125125
Now it's finally come the time to create your **SAP Fiori Elements app** (the front-end of your project management solution) and, to facilitate and speed-up the project configuration, you will **add it** to your project directly as an **MTA module**.
126126

@@ -167,7 +167,7 @@ Also, the **actual SAP Fiori application** has been created under the `app` fold
167167
[DONE]
168168
[ACCORDION-END]
169169

170-
[ACCORDION-BEGIN [Step 4: ](Launch the Fiori Elements App)]
170+
[ACCORDION-BEGIN [Step 4: ](Launch the Fiori elements app)]
171171

172172
You can, now, test the newly created SAP Fiori app. In the **Terminal**, run `cds watch` and `CTRL+Click` the `http://localhost:4004` link to open the CAP application home page. Notice that under **Web Applications** the link to the **SAP Fiori app home page** is listed:
173173

@@ -194,7 +194,7 @@ You can, now, test it at your will, in the same way you did using the **Fiori Pr
194194
[DONE]
195195
[ACCORDION-END]
196196

197-
[ACCORDION-BEGIN [Step 5: ](Add Additional MTA Configuration)]
197+
[ACCORDION-BEGIN [Step 5: ](Add additional MTA configuration)]
198198

199199
A few more configurations are required to get the solution fully ready for deployment.
200200

@@ -260,7 +260,7 @@ And that concludes the **full project configuration** required to **deploy** the
260260
[DONE]
261261
[ACCORDION-END]
262262

263-
[ACCORDION-BEGIN [Step 6: ](Check Your Knowledge)]
263+
[ACCORDION-BEGIN [Step 6: ](Check your knowledge)]
264264

265265
[VALIDATE_1]
266266
[ACCORDION-END]

0 commit comments

Comments
 (0)